# React Query Hooks
## Setup
```typescript
import { QueryClient, QueryClientProvider } from '@tanstack/react-query';
import { configure } from './hooks';
configure({
endpoint: 'https://api.example.com/graphql',
headers: { Authorization: 'Bearer ' },
});
const queryClient = new QueryClient();
function App() {
return (
);
}
```
## Hooks
| Hook | Type | Description |
|------|------|-------------|
| `useApisQuery` | Query | API surfaces exposed by this scope; publication makes a surface bindable from other scopes |
| `useApiQuery` | Query | API surfaces exposed by this scope; publication makes a surface bindable from other scopes |
| `useCreateApiMutation` | Mutation | API surfaces exposed by this scope; publication makes a surface bindable from other scopes |
| `useUpdateApiMutation` | Mutation | API surfaces exposed by this scope; publication makes a surface bindable from other scopes |
| `useDeleteApiMutation` | Mutation | API surfaces exposed by this scope; publication makes a surface bindable from other scopes |
| `useApiSchemasQuery` | Query | Join table linking API surfaces to the metaschema schemas they expose |
| `useApiSchemaQuery` | Query | Join table linking API surfaces to the metaschema schemas they expose |
| `useCreateApiSchemaMutation` | Mutation | Join table linking API surfaces to the metaschema schemas they expose |
| `useUpdateApiSchemaMutation` | Mutation | Join table linking API surfaces to the metaschema schemas they expose |
| `useDeleteApiSchemaMutation` | Mutation | Join table linking API surfaces to the metaschema schemas they expose |
| `useApiSettingsQuery` | Query | Per-API feature flag overrides; NULL columns inherit from database_settings |
| `useApiSettingQuery` | Query | Per-API feature flag overrides; NULL columns inherit from database_settings |
| `useCreateApiSettingMutation` | Mutation | Per-API feature flag overrides; NULL columns inherit from database_settings |
| `useUpdateApiSettingMutation` | Mutation | Per-API feature flag overrides; NULL columns inherit from database_settings |
| `useDeleteApiSettingMutation` | Mutation | Per-API feature flag overrides; NULL columns inherit from database_settings |
| `useAstMigrationsQuery` | Query | List all astMigrations |
| `useAstMigrationQuery` | Query | Get one astMigration |
| `useUpdateAstMigrationMutation` | Mutation | Update a astMigration |
| `useDeleteAstMigrationMutation` | Mutation | Delete a astMigration |
| `useCheckConstraintsQuery` | Query | List all checkConstraints |
| `useCheckConstraintQuery` | Query | Get one checkConstraint |
| `useCreateCheckConstraintMutation` | Mutation | Create a checkConstraint |
| `useUpdateCheckConstraintMutation` | Mutation | Update a checkConstraint |
| `useDeleteCheckConstraintMutation` | Mutation | Delete a checkConstraint |
| `useCompositeTypesQuery` | Query | List all compositeTypes |
| `useCompositeTypeQuery` | Query | Get one compositeType |
| `useCreateCompositeTypeMutation` | Mutation | Create a compositeType |
| `useUpdateCompositeTypeMutation` | Mutation | Update a compositeType |
| `useDeleteCompositeTypeMutation` | Mutation | Delete a compositeType |
| `useCorsSettingsQuery` | Query | Scope-wide and per-API CORS origin configuration; NULL api_id means scope-wide default |
| `useCorsSettingQuery` | Query | Scope-wide and per-API CORS origin configuration; NULL api_id means scope-wide default |
| `useCreateCorsSettingMutation` | Mutation | Scope-wide and per-API CORS origin configuration; NULL api_id means scope-wide default |
| `useUpdateCorsSettingMutation` | Mutation | Scope-wide and per-API CORS origin configuration; NULL api_id means scope-wide default |
| `useDeleteCorsSettingMutation` | Mutation | Scope-wide and per-API CORS origin configuration; NULL api_id means scope-wide default |
| `useDatabasesQuery` | Query | List all databases |
| `useDatabaseQuery` | Query | Get one database |
| `useCreateDatabaseMutation` | Mutation | Create a database |
| `useUpdateDatabaseMutation` | Mutation | Update a database |
| `useDeleteDatabaseMutation` | Mutation | Delete a database |
| `useDatabaseSettingsQuery` | Query | Scope-wide feature flags and settings; controls which platform features are available to all APIs in this scope |
| `useDatabaseSettingQuery` | Query | Scope-wide feature flags and settings; controls which platform features are available to all APIs in this scope |
| `useCreateDatabaseSettingMutation` | Mutation | Scope-wide feature flags and settings; controls which platform features are available to all APIs in this scope |
| `useUpdateDatabaseSettingMutation` | Mutation | Scope-wide feature flags and settings; controls which platform features are available to all APIs in this scope |
| `useDeleteDatabaseSettingMutation` | Mutation | Scope-wide feature flags and settings; controls which platform features are available to all APIs in this scope |
| `useDatabaseTransfersQuery` | Query | List all databaseTransfers |
| `useDatabaseTransferQuery` | Query | Get one databaseTransfer |
| `useCreateDatabaseTransferMutation` | Mutation | Create a databaseTransfer |
| `useUpdateDatabaseTransferMutation` | Mutation | Update a databaseTransfer |
| `useDeleteDatabaseTransferMutation` | Mutation | Delete a databaseTransfer |
| `useDefaultPrivilegesQuery` | Query | List all defaultPrivileges |
| `useDefaultPrivilegeQuery` | Query | Get one defaultPrivilege |
| `useCreateDefaultPrivilegeMutation` | Mutation | Create a defaultPrivilege |
| `useUpdateDefaultPrivilegeMutation` | Mutation | Update a defaultPrivilege |
| `useDeleteDefaultPrivilegeMutation` | Mutation | Delete a defaultPrivilege |
| `useDerivesQuery` | Query | List all derives |
| `useDeriveQuery` | Query | Get one derive |
| `useCreateDeriveMutation` | Mutation | Create a derive |
| `useUpdateDeriveMutation` | Mutation | Update a derive |
| `useDeleteDeriveMutation` | Mutation | Delete a derive |
| `useDomainsQuery` | Query | Fully-qualified hostnames owned by this scope; each row claims its hostname globally through the catalog |
| `useDomainQuery` | Query | Fully-qualified hostnames owned by this scope; each row claims its hostname globally through the catalog |
| `useCreateDomainMutation` | Mutation | Fully-qualified hostnames owned by this scope; each row claims its hostname globally through the catalog |
| `useUpdateDomainMutation` | Mutation | Fully-qualified hostnames owned by this scope; each row claims its hostname globally through the catalog |
| `useDeleteDomainMutation` | Mutation | Fully-qualified hostnames owned by this scope; each row claims its hostname globally through the catalog |
| `useDomainEventsQuery` | Query | Audit trail of domain lifecycle events |
| `useDomainEventQuery` | Query | Audit trail of domain lifecycle events |
| `useCreateDomainEventMutation` | Mutation | Audit trail of domain lifecycle events |
| `useUpdateDomainEventMutation` | Mutation | Audit trail of domain lifecycle events |
| `useDeleteDomainEventMutation` | Mutation | Audit trail of domain lifecycle events |
| `useDomainTypesQuery` | Query | List all domainTypes |
| `useDomainTypeQuery` | Query | Get one domainType |
| `useCreateDomainTypeMutation` | Mutation | Create a domainType |
| `useUpdateDomainTypeMutation` | Mutation | Update a domainType |
| `useDeleteDomainTypeMutation` | Mutation | Delete a domainType |
| `useDomainVerificationsQuery` | Query | Ownership verification challenges issued for a domain |
| `useDomainVerificationQuery` | Query | Ownership verification challenges issued for a domain |
| `useCreateDomainVerificationMutation` | Mutation | Ownership verification challenges issued for a domain |
| `useUpdateDomainVerificationMutation` | Mutation | Ownership verification challenges issued for a domain |
| `useDeleteDomainVerificationMutation` | Mutation | Ownership verification challenges issued for a domain |
| `useEmailIdentitiesQuery` | Query | Outbound sender identity: the from/reply-to/support addresses a tenant sends as, and the provider account the mail leaves through |
| `useEmailIdentityQuery` | Query | Outbound sender identity: the from/reply-to/support addresses a tenant sends as, and the provider account the mail leaves through |
| `useCreateEmailIdentityMutation` | Mutation | Outbound sender identity: the from/reply-to/support addresses a tenant sends as, and the provider account the mail leaves through |
| `useUpdateEmailIdentityMutation` | Mutation | Outbound sender identity: the from/reply-to/support addresses a tenant sends as, and the provider account the mail leaves through |
| `useDeleteEmailIdentityMutation` | Mutation | Outbound sender identity: the from/reply-to/support addresses a tenant sends as, and the provider account the mail leaves through |
| `useEmailProviderAccountsQuery` | Query | A tenant's configured account at an email provider: provider slug, endpoint coordinates, and the NAME of the secret holding its credentials (never the credential itself) |
| `useEmailProviderAccountQuery` | Query | A tenant's configured account at an email provider: provider slug, endpoint coordinates, and the NAME of the secret holding its credentials (never the credential itself) |
| `useCreateEmailProviderAccountMutation` | Mutation | A tenant's configured account at an email provider: provider slug, endpoint coordinates, and the NAME of the secret holding its credentials (never the credential itself) |
| `useUpdateEmailProviderAccountMutation` | Mutation | A tenant's configured account at an email provider: provider slug, endpoint coordinates, and the NAME of the secret holding its credentials (never the credential itself) |
| `useDeleteEmailProviderAccountMutation` | Mutation | A tenant's configured account at an email provider: provider slug, endpoint coordinates, and the NAME of the secret holding its credentials (never the credential itself) |
| `useEmailSiteIdentitiesQuery` | Query | Binds a site to the identity it sends as. Unique on site_id: one identity per site, but many sites may share an identity. |
| `useEmailSiteIdentityQuery` | Query | Binds a site to the identity it sends as. Unique on site_id: one identity per site, but many sites may share an identity. |
| `useCreateEmailSiteIdentityMutation` | Mutation | Binds a site to the identity it sends as. Unique on site_id: one identity per site, but many sites may share an identity. |
| `useUpdateEmailSiteIdentityMutation` | Mutation | Binds a site to the identity it sends as. Unique on site_id: one identity per site, but many sites may share an identity. |
| `useDeleteEmailSiteIdentityMutation` | Mutation | Binds a site to the identity it sends as. Unique on site_id: one identity per site, but many sites may share an identity. |
| `useEmbeddingChunksQuery` | Query | List all embeddingChunks |
| `useEmbeddingChunkQuery` | Query | Get one embeddingChunk |
| `useCreateEmbeddingChunkMutation` | Mutation | Create a embeddingChunk |
| `useUpdateEmbeddingChunkMutation` | Mutation | Update a embeddingChunk |
| `useDeleteEmbeddingChunkMutation` | Mutation | Delete a embeddingChunk |
| `useEnumsQuery` | Query | List all enums |
| `useEnumQuery` | Query | Get one enum |
| `useCreateEnumMutation` | Mutation | Create a enum |
| `useUpdateEnumMutation` | Mutation | Update a enum |
| `useDeleteEnumMutation` | Mutation | Delete a enum |
| `useExclusionConstraintsQuery` | Query | List all exclusionConstraints |
| `useExclusionConstraintQuery` | Query | Get one exclusionConstraint |
| `useCreateExclusionConstraintMutation` | Mutation | Create a exclusionConstraint |
| `useUpdateExclusionConstraintMutation` | Mutation | Update a exclusionConstraint |
| `useDeleteExclusionConstraintMutation` | Mutation | Delete a exclusionConstraint |
| `useFieldBehaviorsQuery` | Query | List all fieldBehaviors |
| `useFieldBehaviorQuery` | Query | Get one fieldBehavior |
| `useCreateFieldBehaviorMutation` | Mutation | Create a fieldBehavior |
| `useUpdateFieldBehaviorMutation` | Mutation | Update a fieldBehavior |
| `useDeleteFieldBehaviorMutation` | Mutation | Delete a fieldBehavior |
| `useFieldsQuery` | Query | List all fields |
| `useFieldQuery` | Query | Get one field |
| `useCreateFieldMutation` | Mutation | Create a field |
| `useUpdateFieldMutation` | Mutation | Update a field |
| `useDeleteFieldMutation` | Mutation | Delete a field |
| `useForeignKeyConstraintBehaviorsQuery` | Query | List all foreignKeyConstraintBehaviors |
| `useForeignKeyConstraintBehaviorQuery` | Query | Get one foreignKeyConstraintBehavior |
| `useCreateForeignKeyConstraintBehaviorMutation` | Mutation | Create a foreignKeyConstraintBehavior |
| `useUpdateForeignKeyConstraintBehaviorMutation` | Mutation | Update a foreignKeyConstraintBehavior |
| `useDeleteForeignKeyConstraintBehaviorMutation` | Mutation | Delete a foreignKeyConstraintBehavior |
| `useForeignKeyConstraintsQuery` | Query | List all foreignKeyConstraints |
| `useForeignKeyConstraintQuery` | Query | Get one foreignKeyConstraint |
| `useCreateForeignKeyConstraintMutation` | Mutation | Create a foreignKeyConstraint |
| `useUpdateForeignKeyConstraintMutation` | Mutation | Update a foreignKeyConstraint |
| `useDeleteForeignKeyConstraintMutation` | Mutation | Delete a foreignKeyConstraint |
| `useFullTextSearchesQuery` | Query | List all fullTextSearches |
| `useFullTextSearchQuery` | Query | Get one fullTextSearch |
| `useCreateFullTextSearchMutation` | Mutation | Create a fullTextSearch |
| `useUpdateFullTextSearchMutation` | Mutation | Update a fullTextSearch |
| `useDeleteFullTextSearchMutation` | Mutation | Delete a fullTextSearch |
| `useFunctionsQuery` | Query | List all functions |
| `useFunctionQuery` | Query | Get one function |
| `useCreateFunctionMutation` | Mutation | Create a function |
| `useUpdateFunctionMutation` | Mutation | Update a function |
| `useDeleteFunctionMutation` | Mutation | Delete a function |
| `useGetSitePreviewsQuery` | Query | List all getSitePreviews |
| `useIdentityProviderRegistriesQuery` | Query | List all identityProviderRegistries |
| `useIdentityProviderRegistryQuery` | Query | Get one identityProviderRegistry |
| `useCreateIdentityProviderRegistryMutation` | Mutation | Create a identityProviderRegistry |
| `useUpdateIdentityProviderRegistryMutation` | Mutation | Update a identityProviderRegistry |
| `useDeleteIdentityProviderRegistryMutation` | Mutation | Delete a identityProviderRegistry |
| `useIndicesQuery` | Query | List all indices |
| `useIndexQuery` | Query | Get one index |
| `useCreateIndexMutation` | Mutation | Create a index |
| `useUpdateIndexMutation` | Mutation | Update a index |
| `useDeleteIndexMutation` | Mutation | Delete a index |
| `useListSuspendedDatabasesQuery` | Query | List all listSuspendedDatabases |
| `useListSuspendedDatabasesRecordQuery` | Query | Get one listSuspendedDatabasesRecord |
| `useUpdateListSuspendedDatabasesRecordMutation` | Mutation | Update a listSuspendedDatabasesRecord |
| `useDeleteListSuspendedDatabasesRecordMutation` | Mutation | Delete a listSuspendedDatabasesRecord |
| `useManagedDomainsQuery` | Query | Platform-operated hostnames whose DNS and certificate lifecycle the platform drives |
| `useManagedDomainQuery` | Query | Platform-operated hostnames whose DNS and certificate lifecycle the platform drives |
| `useCreateManagedDomainMutation` | Mutation | Platform-operated hostnames whose DNS and certificate lifecycle the platform drives |
| `useUpdateManagedDomainMutation` | Mutation | Platform-operated hostnames whose DNS and certificate lifecycle the platform drives |
| `useDeleteManagedDomainMutation` | Mutation | Platform-operated hostnames whose DNS and certificate lifecycle the platform drives |
| `useNodeTypeRegistriesQuery` | Query | List all nodeTypeRegistries |
| `useNodeTypeRegistryQuery` | Query | Get one nodeTypeRegistry |
| `useCreateNodeTypeRegistryMutation` | Mutation | Create a nodeTypeRegistry |
| `useUpdateNodeTypeRegistryMutation` | Mutation | Update a nodeTypeRegistry |
| `useDeleteNodeTypeRegistryMutation` | Mutation | Delete a nodeTypeRegistry |
| `usePagesQuery` | Query | Site-owned page content — merkle-versioned head over the infra store; never a routing surface |
| `usePageQuery` | Query | Site-owned page content — merkle-versioned head over the infra store; never a routing surface |
| `useCreatePageMutation` | Mutation | Site-owned page content — merkle-versioned head over the infra store; never a routing surface |
| `useUpdatePageMutation` | Mutation | Site-owned page content — merkle-versioned head over the infra store; never a routing surface |
| `useDeletePageMutation` | Mutation | Site-owned page content — merkle-versioned head over the infra store; never a routing surface |
| `usePartitionsQuery` | Query | List all partitions |
| `usePartitionQuery` | Query | Get one partition |
| `useCreatePartitionMutation` | Mutation | Create a partition |
| `useUpdatePartitionMutation` | Mutation | Update a partition |
| `useDeletePartitionMutation` | Mutation | Delete a partition |
| `usePlatformApisQuery` | Query | API surfaces exposed by this scope; publication makes a surface bindable from other scopes |
| `usePlatformApiQuery` | Query | API surfaces exposed by this scope; publication makes a surface bindable from other scopes |
| `useCreatePlatformApiMutation` | Mutation | API surfaces exposed by this scope; publication makes a surface bindable from other scopes |
| `useUpdatePlatformApiMutation` | Mutation | API surfaces exposed by this scope; publication makes a surface bindable from other scopes |
| `useDeletePlatformApiMutation` | Mutation | API surfaces exposed by this scope; publication makes a surface bindable from other scopes |
| `usePlatformApiSchemasQuery` | Query | Join table linking API surfaces to the metaschema schemas they expose |
| `usePlatformApiSchemaQuery` | Query | Join table linking API surfaces to the metaschema schemas they expose |
| `useCreatePlatformApiSchemaMutation` | Mutation | Join table linking API surfaces to the metaschema schemas they expose |
| `useUpdatePlatformApiSchemaMutation` | Mutation | Join table linking API surfaces to the metaschema schemas they expose |
| `useDeletePlatformApiSchemaMutation` | Mutation | Join table linking API surfaces to the metaschema schemas they expose |
| `usePlatformApiSettingsQuery` | Query | Per-API feature flag overrides; NULL columns inherit from database_settings |
| `usePlatformApiSettingQuery` | Query | Per-API feature flag overrides; NULL columns inherit from database_settings |
| `useCreatePlatformApiSettingMutation` | Mutation | Per-API feature flag overrides; NULL columns inherit from database_settings |
| `useUpdatePlatformApiSettingMutation` | Mutation | Per-API feature flag overrides; NULL columns inherit from database_settings |
| `useDeletePlatformApiSettingMutation` | Mutation | Per-API feature flag overrides; NULL columns inherit from database_settings |
| `usePlatformCorsSettingsQuery` | Query | Scope-wide and per-API CORS origin configuration; NULL api_id means scope-wide default |
| `usePlatformCorsSettingQuery` | Query | Scope-wide and per-API CORS origin configuration; NULL api_id means scope-wide default |
| `useCreatePlatformCorsSettingMutation` | Mutation | Scope-wide and per-API CORS origin configuration; NULL api_id means scope-wide default |
| `useUpdatePlatformCorsSettingMutation` | Mutation | Scope-wide and per-API CORS origin configuration; NULL api_id means scope-wide default |
| `useDeletePlatformCorsSettingMutation` | Mutation | Scope-wide and per-API CORS origin configuration; NULL api_id means scope-wide default |
| `usePlatformDomainsQuery` | Query | Fully-qualified hostnames owned by this scope; each row claims its hostname globally through the catalog |
| `usePlatformDomainQuery` | Query | Fully-qualified hostnames owned by this scope; each row claims its hostname globally through the catalog |
| `useCreatePlatformDomainMutation` | Mutation | Fully-qualified hostnames owned by this scope; each row claims its hostname globally through the catalog |
| `useUpdatePlatformDomainMutation` | Mutation | Fully-qualified hostnames owned by this scope; each row claims its hostname globally through the catalog |
| `useDeletePlatformDomainMutation` | Mutation | Fully-qualified hostnames owned by this scope; each row claims its hostname globally through the catalog |
| `usePlatformDomainEventsQuery` | Query | Audit trail of domain lifecycle events |
| `usePlatformDomainEventQuery` | Query | Audit trail of domain lifecycle events |
| `useCreatePlatformDomainEventMutation` | Mutation | Audit trail of domain lifecycle events |
| `useUpdatePlatformDomainEventMutation` | Mutation | Audit trail of domain lifecycle events |
| `useDeletePlatformDomainEventMutation` | Mutation | Audit trail of domain lifecycle events |
| `usePlatformDomainVerificationsQuery` | Query | Ownership verification challenges issued for a domain |
| `usePlatformDomainVerificationQuery` | Query | Ownership verification challenges issued for a domain |
| `useCreatePlatformDomainVerificationMutation` | Mutation | Ownership verification challenges issued for a domain |
| `useUpdatePlatformDomainVerificationMutation` | Mutation | Ownership verification challenges issued for a domain |
| `useDeletePlatformDomainVerificationMutation` | Mutation | Ownership verification challenges issued for a domain |
| `usePlatformEmailIdentitiesQuery` | Query | Outbound sender identity: the from/reply-to/support addresses a tenant sends as, and the provider account the mail leaves through |
| `usePlatformEmailIdentityQuery` | Query | Outbound sender identity: the from/reply-to/support addresses a tenant sends as, and the provider account the mail leaves through |
| `useCreatePlatformEmailIdentityMutation` | Mutation | Outbound sender identity: the from/reply-to/support addresses a tenant sends as, and the provider account the mail leaves through |
| `useUpdatePlatformEmailIdentityMutation` | Mutation | Outbound sender identity: the from/reply-to/support addresses a tenant sends as, and the provider account the mail leaves through |
| `useDeletePlatformEmailIdentityMutation` | Mutation | Outbound sender identity: the from/reply-to/support addresses a tenant sends as, and the provider account the mail leaves through |
| `usePlatformEmailProviderAccountsQuery` | Query | A tenant's configured account at an email provider: provider slug, endpoint coordinates, and the NAME of the secret holding its credentials (never the credential itself) |
| `usePlatformEmailProviderAccountQuery` | Query | A tenant's configured account at an email provider: provider slug, endpoint coordinates, and the NAME of the secret holding its credentials (never the credential itself) |
| `useCreatePlatformEmailProviderAccountMutation` | Mutation | A tenant's configured account at an email provider: provider slug, endpoint coordinates, and the NAME of the secret holding its credentials (never the credential itself) |
| `useUpdatePlatformEmailProviderAccountMutation` | Mutation | A tenant's configured account at an email provider: provider slug, endpoint coordinates, and the NAME of the secret holding its credentials (never the credential itself) |
| `useDeletePlatformEmailProviderAccountMutation` | Mutation | A tenant's configured account at an email provider: provider slug, endpoint coordinates, and the NAME of the secret holding its credentials (never the credential itself) |
| `usePlatformEmailSiteIdentitiesQuery` | Query | Binds a site to the identity it sends as. Unique on site_id: one identity per site, but many sites may share an identity. |
| `usePlatformEmailSiteIdentityQuery` | Query | Binds a site to the identity it sends as. Unique on site_id: one identity per site, but many sites may share an identity. |
| `useCreatePlatformEmailSiteIdentityMutation` | Mutation | Binds a site to the identity it sends as. Unique on site_id: one identity per site, but many sites may share an identity. |
| `useUpdatePlatformEmailSiteIdentityMutation` | Mutation | Binds a site to the identity it sends as. Unique on site_id: one identity per site, but many sites may share an identity. |
| `useDeletePlatformEmailSiteIdentityMutation` | Mutation | Binds a site to the identity it sends as. Unique on site_id: one identity per site, but many sites may share an identity. |
| `usePlatformGetSitePreviewsQuery` | Query | List all platformGetSitePreviews |
| `usePlatformManagedDomainsQuery` | Query | Platform-operated hostnames whose DNS and certificate lifecycle the platform drives |
| `usePlatformManagedDomainQuery` | Query | Platform-operated hostnames whose DNS and certificate lifecycle the platform drives |
| `useCreatePlatformManagedDomainMutation` | Mutation | Platform-operated hostnames whose DNS and certificate lifecycle the platform drives |
| `useUpdatePlatformManagedDomainMutation` | Mutation | Platform-operated hostnames whose DNS and certificate lifecycle the platform drives |
| `useDeletePlatformManagedDomainMutation` | Mutation | Platform-operated hostnames whose DNS and certificate lifecycle the platform drives |
| `usePlatformPagesQuery` | Query | Site-owned page content — merkle-versioned head over the infra store; never a routing surface |
| `usePlatformPageQuery` | Query | Site-owned page content — merkle-versioned head over the infra store; never a routing surface |
| `useCreatePlatformPageMutation` | Mutation | Site-owned page content — merkle-versioned head over the infra store; never a routing surface |
| `useUpdatePlatformPageMutation` | Mutation | Site-owned page content — merkle-versioned head over the infra store; never a routing surface |
| `useDeletePlatformPageMutation` | Mutation | Site-owned page content — merkle-versioned head over the infra store; never a routing surface |
| `usePlatformReservedSubdomainsQuery` | Query | Subdomain labels no tenant may claim under a platform apex |
| `usePlatformReservedSubdomainQuery` | Query | Subdomain labels no tenant may claim under a platform apex |
| `useCreatePlatformReservedSubdomainMutation` | Mutation | Subdomain labels no tenant may claim under a platform apex |
| `useUpdatePlatformReservedSubdomainMutation` | Mutation | Subdomain labels no tenant may claim under a platform apex |
| `useDeletePlatformReservedSubdomainMutation` | Mutation | Subdomain labels no tenant may claim under a platform apex |
| `usePlatformSiteAppLinksQuery` | Query | Per-host native-app association for a site surface: which app-owned store identity this host serves, and the path patterns it claims (joined with the store identity to render AASA / assetlinks.json) |
| `usePlatformSiteAppLinkQuery` | Query | Per-host native-app association for a site surface: which app-owned store identity this host serves, and the path patterns it claims (joined with the store identity to render AASA / assetlinks.json) |
| `useCreatePlatformSiteAppLinkMutation` | Mutation | Per-host native-app association for a site surface: which app-owned store identity this host serves, and the path patterns it claims (joined with the store identity to render AASA / assetlinks.json) |
| `useUpdatePlatformSiteAppLinkMutation` | Mutation | Per-host native-app association for a site surface: which app-owned store identity this host serves, and the path patterns it claims (joined with the store identity to render AASA / assetlinks.json) |
| `useDeletePlatformSiteAppLinkMutation` | Mutation | Per-host native-app association for a site surface: which app-owned store identity this host serves, and the path patterns it claims (joined with the store identity to render AASA / assetlinks.json) |
| `usePlatformSitesQuery` | Query | Site surfaces exposed by this scope; publication makes a surface bindable from other scopes |
| `usePlatformSiteQuery` | Query | Site surfaces exposed by this scope; publication makes a surface bindable from other scopes |
| `useCreatePlatformSiteMutation` | Mutation | Site surfaces exposed by this scope; publication makes a surface bindable from other scopes |
| `useUpdatePlatformSiteMutation` | Mutation | Site surfaces exposed by this scope; publication makes a surface bindable from other scopes |
| `useDeletePlatformSiteMutation` | Mutation | Site surfaces exposed by this scope; publication makes a surface bindable from other scopes |
| `usePlatformSiteDeepLinksQuery` | Query | Named, retargetable deep links owned by a site surface (served at the deep-link path prefix; app interception via site_app_links) |
| `usePlatformSiteDeepLinkQuery` | Query | Named, retargetable deep links owned by a site surface (served at the deep-link path prefix; app interception via site_app_links) |
| `useCreatePlatformSiteDeepLinkMutation` | Mutation | Named, retargetable deep links owned by a site surface (served at the deep-link path prefix; app interception via site_app_links) |
| `useUpdatePlatformSiteDeepLinkMutation` | Mutation | Named, retargetable deep links owned by a site surface (served at the deep-link path prefix; app interception via site_app_links) |
| `useDeletePlatformSiteDeepLinkMutation` | Mutation | Named, retargetable deep links owned by a site surface (served at the deep-link path prefix; app interception via site_app_links) |
| `usePlatformSiteErrorPagesQuery` | Query | Custom error pages for a site surface, keyed by HTTP status code |
| `usePlatformSiteErrorPageQuery` | Query | Custom error pages for a site surface, keyed by HTTP status code |
| `useCreatePlatformSiteErrorPageMutation` | Mutation | Custom error pages for a site surface, keyed by HTTP status code |
| `useUpdatePlatformSiteErrorPageMutation` | Mutation | Custom error pages for a site surface, keyed by HTTP status code |
| `useDeletePlatformSiteErrorPageMutation` | Mutation | Custom error pages for a site surface, keyed by HTTP status code |
| `usePlatformSiteMetadataQuery` | Query | SEO and social sharing metadata for a site surface |
| `usePlatformSiteMetadatumQuery` | Query | SEO and social sharing metadata for a site surface |
| `useCreatePlatformSiteMetadatumMutation` | Mutation | SEO and social sharing metadata for a site surface |
| `useUpdatePlatformSiteMetadatumMutation` | Mutation | SEO and social sharing metadata for a site surface |
| `useDeletePlatformSiteMetadatumMutation` | Mutation | SEO and social sharing metadata for a site surface |
| `usePlatformSiteModulesQuery` | Query | Frontend module configuration for a site surface; stores module name and JSON settings |
| `usePlatformSiteModuleQuery` | Query | Frontend module configuration for a site surface; stores module name and JSON settings |
| `useCreatePlatformSiteModuleMutation` | Mutation | Frontend module configuration for a site surface; stores module name and JSON settings |
| `useUpdatePlatformSiteModuleMutation` | Mutation | Frontend module configuration for a site surface; stores module name and JSON settings |
| `useDeletePlatformSiteModuleMutation` | Mutation | Frontend module configuration for a site surface; stores module name and JSON settings |
| `usePlatformSiteReleasesQuery` | Query | Immutable static-site release manifest head, versioned in the site-owned merkle store |
| `usePlatformSiteReleaseQuery` | Query | Immutable static-site release manifest head, versioned in the site-owned merkle store |
| `useCreatePlatformSiteReleaseMutation` | Mutation | Immutable static-site release manifest head, versioned in the site-owned merkle store |
| `useUpdatePlatformSiteReleaseMutation` | Mutation | Immutable static-site release manifest head, versioned in the site-owned merkle store |
| `useDeletePlatformSiteReleaseMutation` | Mutation | Immutable static-site release manifest head, versioned in the site-owned merkle store |
| `usePlatformSiteThemesQuery` | Query | Theme (colors, fonts, design tokens) for a site surface |
| `usePlatformSiteThemeQuery` | Query | Theme (colors, fonts, design tokens) for a site surface |
| `useCreatePlatformSiteThemeMutation` | Mutation | Theme (colors, fonts, design tokens) for a site surface |
| `useUpdatePlatformSiteThemeMutation` | Mutation | Theme (colors, fonts, design tokens) for a site surface |
| `useDeletePlatformSiteThemeMutation` | Mutation | Theme (colors, fonts, design tokens) for a site surface |
| `usePlatformSiteWebConfigsQuery` | Query | Static-site serving configuration for a site surface (index document, clean URLs, SPA fallback) |
| `usePlatformSiteWebConfigQuery` | Query | Static-site serving configuration for a site surface (index document, clean URLs, SPA fallback) |
| `useCreatePlatformSiteWebConfigMutation` | Mutation | Static-site serving configuration for a site surface (index document, clean URLs, SPA fallback) |
| `useUpdatePlatformSiteWebConfigMutation` | Mutation | Static-site serving configuration for a site surface (index document, clean URLs, SPA fallback) |
| `useDeletePlatformSiteWebConfigMutation` | Mutation | Static-site serving configuration for a site surface (index document, clean URLs, SPA fallback) |
| `usePoliciesQuery` | Query | List all policies |
| `usePolicyQuery` | Query | Get one policy |
| `useCreatePolicyMutation` | Mutation | Create a policy |
| `useUpdatePolicyMutation` | Mutation | Update a policy |
| `useDeletePolicyMutation` | Mutation | Delete a policy |
| `usePrimaryKeyConstraintsQuery` | Query | List all primaryKeyConstraints |
| `usePrimaryKeyConstraintQuery` | Query | Get one primaryKeyConstraint |
| `useCreatePrimaryKeyConstraintMutation` | Mutation | Create a primaryKeyConstraint |
| `useUpdatePrimaryKeyConstraintMutation` | Mutation | Update a primaryKeyConstraint |
| `useDeletePrimaryKeyConstraintMutation` | Mutation | Delete a primaryKeyConstraint |
| `usePubkeySettingsQuery` | Query | Public-key crypto auth runtime configuration; typed references to the crypto sign-up/sign-in function plumbing |
| `usePubkeySettingQuery` | Query | Public-key crypto auth runtime configuration; typed references to the crypto sign-up/sign-in function plumbing |
| `useCreatePubkeySettingMutation` | Mutation | Public-key crypto auth runtime configuration; typed references to the crypto sign-up/sign-in function plumbing |
| `useUpdatePubkeySettingMutation` | Mutation | Public-key crypto auth runtime configuration; typed references to the crypto sign-up/sign-in function plumbing |
| `useDeletePubkeySettingMutation` | Mutation | Public-key crypto auth runtime configuration; typed references to the crypto sign-up/sign-in function plumbing |
| `useRedirectsQuery` | Query | Redirect targets a route can point at; the edge answers with a redirect status instead of a backend |
| `useRedirectQuery` | Query | Redirect targets a route can point at; the edge answers with a redirect status instead of a backend |
| `useCreateRedirectMutation` | Mutation | Redirect targets a route can point at; the edge answers with a redirect status instead of a backend |
| `useUpdateRedirectMutation` | Mutation | Redirect targets a route can point at; the edge answers with a redirect status instead of a backend |
| `useDeleteRedirectMutation` | Mutation | Redirect targets a route can point at; the edge answers with a redirect status instead of a backend |
| `useRlsSettingsQuery` | Query | RLS module runtime configuration; typed references to the authenticate/current_role function plumbing |
| `useRlsSettingQuery` | Query | RLS module runtime configuration; typed references to the authenticate/current_role function plumbing |
| `useCreateRlsSettingMutation` | Mutation | RLS module runtime configuration; typed references to the authenticate/current_role function plumbing |
| `useUpdateRlsSettingMutation` | Mutation | RLS module runtime configuration; typed references to the authenticate/current_role function plumbing |
| `useDeleteRlsSettingMutation` | Mutation | RLS module runtime configuration; typed references to the authenticate/current_role function plumbing |
| `useRoutesQuery` | Query | Routes binding a domain hostname and path to a typed catalog target |
| `useRouteQuery` | Query | Routes binding a domain hostname and path to a typed catalog target |
| `useCreateRouteMutation` | Mutation | Routes binding a domain hostname and path to a typed catalog target |
| `useUpdateRouteMutation` | Mutation | Routes binding a domain hostname and path to a typed catalog target |
| `useDeleteRouteMutation` | Mutation | Routes binding a domain hostname and path to a typed catalog target |
| `useSchemasQuery` | Query | List all schemas |
| `useSchemaQuery` | Query | Get one schema |
| `useCreateSchemaMutation` | Mutation | Create a schema |
| `useUpdateSchemaMutation` | Mutation | Update a schema |
| `useDeleteSchemaMutation` | Mutation | Delete a schema |
| `useSchemaGrantsQuery` | Query | List all schemaGrants |
| `useSchemaGrantQuery` | Query | Get one schemaGrant |
| `useCreateSchemaGrantMutation` | Mutation | Create a schemaGrant |
| `useUpdateSchemaGrantMutation` | Mutation | Update a schemaGrant |
| `useDeleteSchemaGrantMutation` | Mutation | Delete a schemaGrant |
| `useSiteAppLinksQuery` | Query | Per-host native-app association for a site surface: which app-owned store identity this host serves, and the path patterns it claims (joined with the store identity to render AASA / assetlinks.json) |
| `useSiteAppLinkQuery` | Query | Per-host native-app association for a site surface: which app-owned store identity this host serves, and the path patterns it claims (joined with the store identity to render AASA / assetlinks.json) |
| `useCreateSiteAppLinkMutation` | Mutation | Per-host native-app association for a site surface: which app-owned store identity this host serves, and the path patterns it claims (joined with the store identity to render AASA / assetlinks.json) |
| `useUpdateSiteAppLinkMutation` | Mutation | Per-host native-app association for a site surface: which app-owned store identity this host serves, and the path patterns it claims (joined with the store identity to render AASA / assetlinks.json) |
| `useDeleteSiteAppLinkMutation` | Mutation | Per-host native-app association for a site surface: which app-owned store identity this host serves, and the path patterns it claims (joined with the store identity to render AASA / assetlinks.json) |
| `useSitesQuery` | Query | Site surfaces exposed by this scope; publication makes a surface bindable from other scopes |
| `useSiteQuery` | Query | Site surfaces exposed by this scope; publication makes a surface bindable from other scopes |
| `useCreateSiteMutation` | Mutation | Site surfaces exposed by this scope; publication makes a surface bindable from other scopes |
| `useUpdateSiteMutation` | Mutation | Site surfaces exposed by this scope; publication makes a surface bindable from other scopes |
| `useDeleteSiteMutation` | Mutation | Site surfaces exposed by this scope; publication makes a surface bindable from other scopes |
| `useSiteDeepLinksQuery` | Query | Named, retargetable deep links owned by a site surface (served at the deep-link path prefix; app interception via site_app_links) |
| `useSiteDeepLinkQuery` | Query | Named, retargetable deep links owned by a site surface (served at the deep-link path prefix; app interception via site_app_links) |
| `useCreateSiteDeepLinkMutation` | Mutation | Named, retargetable deep links owned by a site surface (served at the deep-link path prefix; app interception via site_app_links) |
| `useUpdateSiteDeepLinkMutation` | Mutation | Named, retargetable deep links owned by a site surface (served at the deep-link path prefix; app interception via site_app_links) |
| `useDeleteSiteDeepLinkMutation` | Mutation | Named, retargetable deep links owned by a site surface (served at the deep-link path prefix; app interception via site_app_links) |
| `useSiteErrorPagesQuery` | Query | Custom error pages for a site surface, keyed by HTTP status code |
| `useSiteErrorPageQuery` | Query | Custom error pages for a site surface, keyed by HTTP status code |
| `useCreateSiteErrorPageMutation` | Mutation | Custom error pages for a site surface, keyed by HTTP status code |
| `useUpdateSiteErrorPageMutation` | Mutation | Custom error pages for a site surface, keyed by HTTP status code |
| `useDeleteSiteErrorPageMutation` | Mutation | Custom error pages for a site surface, keyed by HTTP status code |
| `useSiteMetadataQuery` | Query | SEO and social sharing metadata for a site surface |
| `useSiteMetadatumQuery` | Query | SEO and social sharing metadata for a site surface |
| `useCreateSiteMetadatumMutation` | Mutation | SEO and social sharing metadata for a site surface |
| `useUpdateSiteMetadatumMutation` | Mutation | SEO and social sharing metadata for a site surface |
| `useDeleteSiteMetadatumMutation` | Mutation | SEO and social sharing metadata for a site surface |
| `useSiteModulesQuery` | Query | Frontend module configuration for a site surface; stores module name and JSON settings |
| `useSiteModuleQuery` | Query | Frontend module configuration for a site surface; stores module name and JSON settings |
| `useCreateSiteModuleMutation` | Mutation | Frontend module configuration for a site surface; stores module name and JSON settings |
| `useUpdateSiteModuleMutation` | Mutation | Frontend module configuration for a site surface; stores module name and JSON settings |
| `useDeleteSiteModuleMutation` | Mutation | Frontend module configuration for a site surface; stores module name and JSON settings |
| `useSiteReleasesQuery` | Query | Immutable static-site release manifest head, versioned in the site-owned merkle store |
| `useSiteReleaseQuery` | Query | Immutable static-site release manifest head, versioned in the site-owned merkle store |
| `useCreateSiteReleaseMutation` | Mutation | Immutable static-site release manifest head, versioned in the site-owned merkle store |
| `useUpdateSiteReleaseMutation` | Mutation | Immutable static-site release manifest head, versioned in the site-owned merkle store |
| `useDeleteSiteReleaseMutation` | Mutation | Immutable static-site release manifest head, versioned in the site-owned merkle store |
| `useSiteThemesQuery` | Query | Theme (colors, fonts, design tokens) for a site surface |
| `useSiteThemeQuery` | Query | Theme (colors, fonts, design tokens) for a site surface |
| `useCreateSiteThemeMutation` | Mutation | Theme (colors, fonts, design tokens) for a site surface |
| `useUpdateSiteThemeMutation` | Mutation | Theme (colors, fonts, design tokens) for a site surface |
| `useDeleteSiteThemeMutation` | Mutation | Theme (colors, fonts, design tokens) for a site surface |
| `useSiteWebConfigsQuery` | Query | Static-site serving configuration for a site surface (index document, clean URLs, SPA fallback) |
| `useSiteWebConfigQuery` | Query | Static-site serving configuration for a site surface (index document, clean URLs, SPA fallback) |
| `useCreateSiteWebConfigMutation` | Mutation | Static-site serving configuration for a site surface (index document, clean URLs, SPA fallback) |
| `useUpdateSiteWebConfigMutation` | Mutation | Static-site serving configuration for a site surface (index document, clean URLs, SPA fallback) |
| `useDeleteSiteWebConfigMutation` | Mutation | Static-site serving configuration for a site surface (index document, clean URLs, SPA fallback) |
| `useSpatialRelationsQuery` | Query | List all spatialRelations |
| `useSpatialRelationQuery` | Query | Get one spatialRelation |
| `useCreateSpatialRelationMutation` | Mutation | Create a spatialRelation |
| `useUpdateSpatialRelationMutation` | Mutation | Update a spatialRelation |
| `useDeleteSpatialRelationMutation` | Mutation | Delete a spatialRelation |
| `useSqlActionsQuery` | Query | List all sqlActions |
| `useSqlActionQuery` | Query | Get one sqlAction |
| `useUpdateSqlActionMutation` | Mutation | Update a sqlAction |
| `useDeleteSqlActionMutation` | Mutation | Delete a sqlAction |
| `useTableBehaviorsQuery` | Query | List all tableBehaviors |
| `useTableBehaviorQuery` | Query | Get one tableBehavior |
| `useCreateTableBehaviorMutation` | Mutation | Create a tableBehavior |
| `useUpdateTableBehaviorMutation` | Mutation | Update a tableBehavior |
| `useDeleteTableBehaviorMutation` | Mutation | Delete a tableBehavior |
| `useTablesQuery` | Query | List all tables |
| `useTableQuery` | Query | Get one table |
| `useCreateTableMutation` | Mutation | Create a table |
| `useUpdateTableMutation` | Mutation | Update a table |
| `useDeleteTableMutation` | Mutation | Delete a table |
| `useTableGrantsQuery` | Query | List all tableGrants |
| `useTableGrantQuery` | Query | Get one tableGrant |
| `useCreateTableGrantMutation` | Mutation | Create a tableGrant |
| `useUpdateTableGrantMutation` | Mutation | Update a tableGrant |
| `useDeleteTableGrantMutation` | Mutation | Delete a tableGrant |
| `useTriggersQuery` | Query | List all triggers |
| `useTriggerQuery` | Query | Get one trigger |
| `useCreateTriggerMutation` | Mutation | Create a trigger |
| `useUpdateTriggerMutation` | Mutation | Update a trigger |
| `useDeleteTriggerMutation` | Mutation | Delete a trigger |
| `useTriggerFunctionsQuery` | Query | List all triggerFunctions |
| `useTriggerFunctionQuery` | Query | Get one triggerFunction |
| `useCreateTriggerFunctionMutation` | Mutation | Create a triggerFunction |
| `useUpdateTriggerFunctionMutation` | Mutation | Update a triggerFunction |
| `useDeleteTriggerFunctionMutation` | Mutation | Delete a triggerFunction |
| `useUniqueConstraintBehaviorsQuery` | Query | List all uniqueConstraintBehaviors |
| `useUniqueConstraintBehaviorQuery` | Query | Get one uniqueConstraintBehavior |
| `useCreateUniqueConstraintBehaviorMutation` | Mutation | Create a uniqueConstraintBehavior |
| `useUpdateUniqueConstraintBehaviorMutation` | Mutation | Update a uniqueConstraintBehavior |
| `useDeleteUniqueConstraintBehaviorMutation` | Mutation | Delete a uniqueConstraintBehavior |
| `useUniqueConstraintsQuery` | Query | List all uniqueConstraints |
| `useUniqueConstraintQuery` | Query | Get one uniqueConstraint |
| `useCreateUniqueConstraintMutation` | Mutation | Create a uniqueConstraint |
| `useUpdateUniqueConstraintMutation` | Mutation | Update a uniqueConstraint |
| `useDeleteUniqueConstraintMutation` | Mutation | Delete a uniqueConstraint |
| `useViewBehaviorsQuery` | Query | List all viewBehaviors |
| `useViewBehaviorQuery` | Query | Get one viewBehavior |
| `useCreateViewBehaviorMutation` | Mutation | Create a viewBehavior |
| `useUpdateViewBehaviorMutation` | Mutation | Update a viewBehavior |
| `useDeleteViewBehaviorMutation` | Mutation | Delete a viewBehavior |
| `useViewsQuery` | Query | List all views |
| `useViewQuery` | Query | Get one view |
| `useCreateViewMutation` | Mutation | Create a view |
| `useUpdateViewMutation` | Mutation | Update a view |
| `useDeleteViewMutation` | Mutation | Delete a view |
| `useViewGrantsQuery` | Query | List all viewGrants |
| `useViewGrantQuery` | Query | Get one viewGrant |
| `useCreateViewGrantMutation` | Mutation | Create a viewGrant |
| `useUpdateViewGrantMutation` | Mutation | Update a viewGrant |
| `useDeleteViewGrantMutation` | Mutation | Delete a viewGrant |
| `useViewRulesQuery` | Query | DO INSTEAD rules for views (e.g., read-only enforcement) |
| `useViewRuleQuery` | Query | DO INSTEAD rules for views (e.g., read-only enforcement) |
| `useCreateViewRuleMutation` | Mutation | DO INSTEAD rules for views (e.g., read-only enforcement) |
| `useUpdateViewRuleMutation` | Mutation | DO INSTEAD rules for views (e.g., read-only enforcement) |
| `useDeleteViewRuleMutation` | Mutation | DO INSTEAD rules for views (e.g., read-only enforcement) |
| `useViewTablesQuery` | Query | Junction table linking views to their joined tables for referential integrity |
| `useViewTableQuery` | Query | Junction table linking views to their joined tables for referential integrity |
| `useCreateViewTableMutation` | Mutation | Junction table linking views to their joined tables for referential integrity |
| `useUpdateViewTableMutation` | Mutation | Junction table linking views to their joined tables for referential integrity |
| `useDeleteViewTableMutation` | Mutation | Junction table linking views to their joined tables for referential integrity |
| `useWebauthnSettingsQuery` | Query | WebAuthn/passkey runtime configuration; relying party options and typed references to the credential/session storage |
| `useWebauthnSettingQuery` | Query | WebAuthn/passkey runtime configuration; relying party options and typed references to the credential/session storage |
| `useCreateWebauthnSettingMutation` | Mutation | WebAuthn/passkey runtime configuration; relying party options and typed references to the credential/session storage |
| `useUpdateWebauthnSettingMutation` | Mutation | WebAuthn/passkey runtime configuration; relying party options and typed references to the credential/session storage |
| `useDeleteWebauthnSettingMutation` | Mutation | WebAuthn/passkey runtime configuration; relying party options and typed references to the credential/session storage |
| `useApplyRegistryDefaultsQuery` | Query | applyRegistryDefaults |
| `useEmailSharedAccountQuery` | Query | emailSharedAccount |
| `useGetSitePreviewCommitQuery` | Query | getSitePreviewCommit |
| `useGetSiteReleaseManifestQuery` | Query | getSiteReleaseManifest |
| `usePagePublishedQuery` | Query | pagePublished |
| `usePlatformGetSitePreviewCommitQuery` | Query | platformGetSitePreviewCommit |
| `usePlatformGetSiteReleaseManifestQuery` | Query | platformGetSiteReleaseManifest |
| `usePlatformPagePublishedQuery` | Query | platformPagePublished |
| `usePlatformSitesDeepLinkUrlQuery` | Query | platformSitesDeepLinkUrl |
| `usePlatformSitesSiteOriginQuery` | Query | platformSitesSiteOrigin |
| `usePlatformVerifySitePreviewTokenQuery` | Query | platformVerifySitePreviewToken |
| `useSitesDeepLinkUrlQuery` | Query | sitesDeepLinkUrl |
| `useSitesSiteOriginQuery` | Query | sitesSiteOrigin |
| `useVerifySitePreviewTokenQuery` | Query | verifySitePreviewToken |
| `useAcceptDatabaseTransferMutation` | Mutation | acceptDatabaseTransfer |
| `useApplyRlsMutation` | Mutation | applyRls |
| `useCancelDatabaseTransferMutation` | Mutation | cancelDatabaseTransfer |
| `useCreateFunctionFromSourceMutation` | Mutation | Creates a `Function` from its `CREATE FUNCTION` source text. |
| `useDeleteSitePreviewMutation` | Mutation | deleteSitePreview |
| `useDomainsAssignSubdomainMutation` | Mutation | domainsAssignSubdomain |
| `useMintSitePreviewTokenMutation` | Mutation | mintSitePreviewToken |
| `usePagesInstallPagesMutation` | Mutation | pagesInstallPages |
| `usePlatformDeleteSitePreviewMutation` | Mutation | platformDeleteSitePreview |
| `usePlatformDomainsAssignSubdomainMutation` | Mutation | platformDomainsAssignSubdomain |
| `usePlatformMintSitePreviewTokenMutation` | Mutation | platformMintSitePreviewToken |
| `usePlatformPagesInstallPagesMutation` | Mutation | platformPagesInstallPages |
| `usePlatformProvisionSitePreviewMutation` | Mutation | platformProvisionSitePreview |
| `usePlatformSetSitePreviewMutation` | Mutation | platformSetSitePreview |
| `usePlatformSiteMetadataInstallRobotsMutation` | Mutation | platformSiteMetadataInstallRobots |
| `usePlatformSitesInstallContentPresetMutation` | Mutation | platformSitesInstallContentPreset |
| `usePlatformSitesInstallMantraMutation` | Mutation | platformSitesInstallMantra |
| `usePlatformSitesProvisionStaticSiteMutation` | Mutation | platformSitesProvisionStaticSite |
| `useProvisionBucketMutation` | Mutation | Reconcile an S3 bucket for a logical bucket in the database.
Records the request on the bucket row via RLS; the bucket's job
trigger then enqueues the same storage:provision_bucket job used on
INSERT, and repeated requests collapse into one pending job. This is
idempotent for an already-reconciled bucket; failures become GraphQL
errors. |
| `useProvisionSitePreviewMutation` | Mutation | provisionSitePreview |
| `useRejectDatabaseTransferMutation` | Mutation | rejectDatabaseTransfer |
| `useRequestDatabaseMutation` | Mutation | Requests a database and returns a ticket (database_provision_module row) to poll.
Pass exactly one of preset_slug or modules. Pass organization_id to have the organization own the database from the start (the caller must be an owner of that organization); the requesting user is still the identity bootstrapped into the new database. Omit it for a personal database. The pool, presets, and owner bootstrap are private implementation details: a warm pool hit fulfills the ticket immediately (fulfilled_at set, deferred owner bootstrap), otherwise the database is cold-provisioned asynchronously with exactly the requested modules. Poll the ticket until status = 'completed'; it then carries database_id and fulfilled_at.
Example usage:
SELECT * FROM metaschema_public.request_database('my_app', 'example.com', preset_slug := 'full');
SELECT * FROM metaschema_public.request_database('my_app', 'example.com', modules := '["users_module", "emails_module"]'::jsonb);
SELECT * FROM metaschema_public.request_database('team_app', 'example.com', preset_slug := 'full', organization_id := '00000000-0000-0000-0000-000000000000'::uuid); |
| `useSetFieldOrderMutation` | Mutation | setFieldOrder |
| `useSetSitePreviewMutation` | Mutation | setSitePreview |
| `useSiteMetadataInstallRobotsMutation` | Mutation | siteMetadataInstallRobots |
| `useSitesInstallContentPresetMutation` | Mutation | sitesInstallContentPreset |
| `useSitesInstallMantraMutation` | Mutation | sitesInstallMantra |
| `useSitesProvisionStaticSiteMutation` | Mutation | sitesProvisionStaticSite |
| `useSuspendDatabaseMutation` | Mutation | suspendDatabase |
| `useUnsuspendDatabaseMutation` | Mutation | unsuspendDatabase |
| `useUpdateFunctionFromSourceMutation` | Mutation | Replaces a `Function`'s definition from its source text; its database, schema and exposure are unchanged. |
## Table Hooks
### Api
```typescript
// List all apis
const { data, isLoading } = useApisQuery({
selection: { fields: { anonRole: true, config: true, createdAt: true, databaseId: true, id: true, isPublished: true, name: true, roleName: true, serviceHostname: true, updatedAt: true } },
});
// Get one api
const { data: item } = useApiQuery({
id: '',
selection: { fields: { anonRole: true, config: true, createdAt: true, databaseId: true, id: true, isPublished: true, name: true, roleName: true, serviceHostname: true, updatedAt: true } },
});
// Create a api
const { mutate: create } = useCreateApiMutation({
selection: { fields: { id: true } },
});
create({ anonRole: '', config: '', databaseId: '', isPublished: '', name: '', roleName: '' });
```
### ApiSchema
```typescript
// List all apiSchemas
const { data, isLoading } = useApiSchemasQuery({
selection: { fields: { apiId: true, createdAt: true, databaseId: true, id: true, schemaId: true, updatedAt: true } },
});
// Get one apiSchema
const { data: item } = useApiSchemaQuery({
id: '',
selection: { fields: { apiId: true, createdAt: true, databaseId: true, id: true, schemaId: true, updatedAt: true } },
});
// Create a apiSchema
const { mutate: create } = useCreateApiSchemaMutation({
selection: { fields: { id: true } },
});
create({ apiId: '', databaseId: '', schemaId: '' });
```
### ApiSetting
```typescript
// List all apiSettings
const { data, isLoading } = useApiSettingsQuery({
selection: { fields: { apiId: true, createdAt: true, databaseId: true, enableAggregates: true, enableBulk: true, enableConnectionFilter: true, enableI18N: true, enableIntrospection: true, enableLlm: true, enableLtree: true, enableManyToMany: true, enablePostgis: true, enablePresignedUploads: true, enableRealtime: true, enableSearch: true, id: true, idleInTransactionTimeoutMs: true, lockTimeoutMs: true, maxConcurrentRequests: true, maxPageSize: true, maxQueryCost: true, maxQueryDepth: true, maxQueueWaitMs: true, maxRequestBytes: true, options: true, rateLimitBurst: true, rateLimitRpm: true, statementTimeoutMs: true, updatedAt: true } },
});
// Get one apiSetting
const { data: item } = useApiSettingQuery({
id: '',
selection: { fields: { apiId: true, createdAt: true, databaseId: true, enableAggregates: true, enableBulk: true, enableConnectionFilter: true, enableI18N: true, enableIntrospection: true, enableLlm: true, enableLtree: true, enableManyToMany: true, enablePostgis: true, enablePresignedUploads: true, enableRealtime: true, enableSearch: true, id: true, idleInTransactionTimeoutMs: true, lockTimeoutMs: true, maxConcurrentRequests: true, maxPageSize: true, maxQueryCost: true, maxQueryDepth: true, maxQueueWaitMs: true, maxRequestBytes: true, options: true, rateLimitBurst: true, rateLimitRpm: true, statementTimeoutMs: true, updatedAt: true } },
});
// Create a apiSetting
const { mutate: create } = useCreateApiSettingMutation({
selection: { fields: { id: true } },
});
create({ apiId: '', databaseId: '', enableAggregates: '', enableBulk: '', enableConnectionFilter: '', enableI18N: '', enableIntrospection: '', enableLlm: '', enableLtree: '', enableManyToMany: '', enablePostgis: '', enablePresignedUploads: '', enableRealtime: '', enableSearch: '', idleInTransactionTimeoutMs: '', lockTimeoutMs: '', maxConcurrentRequests: '', maxPageSize: '', maxQueryCost: '', maxQueryDepth: '', maxQueueWaitMs: '', maxRequestBytes: '', options: '', rateLimitBurst: '', rateLimitRpm: '', statementTimeoutMs: '' });
```
### AstMigration
```typescript
// List all astMigrations
const { data, isLoading } = useAstMigrationsQuery({
selection: { fields: { actionId: true, actionName: true, actorId: true, createdAt: true, databaseId: true, deploy: true, deploys: true, id: true, name: true, payload: true, requires: true, revert: true, verify: true } },
});
// Get one astMigration
const { data: item } = useAstMigrationQuery({
id: '',
selection: { fields: { actionId: true, actionName: true, actorId: true, createdAt: true, databaseId: true, deploy: true, deploys: true, id: true, name: true, payload: true, requires: true, revert: true, verify: true } },
});
```
### CheckConstraint
```typescript
// List all checkConstraints
const { data, isLoading } = useCheckConstraintsQuery({
selection: { fields: { category: true, createdAt: true, databaseId: true, expr: true, fieldIds: true, id: true, initiallyDeferred: true, isDeferrable: true, name: true, smartTags: true, tableId: true, tags: true, type: true, updatedAt: true } },
});
// Get one checkConstraint
const { data: item } = useCheckConstraintQuery({
id: '',
selection: { fields: { category: true, createdAt: true, databaseId: true, expr: true, fieldIds: true, id: true, initiallyDeferred: true, isDeferrable: true, name: true, smartTags: true, tableId: true, tags: true, type: true, updatedAt: true } },
});
// Create a checkConstraint
const { mutate: create } = useCreateCheckConstraintMutation({
selection: { fields: { id: true } },
});
create({ category: '', databaseId: '', expr: '', fieldIds: '', initiallyDeferred: '', isDeferrable: '', name: '', smartTags: '', tableId: '', tags: '', type: '' });
```
### CompositeType
```typescript
// List all compositeTypes
const { data, isLoading } = useCompositeTypesQuery({
selection: { fields: { attributes: true, category: true, databaseId: true, description: true, id: true, label: true, name: true, schemaId: true, smartTags: true, tags: true } },
});
// Get one compositeType
const { data: item } = useCompositeTypeQuery({
id: '',
selection: { fields: { attributes: true, category: true, databaseId: true, description: true, id: true, label: true, name: true, schemaId: true, smartTags: true, tags: true } },
});
// Create a compositeType
const { mutate: create } = useCreateCompositeTypeMutation({
selection: { fields: { id: true } },
});
create({ attributes: '', category: '', databaseId: '', description: '', label: '', name: '', schemaId: '', smartTags: '', tags: '' });
```
### CorsSetting
```typescript
// List all corsSettings
const { data, isLoading } = useCorsSettingsQuery({
selection: { fields: { allowedOrigins: true, apiId: true, createdAt: true, databaseId: true, id: true, updatedAt: true } },
});
// Get one corsSetting
const { data: item } = useCorsSettingQuery({
id: '',
selection: { fields: { allowedOrigins: true, apiId: true, createdAt: true, databaseId: true, id: true, updatedAt: true } },
});
// Create a corsSetting
const { mutate: create } = useCreateCorsSettingMutation({
selection: { fields: { id: true } },
});
create({ allowedOrigins: '', apiId: '', databaseId: '' });
```
### Database
```typescript
// List all databases
const { data, isLoading } = useDatabasesQuery({
selection: { fields: { createdAt: true, hash: true, id: true, label: true, name: true, ownerId: true, platform: true, suspendedAt: true, suspendedReason: true, updatedAt: true } },
});
// Get one database
const { data: item } = useDatabaseQuery({
id: '',
selection: { fields: { createdAt: true, hash: true, id: true, label: true, name: true, ownerId: true, platform: true, suspendedAt: true, suspendedReason: true, updatedAt: true } },
});
// Create a database
const { mutate: create } = useCreateDatabaseMutation({
selection: { fields: { id: true } },
});
create({ hash: '', label: '', name: '', ownerId: '', platform: '' });
```
### DatabaseSetting
```typescript
// List all databaseSettings
const { data, isLoading } = useDatabaseSettingsQuery({
selection: { fields: { annotations: true, createdAt: true, creditsPerCent: true, databaseId: true, enableAggregates: true, enableBilling: true, enableBulk: true, enableConnectionFilter: true, enableI18N: true, enableIntrospection: true, enableLlm: true, enableLtree: true, enableManyToMany: true, enablePostgis: true, enablePresignedUploads: true, enableRealtime: true, enableSearch: true, id: true, idleInTransactionTimeoutMs: true, labels: true, lockTimeoutMs: true, maxConcurrentRequests: true, maxPageSize: true, maxQueryCost: true, maxQueryDepth: true, maxQueueWaitMs: true, maxRequestBytes: true, options: true, rateLimitBurst: true, rateLimitRpm: true, statementTimeoutMs: true, updatedAt: true } },
});
// Get one databaseSetting
const { data: item } = useDatabaseSettingQuery({
id: '',
selection: { fields: { annotations: true, createdAt: true, creditsPerCent: true, databaseId: true, enableAggregates: true, enableBilling: true, enableBulk: true, enableConnectionFilter: true, enableI18N: true, enableIntrospection: true, enableLlm: true, enableLtree: true, enableManyToMany: true, enablePostgis: true, enablePresignedUploads: true, enableRealtime: true, enableSearch: true, id: true, idleInTransactionTimeoutMs: true, labels: true, lockTimeoutMs: true, maxConcurrentRequests: true, maxPageSize: true, maxQueryCost: true, maxQueryDepth: true, maxQueueWaitMs: true, maxRequestBytes: true, options: true, rateLimitBurst: true, rateLimitRpm: true, statementTimeoutMs: true, updatedAt: true } },
});
// Create a databaseSetting
const { mutate: create } = useCreateDatabaseSettingMutation({
selection: { fields: { id: true } },
});
create({ annotations: '', creditsPerCent: '', databaseId: '', enableAggregates: '', enableBilling: '', enableBulk: '', enableConnectionFilter: '', enableI18N: '', enableIntrospection: '', enableLlm: '', enableLtree: '', enableManyToMany: '', enablePostgis: '', enablePresignedUploads: '', enableRealtime: '', enableSearch: '', idleInTransactionTimeoutMs: '', labels: '', lockTimeoutMs: '', maxConcurrentRequests: '', maxPageSize: '', maxQueryCost: '', maxQueryDepth: '', maxQueueWaitMs: '', maxRequestBytes: '', options: '', rateLimitBurst: '', rateLimitRpm: '', statementTimeoutMs: '' });
```
### DatabaseTransfer
```typescript
// List all databaseTransfers
const { data, isLoading } = useDatabaseTransfersQuery({
selection: { fields: { completedAt: true, createdAt: true, databaseId: true, expiresAt: true, id: true, initiatedBy: true, notes: true, sourceApproved: true, sourceApprovedAt: true, status: true, targetApproved: true, targetApprovedAt: true, targetOwnerId: true, updatedAt: true } },
});
// Get one databaseTransfer
const { data: item } = useDatabaseTransferQuery({
id: '',
selection: { fields: { completedAt: true, createdAt: true, databaseId: true, expiresAt: true, id: true, initiatedBy: true, notes: true, sourceApproved: true, sourceApprovedAt: true, status: true, targetApproved: true, targetApprovedAt: true, targetOwnerId: true, updatedAt: true } },
});
// Create a databaseTransfer
const { mutate: create } = useCreateDatabaseTransferMutation({
selection: { fields: { id: true } },
});
create({ completedAt: '', databaseId: '', expiresAt: '', initiatedBy: '', notes: '', sourceApproved: '', sourceApprovedAt: '', status: '', targetApproved: '', targetApprovedAt: '', targetOwnerId: '' });
```
### DefaultPrivilege
```typescript
// List all defaultPrivileges
const { data, isLoading } = useDefaultPrivilegesQuery({
selection: { fields: { databaseId: true, granteeName: true, id: true, isGrant: true, objectType: true, privilege: true, schemaId: true } },
});
// Get one defaultPrivilege
const { data: item } = useDefaultPrivilegeQuery({
id: '',
selection: { fields: { databaseId: true, granteeName: true, id: true, isGrant: true, objectType: true, privilege: true, schemaId: true } },
});
// Create a defaultPrivilege
const { mutate: create } = useCreateDefaultPrivilegeMutation({
selection: { fields: { id: true } },
});
create({ databaseId: '', granteeName: '', isGrant: '', objectType: '', privilege: '', schemaId: '' });
```
### Derive
```typescript
// List all derives
const { data, isLoading } = useDerivesQuery({
selection: { fields: { createdAt: true, databaseId: true, id: true, includeGrants: true, includeMutations: true, kind: true, policyPrefix: true, sourceTableId: true, tableId: true, updatedAt: true } },
});
// Get one derive
const { data: item } = useDeriveQuery({
id: '',
selection: { fields: { createdAt: true, databaseId: true, id: true, includeGrants: true, includeMutations: true, kind: true, policyPrefix: true, sourceTableId: true, tableId: true, updatedAt: true } },
});
// Create a derive
const { mutate: create } = useCreateDeriveMutation({
selection: { fields: { id: true } },
});
create({ databaseId: '', includeGrants: '', includeMutations: '', kind: '', policyPrefix: '', sourceTableId: '', tableId: '' });
```
### Domain
```typescript
// List all domains
const { data, isLoading } = useDomainsQuery({
selection: { fields: { config: true, createdAt: true, createdByPrincipal: true, databaseId: true, hostname: true, id: true, isPublished: true, isWildcard: true, managed: true, parentHostname: true, tlsReadyAt: true, tlsSecretName: true, tlsStatus: true, updatedAt: true, updatedByPrincipal: true, verificationStatus: true, verifiedAt: true } },
});
// Get one domain
const { data: item } = useDomainQuery({
id: '',
selection: { fields: { config: true, createdAt: true, createdByPrincipal: true, databaseId: true, hostname: true, id: true, isPublished: true, isWildcard: true, managed: true, parentHostname: true, tlsReadyAt: true, tlsSecretName: true, tlsStatus: true, updatedAt: true, updatedByPrincipal: true, verificationStatus: true, verifiedAt: true } },
});
// Create a domain
const { mutate: create } = useCreateDomainMutation({
selection: { fields: { id: true } },
});
create({ config: '', createdByPrincipal: '', databaseId: '', hostname: '', isPublished: '', isWildcard: '', managed: '', parentHostname: '', tlsReadyAt: '', tlsSecretName: '', tlsStatus: '', updatedByPrincipal: '', verificationStatus: '', verifiedAt: '' });
```
### DomainEvent
```typescript
// List all domainEvents
const { data, isLoading } = useDomainEventsQuery({
selection: { fields: { actorId: true, createdAt: true, databaseId: true, domainId: true, domainVerificationId: true, eventType: true, id: true, managedDomainId: true, message: true, metadata: true, updatedAt: true } },
});
// Get one domainEvent
const { data: item } = useDomainEventQuery({
id: '',
selection: { fields: { actorId: true, createdAt: true, databaseId: true, domainId: true, domainVerificationId: true, eventType: true, id: true, managedDomainId: true, message: true, metadata: true, updatedAt: true } },
});
// Create a domainEvent
const { mutate: create } = useCreateDomainEventMutation({
selection: { fields: { id: true } },
});
create({ actorId: '', databaseId: '', domainId: '', domainVerificationId: '', eventType: '', managedDomainId: '', message: '', metadata: '' });
```
### DomainType
```typescript
// List all domainTypes
const { data, isLoading } = useDomainTypesQuery({
selection: { fields: { baseType: true, category: true, checkExpr: true, databaseId: true, defaultExpr: true, description: true, id: true, label: true, name: true, notNull: true, schemaId: true, smartTags: true, tags: true } },
});
// Get one domainType
const { data: item } = useDomainTypeQuery({
id: '',
selection: { fields: { baseType: true, category: true, checkExpr: true, databaseId: true, defaultExpr: true, description: true, id: true, label: true, name: true, notNull: true, schemaId: true, smartTags: true, tags: true } },
});
// Create a domainType
const { mutate: create } = useCreateDomainTypeMutation({
selection: { fields: { id: true } },
});
create({ baseType: '', category: '', checkExpr: '', databaseId: '', defaultExpr: '', description: '', label: '', name: '', notNull: '', schemaId: '', smartTags: '', tags: '' });
```
### DomainVerification
```typescript
// List all domainVerifications
const { data, isLoading } = useDomainVerificationsQuery({
selection: { fields: { attempts: true, createdAt: true, databaseId: true, domainId: true, error: true, expiresAt: true, id: true, lastCheckedAt: true, managedDomainId: true, method: true, recordName: true, recordType: true, recordValue: true, status: true, updatedAt: true, verifiedAt: true } },
});
// Get one domainVerification
const { data: item } = useDomainVerificationQuery({
id: '',
selection: { fields: { attempts: true, createdAt: true, databaseId: true, domainId: true, error: true, expiresAt: true, id: true, lastCheckedAt: true, managedDomainId: true, method: true, recordName: true, recordType: true, recordValue: true, status: true, updatedAt: true, verifiedAt: true } },
});
// Create a domainVerification
const { mutate: create } = useCreateDomainVerificationMutation({
selection: { fields: { id: true } },
});
create({ attempts: '', databaseId: '', domainId: '', error: '', expiresAt: '', lastCheckedAt: '', managedDomainId: '', method: '', recordName: '', recordType: '', recordValue: '', status: '', verifiedAt: '' });
```
### EmailIdentity
```typescript
// List all emailIdentities
const { data, isLoading } = useEmailIdentitiesQuery({
selection: { fields: { createdAt: true, databaseId: true, fromAddress: true, fromName: true, id: true, isActive: true, isDefault: true, name: true, providerAccountId: true, replyToAddress: true, supportAddress: true, transportMode: true, updatedAt: true } },
});
// Get one emailIdentity
const { data: item } = useEmailIdentityQuery({
id: '',
selection: { fields: { createdAt: true, databaseId: true, fromAddress: true, fromName: true, id: true, isActive: true, isDefault: true, name: true, providerAccountId: true, replyToAddress: true, supportAddress: true, transportMode: true, updatedAt: true } },
});
// Create a emailIdentity
const { mutate: create } = useCreateEmailIdentityMutation({
selection: { fields: { id: true } },
});
create({ databaseId: '', fromAddress: '', fromName: '', isActive: '', isDefault: '', name: '', providerAccountId: '', replyToAddress: '', supportAddress: '', transportMode: '' });
```
### EmailProviderAccount
```typescript
// List all emailProviderAccounts
const { data, isLoading } = useEmailProviderAccountsQuery({
selection: { fields: { createdAt: true, credentialsSecretName: true, databaseId: true, id: true, isActive: true, name: true, provider: true, providerAccountName: true, region: true, smtpHost: true, smtpPort: true, smtpSecure: true, smtpUser: true, updatedAt: true, webhookSigningSecretName: true } },
});
// Get one emailProviderAccount
const { data: item } = useEmailProviderAccountQuery({
id: '',
selection: { fields: { createdAt: true, credentialsSecretName: true, databaseId: true, id: true, isActive: true, name: true, provider: true, providerAccountName: true, region: true, smtpHost: true, smtpPort: true, smtpSecure: true, smtpUser: true, updatedAt: true, webhookSigningSecretName: true } },
});
// Create a emailProviderAccount
const { mutate: create } = useCreateEmailProviderAccountMutation({
selection: { fields: { id: true } },
});
create({ credentialsSecretName: '', databaseId: '', isActive: '', name: '', provider: '', providerAccountName: '', region: '', smtpHost: '', smtpPort: '', smtpSecure: '', smtpUser: '', webhookSigningSecretName: '' });
```
### EmailSiteIdentity
```typescript
// List all emailSiteIdentities
const { data, isLoading } = useEmailSiteIdentitiesQuery({
selection: { fields: { createdAt: true, databaseId: true, emailIdentityId: true, id: true, siteId: true, updatedAt: true } },
});
// Get one emailSiteIdentity
const { data: item } = useEmailSiteIdentityQuery({
id: '',
selection: { fields: { createdAt: true, databaseId: true, emailIdentityId: true, id: true, siteId: true, updatedAt: true } },
});
// Create a emailSiteIdentity
const { mutate: create } = useCreateEmailSiteIdentityMutation({
selection: { fields: { id: true } },
});
create({ databaseId: '', emailIdentityId: '', siteId: '' });
```
### EmbeddingChunk
```typescript
// List all embeddingChunks
const { data, isLoading } = useEmbeddingChunksQuery({
selection: { fields: { chunkOverlap: true, chunkSize: true, chunkStrategy: true, chunkingTaskName: true, chunksTableId: true, chunksTableName: true, contentFieldName: true, createdAt: true, databaseId: true, dimensions: true, embeddingFieldId: true, embeddingModel: true, embeddingProvider: true, enqueueChunkingJob: true, id: true, metadataFields: true, metric: true, parentFkFieldId: true, searchIndexes: true, sourceFields: true, tableId: true, updatedAt: true } },
});
// Get one embeddingChunk
const { data: item } = useEmbeddingChunkQuery({
id: '',
selection: { fields: { chunkOverlap: true, chunkSize: true, chunkStrategy: true, chunkingTaskName: true, chunksTableId: true, chunksTableName: true, contentFieldName: true, createdAt: true, databaseId: true, dimensions: true, embeddingFieldId: true, embeddingModel: true, embeddingProvider: true, enqueueChunkingJob: true, id: true, metadataFields: true, metric: true, parentFkFieldId: true, searchIndexes: true, sourceFields: true, tableId: true, updatedAt: true } },
});
// Create a embeddingChunk
const { mutate: create } = useCreateEmbeddingChunkMutation({
selection: { fields: { id: true } },
});
create({ chunkOverlap: '', chunkSize: '', chunkStrategy: '', chunkingTaskName: '', chunksTableId: '', chunksTableName: '', contentFieldName: '', databaseId: '', dimensions: '', embeddingFieldId: '', embeddingModel: '', embeddingProvider: '', enqueueChunkingJob: '', metadataFields: '', metric: '', parentFkFieldId: '', searchIndexes: '', sourceFields: '', tableId: '' });
```
### Enum
```typescript
// List all enums
const { data, isLoading } = useEnumsQuery({
selection: { fields: { category: true, databaseId: true, description: true, id: true, label: true, name: true, schemaId: true, smartTags: true, tags: true, values: true } },
});
// Get one enum
const { data: item } = useEnumQuery({
id: '',
selection: { fields: { category: true, databaseId: true, description: true, id: true, label: true, name: true, schemaId: true, smartTags: true, tags: true, values: true } },
});
// Create a enum
const { mutate: create } = useCreateEnumMutation({
selection: { fields: { id: true } },
});
create({ category: '', databaseId: '', description: '', label: '', name: '', schemaId: '', smartTags: '', tags: '', values: '' });
```
### ExclusionConstraint
```typescript
// List all exclusionConstraints
const { data, isLoading } = useExclusionConstraintsQuery({
selection: { fields: { accessMethod: true, category: true, createdAt: true, databaseId: true, elementExpr: true, fieldIds: true, id: true, name: true, operators: true, smartTags: true, tableId: true, tags: true, type: true, updatedAt: true, whereClause: true } },
});
// Get one exclusionConstraint
const { data: item } = useExclusionConstraintQuery({
id: '',
selection: { fields: { accessMethod: true, category: true, createdAt: true, databaseId: true, elementExpr: true, fieldIds: true, id: true, name: true, operators: true, smartTags: true, tableId: true, tags: true, type: true, updatedAt: true, whereClause: true } },
});
// Create a exclusionConstraint
const { mutate: create } = useCreateExclusionConstraintMutation({
selection: { fields: { id: true } },
});
create({ accessMethod: '', category: '', databaseId: '', elementExpr: '', fieldIds: '', name: '', operators: '', smartTags: '', tableId: '', tags: '', type: '', whereClause: '' });
```
### FieldBehavior
```typescript
// List all fieldBehaviors
const { data, isLoading } = useFieldBehaviorsQuery({
selection: { fields: { createdAt: true, databaseId: true, fieldId: true, id: true, modifier: true, scope: true, sortOrder: true, updatedAt: true } },
});
// Get one fieldBehavior
const { data: item } = useFieldBehaviorQuery({
id: '',
selection: { fields: { createdAt: true, databaseId: true, fieldId: true, id: true, modifier: true, scope: true, sortOrder: true, updatedAt: true } },
});
// Create a fieldBehavior
const { mutate: create } = useCreateFieldBehaviorMutation({
selection: { fields: { id: true } },
});
create({ databaseId: '', fieldId: '', modifier: '