Skip to main content

queryKeys

Datalayer Core

Datalayer Core / queryKeys

Variable: queryKeys

const queryKeys: object

Defined in: src/hooks/useCache.ts:135

Centralized query key factories for all entities Following TanStack Query best practices for key structure

Type Declaration​

assignments​

readonly assignments: object

assignments.all()​

readonly all: () => readonly ["assignments"]

Returns​

readonly ["assignments"]

assignments.bySpace()​

readonly bySpace: (spaceId) => readonly ["assignments", "space", string]

Parameters​
spaceId​

string

Returns​

readonly ["assignments", "space", string]

assignments.detail()​

readonly detail: (id) => readonly ["assignments", "detail", string]

Parameters​
id​

string

Returns​

readonly ["assignments", "detail", string]

assignments.details()​

readonly details: () => readonly ["assignments", "detail"]

Returns​

readonly ["assignments", "detail"]

assignments.forStudent()​

readonly forStudent: (assignmentId, courseId, studentId) => readonly ["assignments", "detail", string, "course", string, "student", string]

Parameters​
assignmentId​

string

courseId​

string

studentId​

string

Returns​

readonly ["assignments", "detail", string, "course", string, "student", string]

assignments.studentVersion()​

readonly studentVersion: (assignmentId) => readonly ["assignments", "detail", string, "studentVersion"]

Parameters​
assignmentId​

string

Returns​

readonly ["assignments", "detail", string, "studentVersion"]

auth​

readonly auth: object

auth.me()​

readonly me: () => readonly ["auth", "me"]

Returns​

readonly ["auth", "me"]

auth.whoami()​

readonly whoami: () => readonly ["auth", "whoami"]

Returns​

readonly ["auth", "whoami"]

cells​

readonly cells: object

cells.all()​

readonly all: () => readonly ["cells"]

Returns​

readonly ["cells"]

cells.bySpace()​

readonly bySpace: (spaceId) => readonly ["cells", "space", string]

Parameters​
spaceId​

string

Returns​

readonly ["cells", "space", string]

cells.detail()​

readonly detail: (id) => readonly ["cells", "detail", string]

Parameters​
id​

string

Returns​

readonly ["cells", "detail", string]

cells.details()​

readonly details: () => readonly ["cells", "detail"]

Returns​

readonly ["cells", "detail"]

contacts​

readonly contacts: object

contacts.all()​

readonly all: () => readonly ["contacts"]

Returns​

readonly ["contacts"]

contacts.byHandle()​

readonly byHandle: (handle) => readonly ["contacts", "handle", string]

Parameters​
handle​

string

Returns​

readonly ["contacts", "handle", string]

contacts.detail()​

readonly detail: (id) => readonly ["contacts", "detail", string]

Parameters​
id​

string

Returns​

readonly ["contacts", "detail", string]

contacts.details()​

readonly details: () => readonly ["contacts", "detail"]

Returns​

readonly ["contacts", "detail"]

contacts.lists()​

readonly lists: () => readonly ["contacts", "list"]

Returns​

readonly ["contacts", "list"]

contacts.search()​

readonly search: (query) => readonly ["contacts", "search", string]

Parameters​
query​

string

Returns​

readonly ["contacts", "search", string]

courses​

readonly courses: object

courses.all()​

readonly all: () => readonly ["courses"]

Returns​

readonly ["courses"]

courses.detail()​

readonly detail: (id) => readonly ["courses", "detail", string]

Parameters​
id​

string

Returns​

readonly ["courses", "detail", string]

courses.details()​

readonly details: () => readonly ["courses", "detail"]

Returns​

readonly ["courses", "detail"]

courses.enrollments()​

readonly enrollments: () => readonly ["courses", "enrollments", "me"]

Returns​

readonly ["courses", "enrollments", "me"]

courses.instructor()​

readonly instructor: (instructorId) => readonly ["courses", "instructor", string]

Parameters​
instructorId​

string

Returns​

readonly ["courses", "instructor", string]

courses.public()​

readonly public: () => readonly ["courses", "public"]

Returns​

readonly ["courses", "public"]

courses.student()​

readonly student: (courseId, studentId) => readonly ["courses", "detail", string, "student", string]

Parameters​
courseId​

string

studentId​

string

Returns​

readonly ["courses", "detail", string, "student", string]

courses.students()​

readonly students: (courseId) => readonly ["courses", "detail", string, "students"]

Parameters​
courseId​

string

Returns​

readonly ["courses", "detail", string, "students"]

datasets​

readonly datasets: object

datasets.all()​

readonly all: () => readonly ["datasets"]

Returns​

readonly ["datasets"]

datasets.bySpace()​

readonly bySpace: (spaceId) => readonly ["datasets", "space", string]

Parameters​
spaceId​

string

Returns​

readonly ["datasets", "space", string]

datasets.detail()​

readonly detail: (id) => readonly ["datasets", "detail", string]

Parameters​
id​

string

Returns​

readonly ["datasets", "detail", string]

datasets.details()​

readonly details: () => readonly ["datasets", "detail"]

Returns​

readonly ["datasets", "detail"]

datasources​

readonly datasources: object

datasources.all()​

readonly all: () => readonly ["datasources"]

Returns​

readonly ["datasources"]

datasources.detail()​

readonly detail: (id) => readonly ["datasources", "detail", string]

Parameters​
id​

string

Returns​

readonly ["datasources", "detail", string]

datasources.details()​

readonly details: () => readonly ["datasources", "detail"]

Returns​

readonly ["datasources", "detail"]

documents​

readonly documents: object

documents.all()​

readonly all: () => readonly ["documents"]

Returns​

readonly ["documents"]

documents.bySpace()​

readonly bySpace: (spaceId) => readonly ["documents", "space", string]

Parameters​
spaceId​

string

Returns​

readonly ["documents", "space", string]

documents.detail()​

readonly detail: (id) => readonly ["documents", "detail", string]

Parameters​
id​

string

Returns​

readonly ["documents", "detail", string]

documents.details()​

readonly details: () => readonly ["documents", "detail"]

Returns​

readonly ["documents", "detail"]

documents.model()​

readonly model: (documentId) => readonly ["documents", "detail", string, "model"]

Parameters​
documentId​

string

Returns​

readonly ["documents", "detail", string, "model"]

environments​

readonly environments: object

environments.all()​

readonly all: () => readonly ["environments"]

Returns​

readonly ["environments"]

environments.bySpace()​

readonly bySpace: (spaceId) => readonly ["environments", "space", string]

Parameters​
spaceId​

string

Returns​

readonly ["environments", "space", string]

environments.detail()​

readonly detail: (id) => readonly ["environments", "detail", string]

Parameters​
id​

string

Returns​

readonly ["environments", "detail", string]

environments.details()​

readonly details: () => readonly ["environments", "detail"]

Returns​

readonly ["environments", "detail"]

exercises​

readonly exercises: object

exercises.all()​

readonly all: () => readonly ["exercises"]

Returns​

readonly ["exercises"]

exercises.bySpace()​

readonly bySpace: (spaceId) => readonly ["exercises", "space", string]

Parameters​
spaceId​

string

Returns​

readonly ["exercises", "space", string]

exercises.detail()​

readonly detail: (id) => readonly ["exercises", "detail", string]

Parameters​
id​

string

Returns​

readonly ["exercises", "detail", string]

exercises.details()​

readonly details: () => readonly ["exercises", "detail"]

Returns​

readonly ["exercises", "detail"]

growth​

readonly growth: object

growth.kpi()​

readonly kpi: () => readonly ["growth", "kpi"]

Returns​

readonly ["growth", "kpi"]

inbounds​

readonly inbounds: object

inbounds.all()​

readonly all: () => readonly ["inbounds"]

Returns​

readonly ["inbounds"]

inbounds.byHandle()​

readonly byHandle: (handle) => readonly ["inbounds", "handle", string]

Parameters​
handle​

string

Returns​

readonly ["inbounds", "handle", string]

inbounds.detail()​

readonly detail: (id) => readonly ["inbounds", string]

Parameters​
id​

string

Returns​

readonly ["inbounds", string]

invites​

readonly invites: object

invites.all()​

readonly all: () => readonly ["invites"]

Returns​

readonly ["invites"]

invites.byAccount()​

readonly byAccount: (accountId) => readonly ["invites", "account", string]

Parameters​
accountId​

string

Returns​

readonly ["invites", "account", string]

invites.byToken()​

readonly byToken: (token) => readonly ["invites", "token", string]

Parameters​
token​

string

Returns​

readonly ["invites", "token", string]

items​

readonly items: object

items.all()​

readonly all: () => readonly ["items"]

Returns​

readonly ["items"]

items.bySpace()​

readonly bySpace: (spaceId) => readonly ["items", "space", string]

Parameters​
spaceId​

string

Returns​

readonly ["items", "space", string]

items.public()​

readonly public: () => readonly ["items", "public"]

Returns​

readonly ["items", "public"]

items.search()​

readonly search: (opts) => readonly ["items", "search", ISearchOpts]

Parameters​
opts​

ISearchOpts

Returns​

readonly ["items", "search", ISearchOpts]

layout​

readonly layout: object

layout.byAccount()​

readonly byAccount: (accountHandle, spaceHandle?) => readonly ["layout", string, string] | readonly ["layout", string]

Parameters​
accountHandle​

string

spaceHandle?​

string

Returns​

readonly ["layout", string, string] | readonly ["layout", string]

lessons​

readonly lessons: object

lessons.all()​

readonly all: () => readonly ["lessons"]

Returns​

readonly ["lessons"]

lessons.bySpace()​

readonly bySpace: (spaceId) => readonly ["lessons", "space", string]

Parameters​
spaceId​

string

Returns​

readonly ["lessons", "space", string]

lessons.detail()​

readonly detail: (id) => readonly ["lessons", "detail", string]

Parameters​
id​

string

Returns​

readonly ["lessons", "detail", string]

lessons.details()​

readonly details: () => readonly ["lessons", "detail"]

Returns​

readonly ["lessons", "detail"]

notebooks​

readonly notebooks: object

notebooks.all()​

readonly all: () => readonly ["notebooks"]

Returns​

readonly ["notebooks"]

notebooks.bySpace()​

readonly bySpace: (spaceId) => readonly ["notebooks", "space", string]

Parameters​
spaceId​

string

Returns​

readonly ["notebooks", "space", string]

notebooks.detail()​

readonly detail: (id) => readonly ["notebooks", "detail", string]

Parameters​
id​

string

Returns​

readonly ["notebooks", "detail", string]

notebooks.details()​

readonly details: () => readonly ["notebooks", "detail"]

Returns​

readonly ["notebooks", "detail"]

notebooks.model()​

readonly model: (notebookId) => readonly ["notebooks", "detail", string, "model"]

Parameters​
notebookId​

string

Returns​

readonly ["notebooks", "detail", string, "model"]

oauth2​

readonly oauth2: object

oauth2.authorizationLinkUrl()​

readonly authorizationLinkUrl: (queryArgs) => readonly ["oauth2", "authz", "url", "link", Record<string, string>]

Parameters​
queryArgs​

Record<string, string>

Returns​

readonly ["oauth2", "authz", "url", "link", Record<string, string>]

oauth2.authorizationUrl()​

readonly authorizationUrl: (queryArgs) => readonly ["oauth2", "authz", "url", Record<string, string>]

Parameters​
queryArgs​

Record<string, string>

Returns​

readonly ["oauth2", "authz", "url", Record<string, string>]

organizations​

readonly organizations: object

organizations.all()​

readonly all: () => readonly ["organizations"]

Returns​

readonly ["organizations"]

organizations.byHandle()​

readonly byHandle: (handle) => readonly ["organizations", "handle", string]

Parameters​
handle​

string

Returns​

readonly ["organizations", "handle", string]

organizations.detail()​

readonly detail: (id) => readonly ["organizations", "detail", string]

Parameters​
id​

string

Returns​

readonly ["organizations", "detail", string]

organizations.details()​

readonly details: () => readonly ["organizations", "detail"]

Returns​

readonly ["organizations", "detail"]

organizations.lists()​

readonly lists: () => readonly ["organizations", "list"]

Returns​

readonly ["organizations", "list"]

organizations.members()​

readonly members: (orgId) => readonly ["organizations", "detail", string, "members"]

Parameters​
orgId​

string

Returns​

readonly ["organizations", "detail", string, "members"]

organizations.userOrgs()​

readonly userOrgs: () => readonly ["organizations", "user"]

Returns​

readonly ["organizations", "user"]

outbounds​

readonly outbounds: object

outbounds.all()​

readonly all: () => readonly ["outbounds"]

Returns​

readonly ["outbounds"]

outbounds.detail()​

readonly detail: (id) => readonly ["outbounds", string]

Parameters​
id​

string

Returns​

readonly ["outbounds", string]

pages​

readonly pages: object

pages.all()​

readonly all: () => readonly ["pages"]

Returns​

readonly ["pages"]

pages.detail()​

readonly detail: (id) => readonly ["pages", "detail", string]

Parameters​
id​

string

Returns​

readonly ["pages", "detail", string]

pages.details()​

readonly details: () => readonly ["pages", "detail"]

Returns​

readonly ["pages", "detail"]

prices​

readonly prices: object

prices.stripe()​

readonly stripe: () => readonly ["prices", "stripe"]

Returns​

readonly ["prices", "stripe"]

schools​

readonly schools: object

schools.all()​

readonly all: () => readonly ["schools"]

Returns​

readonly ["schools"]

secrets​

readonly secrets: object

secrets.all()​

readonly all: () => readonly ["secrets"]

Returns​

readonly ["secrets"]

secrets.detail()​

readonly detail: (id) => readonly ["secrets", "detail", string]

Parameters​
id​

string

Returns​

readonly ["secrets", "detail", string]

secrets.details()​

readonly details: () => readonly ["secrets", "detail"]

Returns​

readonly ["secrets", "detail"]

spaces​

readonly spaces: object

spaces.all()​

readonly all: () => readonly ["spaces"]

Returns​

readonly ["spaces"]

spaces.byHandle()​

readonly byHandle: (handle) => readonly ["spaces", "handle", string]

Parameters​
handle​

string

Returns​

readonly ["spaces", "handle", string]

spaces.byOrganization()​

readonly byOrganization: (orgId) => readonly ["spaces", "organization", string]

Parameters​
orgId​

string

Returns​

readonly ["spaces", "organization", string]

spaces.byOrganizationAndHandle()​

readonly byOrganizationAndHandle: (orgHandle, spaceHandle) => readonly ["spaces", "organization", string, "space", string]

Parameters​
orgHandle​

string

spaceHandle​

string

Returns​

readonly ["spaces", "organization", string, "space", string]

spaces.detail()​

readonly detail: (id) => readonly ["spaces", "detail", string]

Parameters​
id​

string

Returns​

readonly ["spaces", "detail", string]

spaces.details()​

readonly details: () => readonly ["spaces", "detail"]

Returns​

readonly ["spaces", "detail"]

spaces.items()​

readonly items: (spaceId) => readonly ["spaces", "detail", string, "items"]

Parameters​
spaceId​

string

Returns​

readonly ["spaces", "detail", string, "items"]

spaces.members()​

readonly members: (spaceId) => readonly ["spaces", "detail", string, "members"]

Parameters​
spaceId​

string

Returns​

readonly ["spaces", "detail", string, "members"]

spaces.orgSpaceByHandle()​

readonly orgSpaceByHandle: (orgId, handle) => readonly ["spaces", "organization", string, "handle", string]

Parameters​
orgId​

string

handle​

string

Returns​

readonly ["spaces", "organization", string, "handle", string]

spaces.userSpaces()​

readonly userSpaces: () => readonly ["spaces", "user"]

Returns​

readonly ["spaces", "user"]

teams​

readonly teams: object

teams.all()​

readonly all: () => readonly ["teams"]

Returns​

readonly ["teams"]

teams.byHandle()​

readonly byHandle: (handle) => readonly ["teams", "handle", string]

Parameters​
handle​

string

Returns​

readonly ["teams", "handle", string]

teams.byOrganization()​

readonly byOrganization: (orgId) => readonly ["teams", "organization", string]

Parameters​
orgId​

string

Returns​

readonly ["teams", "organization", string]

teams.detail()​

readonly detail: (id) => readonly ["teams", "detail", string]

Parameters​
id​

string

Returns​

readonly ["teams", "detail", string]

teams.details()​

readonly details: () => readonly ["teams", "detail"]

Returns​

readonly ["teams", "detail"]

teams.members()​

readonly members: (teamId) => readonly ["teams", "detail", string, "members"]

Parameters​
teamId​

string

Returns​

readonly ["teams", "detail", string, "members"]

tokens​

readonly tokens: object

tokens.all()​

readonly all: () => readonly ["tokens"]

Returns​

readonly ["tokens"]

tokens.detail()​

readonly detail: (id) => readonly ["tokens", "detail", string]

Parameters​
id​

string

Returns​

readonly ["tokens", "detail", string]

tokens.details()​

readonly details: () => readonly ["tokens", "detail"]

Returns​

readonly ["tokens", "detail"]

usages​

readonly usages: object

usages.platform()​

readonly platform: () => readonly ["usages", "platform"]

Returns​

readonly ["usages", "platform"]

usages.user()​

readonly user: () => readonly ["usages", "user"]

Returns​

readonly ["usages", "user"]

usages.userById()​

readonly userById: (userId) => readonly ["usages", "user", string]

Parameters​
userId​

string

Returns​

readonly ["usages", "user", string]

users​

readonly users: object

users.all()​

readonly all: () => readonly ["users"]

Returns​

readonly ["users"]

users.byHandle()​

readonly byHandle: (handle) => readonly ["users", "handle", string]

Parameters​
handle​

string

Returns​

readonly ["users", "handle", string]

users.credits()​

readonly credits: (userId) => readonly ["users", "detail", string, "credits"]

Parameters​
userId​

string

Returns​

readonly ["users", "detail", string, "credits"]

users.detail()​

readonly detail: (id) => readonly ["users", "detail", string]

Parameters​
id​

string

Returns​

readonly ["users", "detail", string]

users.details()​

readonly details: () => readonly ["users", "detail"]

Returns​

readonly ["users", "detail"]

users.list()​

readonly list: (filters?) => readonly ["users", "list", { filters: string | undefined; }]

Parameters​
filters?​

string

Returns​

readonly ["users", "list", { filters: string | undefined; }]

users.lists()​

readonly lists: () => readonly ["users", "list"]

Returns​

readonly ["users", "list"]

users.onboarding()​

readonly onboarding: (userId) => readonly ["users", "detail", string, "onboarding"]

Parameters​
userId​

string

Returns​

readonly ["users", "detail", string, "onboarding"]

users.search()​

readonly search: (pattern) => readonly ["users", "search", string]

Parameters​
pattern​

string

Returns​

readonly ["users", "search", string]

users.settings()​

readonly settings: (userId) => readonly ["users", "detail", string, "settings"]

Parameters​
userId​

string

Returns​

readonly ["users", "detail", string, "settings"]

users.surveys()​

readonly surveys: (userId) => readonly ["users", "detail", string, "surveys"]

Parameters​
userId​

string

Returns​

readonly ["users", "detail", string, "surveys"]

See​

https://tanstack.com/query/latest/docs/framework/react/guides/query-keys