Skip to content

Latest commit

 

History

History
4474 lines (3540 loc) · 126 KB

File metadata and controls

4474 lines (3540 loc) · 126 KB

csdk CLI

Setup

# Create a context pointing at your GraphQL endpoint
csdk context create production --endpoint https://api.example.com/graphql

# Set the active context
csdk context use production

# Authenticate
csdk auth set-token <your-token>

Commands

Command Description
context Manage API contexts (endpoints)
auth Manage authentication tokens
config Manage config key-value store (per-context)
org-get-managers-record orgGetManagersRecord CRUD operations
org-get-subordinates-record orgGetSubordinatesRecord CRUD operations
get-all-record getAllRecord CRUD operations
object object CRUD operations
app-permission appPermission CRUD operations
org-permission orgPermission CRUD operations
app-level-requirement appLevelRequirement CRUD operations
database database CRUD operations
schema schema CRUD operations
table table CRUD operations
check-constraint checkConstraint CRUD operations
field field CRUD operations
foreign-key-constraint foreignKeyConstraint CRUD operations
full-text-search fullTextSearch CRUD operations
index index CRUD operations
policy policy CRUD operations
primary-key-constraint primaryKeyConstraint CRUD operations
table-grant tableGrant CRUD operations
trigger trigger CRUD operations
unique-constraint uniqueConstraint CRUD operations
view view CRUD operations
view-table viewTable CRUD operations
view-grant viewGrant CRUD operations
view-rule viewRule CRUD operations
embedding-chunk embeddingChunk CRUD operations
table-template-module tableTemplateModule CRUD operations
secure-table-provision secureTableProvision CRUD operations
relation-provision relationProvision CRUD operations
schema-grant schemaGrant CRUD operations
default-privilege defaultPrivilege CRUD operations
enum enum CRUD operations
api-schema apiSchema CRUD operations
api-module apiModule CRUD operations
domain domain CRUD operations
site-metadatum siteMetadatum CRUD operations
site-module siteModule CRUD operations
site-theme siteTheme CRUD operations
trigger-function triggerFunction CRUD operations
database-transfer databaseTransfer CRUD operations
api api CRUD operations
site site CRUD operations
app app CRUD operations
connected-accounts-module connectedAccountsModule CRUD operations
crypto-addresses-module cryptoAddressesModule CRUD operations
crypto-auth-module cryptoAuthModule CRUD operations
default-ids-module defaultIdsModule CRUD operations
denormalized-table-field denormalizedTableField CRUD operations
emails-module emailsModule CRUD operations
encrypted-secrets-module encryptedSecretsModule CRUD operations
invites-module invitesModule CRUD operations
levels-module levelsModule CRUD operations
limits-module limitsModule CRUD operations
membership-types-module membershipTypesModule CRUD operations
memberships-module membershipsModule CRUD operations
permissions-module permissionsModule CRUD operations
phone-numbers-module phoneNumbersModule CRUD operations
profiles-module profilesModule CRUD operations
secrets-module secretsModule CRUD operations
sessions-module sessionsModule CRUD operations
user-auth-module userAuthModule CRUD operations
users-module usersModule CRUD operations
blueprint blueprint CRUD operations
blueprint-template blueprintTemplate CRUD operations
blueprint-construction blueprintConstruction CRUD operations
storage-module storageModule CRUD operations
database-provision-module databaseProvisionModule CRUD operations
app-admin-grant appAdminGrant CRUD operations
app-owner-grant appOwnerGrant CRUD operations
app-grant appGrant CRUD operations
org-membership orgMembership CRUD operations
org-member orgMember CRUD operations
org-admin-grant orgAdminGrant CRUD operations
org-owner-grant orgOwnerGrant CRUD operations
org-grant orgGrant CRUD operations
org-chart-edge orgChartEdge CRUD operations
org-chart-edge-grant orgChartEdgeGrant CRUD operations
org-permission-default orgPermissionDefault CRUD operations
app-limit appLimit CRUD operations
org-limit orgLimit CRUD operations
app-step appStep CRUD operations
app-achievement appAchievement CRUD operations
app-level appLevel CRUD operations
email email CRUD operations
phone-number phoneNumber CRUD operations
crypto-address cryptoAddress CRUD operations
connected-account connectedAccount CRUD operations
invite invite CRUD operations
claimed-invite claimedInvite CRUD operations
org-invite orgInvite CRUD operations
org-claimed-invite orgClaimedInvite CRUD operations
audit-log auditLog CRUD operations
app-permission-default appPermissionDefault CRUD operations
ref ref CRUD operations
store store CRUD operations
role-type roleType CRUD operations
migrate-file migrateFile CRUD operations
app-limit-default appLimitDefault CRUD operations
org-limit-default orgLimitDefault CRUD operations
membership-type membershipType CRUD operations
app-membership-default appMembershipDefault CRUD operations
commit commit CRUD operations
org-membership-default orgMembershipDefault CRUD operations
rls-module rlsModule CRUD operations
sql-action sqlAction CRUD operations
user user CRUD operations
ast-migration astMigration CRUD operations
app-membership appMembership CRUD operations
hierarchy-module hierarchyModule CRUD operations
current-user-id currentUserId
current-ip-address currentIpAddress
current-user-agent currentUserAgent
app-permissions-get-padded-mask appPermissionsGetPaddedMask
org-permissions-get-padded-mask orgPermissionsGetPaddedMask
steps-achieved stepsAchieved
rev-parse revParse
org-is-manager-of orgIsManagerOf
app-permissions-get-mask appPermissionsGetMask
org-permissions-get-mask orgPermissionsGetMask
resolve-blueprint-table Resolves a table_name (with optional schema_name) to a table_id. Resolution order: (1) if schema_name provided, exact lookup via metaschema_public.schema.name + metaschema_public.table; (2) check local table_map (tables created in current blueprint); (3) search metaschema_public.table by name across all schemas; (4) if multiple matches, throw ambiguous error asking for schema_name; (5) if no match, throw not-found error.
app-permissions-get-mask-by-names appPermissionsGetMaskByNames
org-permissions-get-mask-by-names orgPermissionsGetMaskByNames
get-all-objects-from-root Reads and enables pagination through a set of Object.
get-path-objects-from-root Reads and enables pagination through a set of Object.
get-object-at-path getObjectAtPath
app-permissions-get-by-mask Reads and enables pagination through a set of AppPermission.
org-permissions-get-by-mask Reads and enables pagination through a set of OrgPermission.
steps-required Reads and enables pagination through a set of AppLevelRequirement.
current-user currentUser
send-account-deletion-email sendAccountDeletionEmail
sign-out signOut
accept-database-transfer acceptDatabaseTransfer
cancel-database-transfer cancelDatabaseTransfer
reject-database-transfer rejectDatabaseTransfer
submit-invite-code submitInviteCode
submit-org-invite-code submitOrgInviteCode
check-password checkPassword
confirm-delete-account confirmDeleteAccount
set-password setPassword
verify-email verifyEmail
freeze-objects freezeObjects
init-empty-repo initEmptyRepo
construct-blueprint Executes a blueprint definition by delegating to provision_* procedures. Creates a blueprint_construction record to track the attempt. Five phases: (1) provision_table() for each table with all nodes[], fields[], policies[], grants, and table-level indexes/fts/unique_constraints in a single call, (2) provision_relation() for each relation, (3) provision_index() for top-level indexes, (4) provision_full_text_search() for top-level FTS, (5) provision_unique_constraint() for top-level unique constraints. Tables are identified by table_name with optional per-table schema_name. Relations use $type for relation_type with source_table/target_table. Returns the construction record ID on success, NULL on failure.
reset-password resetPassword
remove-node-at-path removeNodeAtPath
copy-template-to-blueprint Creates a new blueprint by copying a template definition. Checks visibility: owners can always copy their own templates, others require public visibility. Increments the template copy_count. Returns the new blueprint ID.
bootstrap-user bootstrapUser
set-field-order setFieldOrder
provision-unique-constraint Creates a unique constraint on a table. Accepts a jsonb definition with columns (array of field names). Graceful: skips if the exact same unique constraint already exists.
provision-full-text-search Creates a full-text search configuration on a table. Accepts a jsonb definition with field (tsvector column name) and sources (array of {field, weight, lang}). Graceful: skips if FTS config already exists for the same (table_id, field_id). Returns the fts_id.
provision-index Creates an index on a table. Accepts a jsonb definition with columns (array of names or single column string), access_method (default BTREE), is_unique, op_classes, options, and name (auto-generated if omitted). Graceful: skips if an index with the same (table_id, field_ids, access_method) already exists. Returns the index_id.
set-data-at-path setDataAtPath
set-props-and-commit setPropsAndCommit
provision-database-with-user provisionDatabaseWithUser
insert-node-at-path insertNodeAtPath
update-node-at-path updateNodeAtPath
set-and-commit setAndCommit
provision-relation Composable relation provisioning: creates FK fields, indexes, unique constraints, and junction tables depending on the relation_type. Supports RelationBelongsTo, RelationHasOne, RelationHasMany, and RelationManyToMany. ManyToMany uses provision_table() internally for junction table creation with full node/grant/policy support. All operations are graceful (skip existing). Returns (out_field_id, out_junction_table_id, out_source_field_id, out_target_field_id).
apply-rls applyRls
sign-in-one-time-token signInOneTimeToken
create-user-database Creates a new user database with all required modules, permissions, and RLS policies.

Parameters:

  • database_name: Name for the new database (required)
  • owner_id: UUID of the owner user (required)
  • include_invites: Include invite system (default: true)
  • include_groups: Include group-level memberships (default: false)
  • include_levels: Include levels/achievements (default: false)
  • bitlen: Bit length for permission masks (default: 64)
  • tokens_expiration: Token expiration interval (default: 30 days)

Returns the database_id UUID of the newly created database.

Example usage: SELECT metaschema_public.create_user_database('my_app', 'a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11'::uuid); SELECT metaschema_public.create_user_database('my_app', 'a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11'::uuid, true, true); -- with invites and groups | | extend-token-expires | extendTokenExpires | | sign-in | signIn | | sign-up | signUp | | one-time-token | oneTimeToken | | provision-table | Composable table provisioning: creates or finds a table, then creates fields (so Data* modules can reference them), applies N nodes (Data* modules), enables RLS, creates grants, creates N policies, and optionally creates table-level indexes/full_text_searches/unique_constraints. All operations are graceful (skip existing). Accepts multiple nodes and multiple policies per call, unlike secure_table_provision which is limited to one of each. Returns (out_table_id, out_fields). | | send-verification-email | sendVerificationEmail | | forgot-password | forgotPassword | | verify-password | verifyPassword | | verify-totp | verifyTotp |

Infrastructure Commands

context

Manage named API contexts (kubectl-style).

Subcommand Description
create <name> --endpoint <url> Create a new context
list List all contexts
use <name> Set the active context
current Show current context
delete <name> Delete a context

Configuration is stored at ~/.csdk/config/.

auth

Manage authentication tokens per context.

Subcommand Description
set-token <token> Store bearer token for current context
status Show auth status across all contexts
logout Remove credentials for current context

config

Manage per-context key-value configuration variables.

Subcommand Description
get <key> Get a config value
set <key> <value> Set a config value
list List all config values
delete <key> Delete a config value

Variables are scoped to the active context and stored at ~/.csdk/config/.

Table Commands

org-get-managers-record

CRUD operations for OrgGetManagersRecord records.

Subcommand Description
list List all orgGetManagersRecord records
find-first Find first matching orgGetManagersRecord record
get Get a orgGetManagersRecord by id
create Create a new orgGetManagersRecord
update Update an existing orgGetManagersRecord
delete Delete a orgGetManagersRecord

Fields:

Field Type
userId UUID
depth Int

Required create fields: userId, depth

org-get-subordinates-record

CRUD operations for OrgGetSubordinatesRecord records.

Subcommand Description
list List all orgGetSubordinatesRecord records
find-first Find first matching orgGetSubordinatesRecord record
get Get a orgGetSubordinatesRecord by id
create Create a new orgGetSubordinatesRecord
update Update an existing orgGetSubordinatesRecord
delete Delete a orgGetSubordinatesRecord

Fields:

Field Type
userId UUID
depth Int

Required create fields: userId, depth

get-all-record

CRUD operations for GetAllRecord records.

Subcommand Description
list List all getAllRecord records
find-first Find first matching getAllRecord record
get Get a getAllRecord by id
create Create a new getAllRecord
update Update an existing getAllRecord
delete Delete a getAllRecord

Fields:

Field Type
path String
data JSON

Required create fields: path, data

object

CRUD operations for Object records.

Subcommand Description
list List all object records
find-first Find first matching object record
get Get a object by id
create Create a new object
update Update an existing object
delete Delete a object

Fields:

Field Type
hashUuid UUID
id UUID
databaseId UUID
kids UUID
ktree String
data JSON
frzn Boolean
createdAt Datetime

Required create fields: databaseId Optional create fields (backend defaults): kids, ktree, data, frzn

app-permission

CRUD operations for AppPermission records.

Subcommand Description
list List all appPermission records
find-first Find first matching appPermission record
get Get a appPermission by id
create Create a new appPermission
update Update an existing appPermission
delete Delete a appPermission

Fields:

Field Type
id UUID
name String
bitnum Int
bitstr BitString
description String

Optional create fields (backend defaults): name, bitnum, bitstr, description

org-permission

CRUD operations for OrgPermission records.

Subcommand Description
list List all orgPermission records
find-first Find first matching orgPermission record
get Get a orgPermission by id
create Create a new orgPermission
update Update an existing orgPermission
delete Delete a orgPermission

Fields:

Field Type
id UUID
name String
bitnum Int
bitstr BitString
description String

Optional create fields (backend defaults): name, bitnum, bitstr, description

app-level-requirement

CRUD operations for AppLevelRequirement records.

Subcommand Description
list List all appLevelRequirement records
find-first Find first matching appLevelRequirement record
get Get a appLevelRequirement by id
create Create a new appLevelRequirement
update Update an existing appLevelRequirement
delete Delete a appLevelRequirement

Fields:

Field Type
id UUID
name String
level String
description String
requiredCount Int
priority Int
createdAt Datetime
updatedAt Datetime

Required create fields: name, level Optional create fields (backend defaults): description, requiredCount, priority

database

CRUD operations for Database records.

Subcommand Description
list List all database records
find-first Find first matching database record
get Get a database by id
create Create a new database
update Update an existing database
delete Delete a database

Fields:

Field Type
id UUID
ownerId UUID
schemaHash String
name String
label String
hash UUID
createdAt Datetime
updatedAt Datetime

Optional create fields (backend defaults): ownerId, schemaHash, name, label, hash

schema

CRUD operations for Schema records.

Subcommand Description
list List all schema records
find-first Find first matching schema record
get Get a schema by id
create Create a new schema
update Update an existing schema
delete Delete a schema

Fields:

Field Type
id UUID
databaseId UUID
name String
schemaName String
label String
description String
smartTags JSON
category ObjectCategory
module String
scope Int
tags String
isPublic Boolean
createdAt Datetime
updatedAt Datetime

Required create fields: databaseId, name, schemaName Optional create fields (backend defaults): label, description, smartTags, category, module, scope, tags, isPublic

table

CRUD operations for Table records.

Subcommand Description
list List all table records
find-first Find first matching table record
get Get a table by id
create Create a new table
update Update an existing table
delete Delete a table

Fields:

Field Type
id UUID
databaseId UUID
schemaId UUID
name String
label String
description String
smartTags JSON
category ObjectCategory
module String
scope Int
useRls Boolean
timestamps Boolean
peoplestamps Boolean
pluralName String
singularName String
tags String
inheritsId UUID
createdAt Datetime
updatedAt Datetime

Required create fields: schemaId, name Optional create fields (backend defaults): databaseId, label, description, smartTags, category, module, scope, useRls, timestamps, peoplestamps, pluralName, singularName, tags, inheritsId

check-constraint

CRUD operations for CheckConstraint records.

Subcommand Description
list List all checkConstraint records
find-first Find first matching checkConstraint record
get Get a checkConstraint by id
create Create a new checkConstraint
update Update an existing checkConstraint
delete Delete a checkConstraint

Fields:

Field Type
id UUID
databaseId UUID
tableId UUID
name String
type String
fieldIds UUID
expr JSON
smartTags JSON
category ObjectCategory
module String
scope Int
tags String
createdAt Datetime
updatedAt Datetime

Required create fields: tableId, fieldIds Optional create fields (backend defaults): databaseId, name, type, expr, smartTags, category, module, scope, tags

field

CRUD operations for Field records.

Subcommand Description
list List all field records
find-first Find first matching field record
get Get a field by id
create Create a new field
update Update an existing field
delete Delete a field

Fields:

Field Type
id UUID
databaseId UUID
tableId UUID
name String
label String
description String
smartTags JSON
isRequired Boolean
apiRequired Boolean
defaultValue String
defaultValueAst JSON
type String
fieldOrder Int
regexp String
chk JSON
chkExpr JSON
min Float
max Float
tags String
category ObjectCategory
module String
scope Int
createdAt Datetime
updatedAt Datetime

Required create fields: tableId, name, type Optional create fields (backend defaults): databaseId, label, description, smartTags, isRequired, apiRequired, defaultValue, defaultValueAst, fieldOrder, regexp, chk, chkExpr, min, max, tags, category, module, scope

foreign-key-constraint

CRUD operations for ForeignKeyConstraint records.

Subcommand Description
list List all foreignKeyConstraint records
find-first Find first matching foreignKeyConstraint record
get Get a foreignKeyConstraint by id
create Create a new foreignKeyConstraint
update Update an existing foreignKeyConstraint
delete Delete a foreignKeyConstraint

Fields:

Field Type
id UUID
databaseId UUID
tableId UUID
name String
description String
smartTags JSON
type String
fieldIds UUID
refTableId UUID
refFieldIds UUID
deleteAction String
updateAction String
category ObjectCategory
module String
scope Int
tags String
createdAt Datetime
updatedAt Datetime

Required create fields: tableId, fieldIds, refTableId, refFieldIds Optional create fields (backend defaults): databaseId, name, description, smartTags, type, deleteAction, updateAction, category, module, scope, tags

full-text-search

CRUD operations for FullTextSearch records.

Subcommand Description
list List all fullTextSearch records
find-first Find first matching fullTextSearch record
get Get a fullTextSearch by id
create Create a new fullTextSearch
update Update an existing fullTextSearch
delete Delete a fullTextSearch

Fields:

Field Type
id UUID
databaseId UUID
tableId UUID
fieldId UUID
fieldIds UUID
weights String
langs String
createdAt Datetime
updatedAt Datetime

Required create fields: tableId, fieldId, fieldIds, weights, langs Optional create fields (backend defaults): databaseId

index

CRUD operations for Index records.

Subcommand Description
list List all index records
find-first Find first matching index record
get Get a index by id
create Create a new index
update Update an existing index
delete Delete a index

Fields:

Field Type
id UUID
databaseId UUID
tableId UUID
name String
fieldIds UUID
includeFieldIds UUID
accessMethod String
indexParams JSON
whereClause JSON
isUnique Boolean
options JSON
opClasses String
smartTags JSON
category ObjectCategory
module String
scope Int
tags String
createdAt Datetime
updatedAt Datetime

Required create fields: databaseId, tableId Optional create fields (backend defaults): name, fieldIds, includeFieldIds, accessMethod, indexParams, whereClause, isUnique, options, opClasses, smartTags, category, module, scope, tags

policy

CRUD operations for Policy records.

Subcommand Description
list List all policy records
find-first Find first matching policy record
get Get a policy by id
create Create a new policy
update Update an existing policy
delete Delete a policy

Fields:

Field Type
id UUID
databaseId UUID
tableId UUID
name String
granteeName String
privilege String
permissive Boolean
disabled Boolean
policyType String
data JSON
smartTags JSON
category ObjectCategory
module String
scope Int
tags String
createdAt Datetime
updatedAt Datetime

Required create fields: tableId Optional create fields (backend defaults): databaseId, name, granteeName, privilege, permissive, disabled, policyType, data, smartTags, category, module, scope, tags

primary-key-constraint

CRUD operations for PrimaryKeyConstraint records.

Subcommand Description
list List all primaryKeyConstraint records
find-first Find first matching primaryKeyConstraint record
get Get a primaryKeyConstraint by id
create Create a new primaryKeyConstraint
update Update an existing primaryKeyConstraint
delete Delete a primaryKeyConstraint

Fields:

Field Type
id UUID
databaseId UUID
tableId UUID
name String
type String
fieldIds UUID
smartTags JSON
category ObjectCategory
module String
scope Int
tags String
createdAt Datetime
updatedAt Datetime

Required create fields: tableId, fieldIds Optional create fields (backend defaults): databaseId, name, type, smartTags, category, module, scope, tags

table-grant

CRUD operations for TableGrant records.

Subcommand Description
list List all tableGrant records
find-first Find first matching tableGrant record
get Get a tableGrant by id
create Create a new tableGrant
update Update an existing tableGrant
delete Delete a tableGrant

Fields:

Field Type
id UUID
databaseId UUID
tableId UUID
privilege String
granteeName String
fieldIds UUID
isGrant Boolean
createdAt Datetime
updatedAt Datetime

Required create fields: tableId, privilege, granteeName Optional create fields (backend defaults): databaseId, fieldIds, isGrant

trigger

CRUD operations for Trigger records.

Subcommand Description
list List all trigger records
find-first Find first matching trigger record
get Get a trigger by id
create Create a new trigger
update Update an existing trigger
delete Delete a trigger

Fields:

Field Type
id UUID
databaseId UUID
tableId UUID
name String
event String
functionName String
smartTags JSON
category ObjectCategory
module String
scope Int
tags String
createdAt Datetime
updatedAt Datetime

Required create fields: tableId, name Optional create fields (backend defaults): databaseId, event, functionName, smartTags, category, module, scope, tags

unique-constraint

CRUD operations for UniqueConstraint records.

Subcommand Description
list List all uniqueConstraint records
find-first Find first matching uniqueConstraint record
get Get a uniqueConstraint by id
create Create a new uniqueConstraint
update Update an existing uniqueConstraint
delete Delete a uniqueConstraint

Fields:

Field Type
id UUID
databaseId UUID
tableId UUID
name String
description String
smartTags JSON
type String
fieldIds UUID
category ObjectCategory
module String
scope Int
tags String
createdAt Datetime
updatedAt Datetime

Required create fields: tableId, fieldIds Optional create fields (backend defaults): databaseId, name, description, smartTags, type, category, module, scope, tags

view

CRUD operations for View records.

Subcommand Description
list List all view records
find-first Find first matching view record
get Get a view by id
create Create a new view
update Update an existing view
delete Delete a view

Fields:

Field Type
id UUID
databaseId UUID
schemaId UUID
name String
tableId UUID
viewType String
data JSON
filterType String
filterData JSON
securityInvoker Boolean
isReadOnly Boolean
smartTags JSON
category ObjectCategory
module String
scope Int
tags String

Required create fields: schemaId, name, viewType Optional create fields (backend defaults): databaseId, tableId, data, filterType, filterData, securityInvoker, isReadOnly, smartTags, category, module, scope, tags

view-table

CRUD operations for ViewTable records.

Subcommand Description
list List all viewTable records
find-first Find first matching viewTable record
get Get a viewTable by id
create Create a new viewTable
update Update an existing viewTable
delete Delete a viewTable

Fields:

Field Type
id UUID
viewId UUID
tableId UUID
joinOrder Int

Required create fields: viewId, tableId Optional create fields (backend defaults): joinOrder

view-grant

CRUD operations for ViewGrant records.

Subcommand Description
list List all viewGrant records
find-first Find first matching viewGrant record
get Get a viewGrant by id
create Create a new viewGrant
update Update an existing viewGrant
delete Delete a viewGrant

Fields:

Field Type
id UUID
databaseId UUID
viewId UUID
granteeName String
privilege String
withGrantOption Boolean
isGrant Boolean

Required create fields: viewId, granteeName, privilege Optional create fields (backend defaults): databaseId, withGrantOption, isGrant

view-rule

CRUD operations for ViewRule records.

Subcommand Description
list List all viewRule records
find-first Find first matching viewRule record
get Get a viewRule by id
create Create a new viewRule
update Update an existing viewRule
delete Delete a viewRule

Fields:

Field Type
id UUID
databaseId UUID
viewId UUID
name String
event String
action String

Required create fields: viewId, name, event Optional create fields (backend defaults): databaseId, action

embedding-chunk

CRUD operations for EmbeddingChunk records.

Subcommand Description
list List all embeddingChunk records
find-first Find first matching embeddingChunk record
get Get a embeddingChunk by id
create Create a new embeddingChunk
update Update an existing embeddingChunk
delete Delete a embeddingChunk

Fields:

Field Type
id UUID
databaseId UUID
tableId UUID
embeddingFieldId UUID
chunksTableId UUID
chunksTableName String
contentFieldName String
dimensions Int
metric String
chunkSize Int
chunkOverlap Int
chunkStrategy String
metadataFields JSON
enqueueChunkingJob Boolean
chunkingTaskName String
parentFkFieldId UUID
createdAt Datetime
updatedAt Datetime

Required create fields: tableId Optional create fields (backend defaults): databaseId, embeddingFieldId, chunksTableId, chunksTableName, contentFieldName, dimensions, metric, chunkSize, chunkOverlap, chunkStrategy, metadataFields, enqueueChunkingJob, chunkingTaskName, parentFkFieldId

table-template-module

CRUD operations for TableTemplateModule records.

Subcommand Description
list List all tableTemplateModule records
find-first Find first matching tableTemplateModule record
get Get a tableTemplateModule by id
create Create a new tableTemplateModule
update Update an existing tableTemplateModule
delete Delete a tableTemplateModule

Fields:

Field Type
id UUID
databaseId UUID
schemaId UUID
privateSchemaId UUID
tableId UUID
ownerTableId UUID
tableName String
nodeType String
data JSON

Required create fields: databaseId, tableName, nodeType Optional create fields (backend defaults): schemaId, privateSchemaId, tableId, ownerTableId, data

secure-table-provision

CRUD operations for SecureTableProvision records.

Subcommand Description
list List all secureTableProvision records
find-first Find first matching secureTableProvision record
get Get a secureTableProvision by id
create Create a new secureTableProvision
update Update an existing secureTableProvision
delete Delete a secureTableProvision

Fields:

Field Type
id UUID
databaseId UUID
schemaId UUID
tableId UUID
tableName String
nodes JSON
useRls Boolean
fields JSON
grantRoles String
grantPrivileges JSON
policyType String
policyPrivileges String
policyRole String
policyPermissive Boolean
policyName String
policyData JSON
outFields UUID

Required create fields: databaseId Optional create fields (backend defaults): schemaId, tableId, tableName, nodes, useRls, fields, grantRoles, grantPrivileges, policyType, policyPrivileges, policyRole, policyPermissive, policyName, policyData, outFields

relation-provision

CRUD operations for RelationProvision records.

Subcommand Description
list List all relationProvision records
find-first Find first matching relationProvision record
get Get a relationProvision by id
create Create a new relationProvision
update Update an existing relationProvision
delete Delete a relationProvision

Fields:

Field Type
id UUID
databaseId UUID
relationType String
sourceTableId UUID
targetTableId UUID
fieldName String
deleteAction String
isRequired Boolean
apiRequired Boolean
junctionTableId UUID
junctionTableName String
junctionSchemaId UUID
sourceFieldName String
targetFieldName String
useCompositeKey Boolean
createIndex Boolean
exposeInApi Boolean
nodes JSON
grantRoles String
grantPrivileges JSON
policyType String
policyPrivileges String
policyRole String
policyPermissive Boolean
policyName String
policyData JSON
outFieldId UUID
outJunctionTableId UUID
outSourceFieldId UUID
outTargetFieldId UUID

Required create fields: databaseId, relationType, sourceTableId, targetTableId Optional create fields (backend defaults): fieldName, deleteAction, isRequired, apiRequired, junctionTableId, junctionTableName, junctionSchemaId, sourceFieldName, targetFieldName, useCompositeKey, createIndex, exposeInApi, nodes, grantRoles, grantPrivileges, policyType, policyPrivileges, policyRole, policyPermissive, policyName, policyData, outFieldId, outJunctionTableId, outSourceFieldId, outTargetFieldId

schema-grant

CRUD operations for SchemaGrant records.

Subcommand Description
list List all schemaGrant records
find-first Find first matching schemaGrant record
get Get a schemaGrant by id
create Create a new schemaGrant
update Update an existing schemaGrant
delete Delete a schemaGrant

Fields:

Field Type
id UUID
databaseId UUID
schemaId UUID
granteeName String
createdAt Datetime
updatedAt Datetime

Required create fields: schemaId, granteeName Optional create fields (backend defaults): databaseId

default-privilege

CRUD operations for DefaultPrivilege records.

Subcommand Description
list List all defaultPrivilege records
find-first Find first matching defaultPrivilege record
get Get a defaultPrivilege by id
create Create a new defaultPrivilege
update Update an existing defaultPrivilege
delete Delete a defaultPrivilege

Fields:

Field Type
id UUID
databaseId UUID
schemaId UUID
objectType String
privilege String
granteeName String
isGrant Boolean

Required create fields: schemaId, objectType, privilege, granteeName Optional create fields (backend defaults): databaseId, isGrant

enum

CRUD operations for Enum records.

Subcommand Description
list List all enum records
find-first Find first matching enum record
get Get a enum by id
create Create a new enum
update Update an existing enum
delete Delete a enum

Fields:

Field Type
id UUID
databaseId UUID
schemaId UUID
name String
label String
description String
values String
smartTags JSON
category ObjectCategory
module String
scope Int
tags String

Required create fields: databaseId, schemaId, name Optional create fields (backend defaults): label, description, values, smartTags, category, module, scope, tags

api-schema

CRUD operations for ApiSchema records.

Subcommand Description
list List all apiSchema records
find-first Find first matching apiSchema record
get Get a apiSchema by id
create Create a new apiSchema
update Update an existing apiSchema
delete Delete a apiSchema

Fields:

Field Type
id UUID
databaseId UUID
schemaId UUID
apiId UUID

Required create fields: databaseId, schemaId, apiId

api-module

CRUD operations for ApiModule records.

Subcommand Description
list List all apiModule records
find-first Find first matching apiModule record
get Get a apiModule by id
create Create a new apiModule
update Update an existing apiModule
delete Delete a apiModule

Fields:

Field Type
id UUID
databaseId UUID
apiId UUID
name String
data JSON

Required create fields: databaseId, apiId, name, data

domain

CRUD operations for Domain records.

Subcommand Description
list List all domain records
find-first Find first matching domain record
get Get a domain by id
create Create a new domain
update Update an existing domain
delete Delete a domain

Fields:

Field Type
id UUID
databaseId UUID
apiId UUID
siteId UUID
subdomain Hostname
domain Hostname

Required create fields: databaseId Optional create fields (backend defaults): apiId, siteId, subdomain, domain

site-metadatum

CRUD operations for SiteMetadatum records.

Subcommand Description
list List all siteMetadatum records
find-first Find first matching siteMetadatum record
get Get a siteMetadatum by id
create Create a new siteMetadatum
update Update an existing siteMetadatum
delete Delete a siteMetadatum

Fields:

Field Type
id UUID
databaseId UUID
siteId UUID
title String
description String
ogImage Image

Required create fields: databaseId, siteId Optional create fields (backend defaults): title, description, ogImage

site-module

CRUD operations for SiteModule records.

Subcommand Description
list List all siteModule records
find-first Find first matching siteModule record
get Get a siteModule by id
create Create a new siteModule
update Update an existing siteModule
delete Delete a siteModule

Fields:

Field Type
id UUID
databaseId UUID
siteId UUID
name String
data JSON

Required create fields: databaseId, siteId, name, data

site-theme

CRUD operations for SiteTheme records.

Subcommand Description
list List all siteTheme records
find-first Find first matching siteTheme record
get Get a siteTheme by id
create Create a new siteTheme
update Update an existing siteTheme
delete Delete a siteTheme

Fields:

Field Type
id UUID
databaseId UUID
siteId UUID
theme JSON

Required create fields: databaseId, siteId, theme

trigger-function

CRUD operations for TriggerFunction records.

Subcommand Description
list List all triggerFunction records
find-first Find first matching triggerFunction record
get Get a triggerFunction by id
create Create a new triggerFunction
update Update an existing triggerFunction
delete Delete a triggerFunction

Fields:

Field Type
id UUID
databaseId UUID
name String
code String
createdAt Datetime
updatedAt Datetime

Required create fields: databaseId, name Optional create fields (backend defaults): code

database-transfer

CRUD operations for DatabaseTransfer records.

Subcommand Description
list List all databaseTransfer records
find-first Find first matching databaseTransfer record
get Get a databaseTransfer by id
create Create a new databaseTransfer
update Update an existing databaseTransfer
delete Delete a databaseTransfer

Fields:

Field Type
id UUID
databaseId UUID
targetOwnerId UUID
sourceApproved Boolean
targetApproved Boolean
sourceApprovedAt Datetime
targetApprovedAt Datetime
status String
initiatedBy UUID
notes String
expiresAt Datetime
createdAt Datetime
updatedAt Datetime
completedAt Datetime

Required create fields: databaseId, targetOwnerId, initiatedBy Optional create fields (backend defaults): sourceApproved, targetApproved, sourceApprovedAt, targetApprovedAt, status, notes, expiresAt, completedAt

api

CRUD operations for Api records.

Subcommand Description
list List all api records
find-first Find first matching api record
get Get a api by id
create Create a new api
update Update an existing api
delete Delete a api

Fields:

Field Type
id UUID
databaseId UUID
name String
dbname String
roleName String
anonRole String
isPublic Boolean

Required create fields: databaseId, name Optional create fields (backend defaults): dbname, roleName, anonRole, isPublic

site

CRUD operations for Site records.

Subcommand Description
list List all site records
find-first Find first matching site record
get Get a site by id
create Create a new site
update Update an existing site
delete Delete a site

Fields:

Field Type
id UUID
databaseId UUID
title String
description String
ogImage Image
favicon Attachment
appleTouchIcon Image
logo Image
dbname String

Required create fields: databaseId Optional create fields (backend defaults): title, description, ogImage, favicon, appleTouchIcon, logo, dbname

app

CRUD operations for App records.

Subcommand Description
list List all app records
find-first Find first matching app record
get Get a app by id
create Create a new app
update Update an existing app
delete Delete a app

Fields:

Field Type
id UUID
databaseId UUID
siteId UUID
name String
appImage Image
appStoreLink Url
appStoreId String
appIdPrefix String
playStoreLink Url

Required create fields: databaseId, siteId Optional create fields (backend defaults): name, appImage, appStoreLink, appStoreId, appIdPrefix, playStoreLink

connected-accounts-module

CRUD operations for ConnectedAccountsModule records.

Subcommand Description
list List all connectedAccountsModule records
find-first Find first matching connectedAccountsModule record
get Get a connectedAccountsModule by id
create Create a new connectedAccountsModule
update Update an existing connectedAccountsModule
delete Delete a connectedAccountsModule

Fields:

Field Type
id UUID
databaseId UUID
schemaId UUID
privateSchemaId UUID
tableId UUID
ownerTableId UUID
tableName String

Required create fields: databaseId, tableName Optional create fields (backend defaults): schemaId, privateSchemaId, tableId, ownerTableId

crypto-addresses-module

CRUD operations for CryptoAddressesModule records.

Subcommand Description
list List all cryptoAddressesModule records
find-first Find first matching cryptoAddressesModule record
get Get a cryptoAddressesModule by id
create Create a new cryptoAddressesModule
update Update an existing cryptoAddressesModule
delete Delete a cryptoAddressesModule

Fields:

Field Type
id UUID
databaseId UUID
schemaId UUID
privateSchemaId UUID
tableId UUID
ownerTableId UUID
tableName String
cryptoNetwork String

Required create fields: databaseId, tableName Optional create fields (backend defaults): schemaId, privateSchemaId, tableId, ownerTableId, cryptoNetwork

crypto-auth-module

CRUD operations for CryptoAuthModule records.

Subcommand Description
list List all cryptoAuthModule records
find-first Find first matching cryptoAuthModule record
get Get a cryptoAuthModule by id
create Create a new cryptoAuthModule
update Update an existing cryptoAuthModule
delete Delete a cryptoAuthModule

Fields:

Field Type
id UUID
databaseId UUID
schemaId UUID
usersTableId UUID
secretsTableId UUID
sessionsTableId UUID
sessionCredentialsTableId UUID
addressesTableId UUID
userField String
cryptoNetwork String
signInRequestChallenge String
signInRecordFailure String
signUpWithKey String
signInWithChallenge String

Required create fields: databaseId, userField Optional create fields (backend defaults): schemaId, usersTableId, secretsTableId, sessionsTableId, sessionCredentialsTableId, addressesTableId, cryptoNetwork, signInRequestChallenge, signInRecordFailure, signUpWithKey, signInWithChallenge

default-ids-module

CRUD operations for DefaultIdsModule records.

Subcommand Description
list List all defaultIdsModule records
find-first Find first matching defaultIdsModule record
get Get a defaultIdsModule by id
create Create a new defaultIdsModule
update Update an existing defaultIdsModule
delete Delete a defaultIdsModule

Fields:

Field Type
id UUID
databaseId UUID

Required create fields: databaseId

denormalized-table-field

CRUD operations for DenormalizedTableField records.

Subcommand Description
list List all denormalizedTableField records
find-first Find first matching denormalizedTableField record
get Get a denormalizedTableField by id
create Create a new denormalizedTableField
update Update an existing denormalizedTableField
delete Delete a denormalizedTableField

Fields:

Field Type
id UUID
databaseId UUID
tableId UUID
fieldId UUID
setIds UUID
refTableId UUID
refFieldId UUID
refIds UUID
useUpdates Boolean
updateDefaults Boolean
funcName String
funcOrder Int

Required create fields: databaseId, tableId, fieldId, refTableId, refFieldId Optional create fields (backend defaults): setIds, refIds, useUpdates, updateDefaults, funcName, funcOrder

emails-module

CRUD operations for EmailsModule records.

Subcommand Description
list List all emailsModule records
find-first Find first matching emailsModule record
get Get a emailsModule by id
create Create a new emailsModule
update Update an existing emailsModule
delete Delete a emailsModule

Fields:

Field Type
id UUID
databaseId UUID
schemaId UUID
privateSchemaId UUID
tableId UUID
ownerTableId UUID
tableName String

Required create fields: databaseId, tableName Optional create fields (backend defaults): schemaId, privateSchemaId, tableId, ownerTableId

encrypted-secrets-module

CRUD operations for EncryptedSecretsModule records.

Subcommand Description
list List all encryptedSecretsModule records
find-first Find first matching encryptedSecretsModule record
get Get a encryptedSecretsModule by id
create Create a new encryptedSecretsModule
update Update an existing encryptedSecretsModule
delete Delete a encryptedSecretsModule

Fields:

Field Type
id UUID
databaseId UUID
schemaId UUID
tableId UUID
tableName String

Required create fields: databaseId Optional create fields (backend defaults): schemaId, tableId, tableName

invites-module

CRUD operations for InvitesModule records.

Subcommand Description
list List all invitesModule records
find-first Find first matching invitesModule record
get Get a invitesModule by id
create Create a new invitesModule
update Update an existing invitesModule
delete Delete a invitesModule

Fields:

Field Type
id UUID
databaseId UUID
schemaId UUID
privateSchemaId UUID
emailsTableId UUID
usersTableId UUID
invitesTableId UUID
claimedInvitesTableId UUID
invitesTableName String
claimedInvitesTableName String
submitInviteCodeFunction String
prefix String
membershipType Int
entityTableId UUID

Required create fields: databaseId, membershipType Optional create fields (backend defaults): schemaId, privateSchemaId, emailsTableId, usersTableId, invitesTableId, claimedInvitesTableId, invitesTableName, claimedInvitesTableName, submitInviteCodeFunction, prefix, entityTableId

levels-module

CRUD operations for LevelsModule records.

Subcommand Description
list List all levelsModule records
find-first Find first matching levelsModule record
get Get a levelsModule by id
create Create a new levelsModule
update Update an existing levelsModule
delete Delete a levelsModule

Fields:

Field Type
id UUID
databaseId UUID
schemaId UUID
privateSchemaId UUID
stepsTableId UUID
stepsTableName String
achievementsTableId UUID
achievementsTableName String
levelsTableId UUID
levelsTableName String
levelRequirementsTableId UUID
levelRequirementsTableName String
completedStep String
incompletedStep String
tgAchievement String
tgAchievementToggle String
tgAchievementToggleBoolean String
tgAchievementBoolean String
upsertAchievement String
tgUpdateAchievements String
stepsRequired String
levelAchieved String
prefix String
membershipType Int
entityTableId UUID
actorTableId UUID

Required create fields: databaseId, membershipType Optional create fields (backend defaults): schemaId, privateSchemaId, stepsTableId, stepsTableName, achievementsTableId, achievementsTableName, levelsTableId, levelsTableName, levelRequirementsTableId, levelRequirementsTableName, completedStep, incompletedStep, tgAchievement, tgAchievementToggle, tgAchievementToggleBoolean, tgAchievementBoolean, upsertAchievement, tgUpdateAchievements, stepsRequired, levelAchieved, prefix, entityTableId, actorTableId

limits-module

CRUD operations for LimitsModule records.

Subcommand Description
list List all limitsModule records
find-first Find first matching limitsModule record
get Get a limitsModule by id
create Create a new limitsModule
update Update an existing limitsModule
delete Delete a limitsModule

Fields:

Field Type
id UUID
databaseId UUID
schemaId UUID
privateSchemaId UUID
tableId UUID
tableName String
defaultTableId UUID
defaultTableName String
limitIncrementFunction String
limitDecrementFunction String
limitIncrementTrigger String
limitDecrementTrigger String
limitUpdateTrigger String
limitCheckFunction String
prefix String
membershipType Int
entityTableId UUID
actorTableId UUID

Required create fields: databaseId, membershipType Optional create fields (backend defaults): schemaId, privateSchemaId, tableId, tableName, defaultTableId, defaultTableName, limitIncrementFunction, limitDecrementFunction, limitIncrementTrigger, limitDecrementTrigger, limitUpdateTrigger, limitCheckFunction, prefix, entityTableId, actorTableId

membership-types-module

CRUD operations for MembershipTypesModule records.

Subcommand Description
list List all membershipTypesModule records
find-first Find first matching membershipTypesModule record
get Get a membershipTypesModule by id
create Create a new membershipTypesModule
update Update an existing membershipTypesModule
delete Delete a membershipTypesModule

Fields:

Field Type
id UUID
databaseId UUID
schemaId UUID
tableId UUID
tableName String

Required create fields: databaseId Optional create fields (backend defaults): schemaId, tableId, tableName

memberships-module

CRUD operations for MembershipsModule records.

Subcommand Description
list List all membershipsModule records
find-first Find first matching membershipsModule record
get Get a membershipsModule by id
create Create a new membershipsModule
update Update an existing membershipsModule
delete Delete a membershipsModule

Fields:

Field Type
id UUID
databaseId UUID
schemaId UUID
privateSchemaId UUID
membershipsTableId UUID
membershipsTableName String
membersTableId UUID
membersTableName String
membershipDefaultsTableId UUID
membershipDefaultsTableName String
grantsTableId UUID
grantsTableName String
actorTableId UUID
limitsTableId UUID
defaultLimitsTableId UUID
permissionsTableId UUID
defaultPermissionsTableId UUID
sprtTableId UUID
adminGrantsTableId UUID
adminGrantsTableName String
ownerGrantsTableId UUID
ownerGrantsTableName String
membershipType Int
entityTableId UUID
entityTableOwnerId UUID
prefix String
actorMaskCheck String
actorPermCheck String
entityIdsByMask String
entityIdsByPerm String
entityIdsFunction String

Required create fields: databaseId, membershipType Optional create fields (backend defaults): schemaId, privateSchemaId, membershipsTableId, membershipsTableName, membersTableId, membersTableName, membershipDefaultsTableId, membershipDefaultsTableName, grantsTableId, grantsTableName, actorTableId, limitsTableId, defaultLimitsTableId, permissionsTableId, defaultPermissionsTableId, sprtTableId, adminGrantsTableId, adminGrantsTableName, ownerGrantsTableId, ownerGrantsTableName, entityTableId, entityTableOwnerId, prefix, actorMaskCheck, actorPermCheck, entityIdsByMask, entityIdsByPerm, entityIdsFunction

permissions-module

CRUD operations for PermissionsModule records.

Subcommand Description
list List all permissionsModule records
find-first Find first matching permissionsModule record
get Get a permissionsModule by id
create Create a new permissionsModule
update Update an existing permissionsModule
delete Delete a permissionsModule

Fields:

Field Type
id UUID
databaseId UUID
schemaId UUID
privateSchemaId UUID
tableId UUID
tableName String
defaultTableId UUID
defaultTableName String
bitlen Int
membershipType Int
entityTableId UUID
actorTableId UUID
prefix String
getPaddedMask String
getMask String
getByMask String
getMaskByName String

Required create fields: databaseId, membershipType Optional create fields (backend defaults): schemaId, privateSchemaId, tableId, tableName, defaultTableId, defaultTableName, bitlen, entityTableId, actorTableId, prefix, getPaddedMask, getMask, getByMask, getMaskByName

phone-numbers-module

CRUD operations for PhoneNumbersModule records.

Subcommand Description
list List all phoneNumbersModule records
find-first Find first matching phoneNumbersModule record
get Get a phoneNumbersModule by id
create Create a new phoneNumbersModule
update Update an existing phoneNumbersModule
delete Delete a phoneNumbersModule

Fields:

Field Type
id UUID
databaseId UUID
schemaId UUID
privateSchemaId UUID
tableId UUID
ownerTableId UUID
tableName String

Required create fields: databaseId, tableName Optional create fields (backend defaults): schemaId, privateSchemaId, tableId, ownerTableId

profiles-module

CRUD operations for ProfilesModule records.

Subcommand Description
list List all profilesModule records
find-first Find first matching profilesModule record
get Get a profilesModule by id
create Create a new profilesModule
update Update an existing profilesModule
delete Delete a profilesModule

Fields:

Field Type
id UUID
databaseId UUID
schemaId UUID
privateSchemaId UUID
tableId UUID
tableName String
profilePermissionsTableId UUID
profilePermissionsTableName String
profileGrantsTableId UUID
profileGrantsTableName String
profileDefinitionGrantsTableId UUID
profileDefinitionGrantsTableName String
membershipType Int
entityTableId UUID
actorTableId UUID
permissionsTableId UUID
membershipsTableId UUID
prefix String

Required create fields: databaseId, membershipType Optional create fields (backend defaults): schemaId, privateSchemaId, tableId, tableName, profilePermissionsTableId, profilePermissionsTableName, profileGrantsTableId, profileGrantsTableName, profileDefinitionGrantsTableId, profileDefinitionGrantsTableName, entityTableId, actorTableId, permissionsTableId, membershipsTableId, prefix

secrets-module

CRUD operations for SecretsModule records.

Subcommand Description
list List all secretsModule records
find-first Find first matching secretsModule record
get Get a secretsModule by id
create Create a new secretsModule
update Update an existing secretsModule
delete Delete a secretsModule

Fields:

Field Type
id UUID
databaseId UUID
schemaId UUID
tableId UUID
tableName String

Required create fields: databaseId Optional create fields (backend defaults): schemaId, tableId, tableName

sessions-module

CRUD operations for SessionsModule records.

Subcommand Description
list List all sessionsModule records
find-first Find first matching sessionsModule record
get Get a sessionsModule by id
create Create a new sessionsModule
update Update an existing sessionsModule
delete Delete a sessionsModule

Fields:

Field Type
id UUID
databaseId UUID
schemaId UUID
sessionsTableId UUID
sessionCredentialsTableId UUID
authSettingsTableId UUID
usersTableId UUID
sessionsDefaultExpiration Interval
sessionsTable String
sessionCredentialsTable String
authSettingsTable String

Required create fields: databaseId Optional create fields (backend defaults): schemaId, sessionsTableId, sessionCredentialsTableId, authSettingsTableId, usersTableId, sessionsDefaultExpiration, sessionsTable, sessionCredentialsTable, authSettingsTable

user-auth-module

CRUD operations for UserAuthModule records.

Subcommand Description
list List all userAuthModule records
find-first Find first matching userAuthModule record
get Get a userAuthModule by id
create Create a new userAuthModule
update Update an existing userAuthModule
delete Delete a userAuthModule

Fields:

Field Type
id UUID
databaseId UUID
schemaId UUID
emailsTableId UUID
usersTableId UUID
secretsTableId UUID
encryptedTableId UUID
sessionsTableId UUID
sessionCredentialsTableId UUID
auditsTableId UUID
auditsTableName String
signInFunction String
signUpFunction String
signOutFunction String
setPasswordFunction String
resetPasswordFunction String
forgotPasswordFunction String
sendVerificationEmailFunction String
verifyEmailFunction String
verifyPasswordFunction String
checkPasswordFunction String
sendAccountDeletionEmailFunction String
deleteAccountFunction String
signInOneTimeTokenFunction String
oneTimeTokenFunction String
extendTokenExpires String

Required create fields: databaseId Optional create fields (backend defaults): schemaId, emailsTableId, usersTableId, secretsTableId, encryptedTableId, sessionsTableId, sessionCredentialsTableId, auditsTableId, auditsTableName, signInFunction, signUpFunction, signOutFunction, setPasswordFunction, resetPasswordFunction, forgotPasswordFunction, sendVerificationEmailFunction, verifyEmailFunction, verifyPasswordFunction, checkPasswordFunction, sendAccountDeletionEmailFunction, deleteAccountFunction, signInOneTimeTokenFunction, oneTimeTokenFunction, extendTokenExpires

users-module

CRUD operations for UsersModule records.

Subcommand Description
list List all usersModule records
find-first Find first matching usersModule record
get Get a usersModule by id
create Create a new usersModule
update Update an existing usersModule
delete Delete a usersModule

Fields:

Field Type
id UUID
databaseId UUID
schemaId UUID
tableId UUID
tableName String
typeTableId UUID
typeTableName String

Required create fields: databaseId Optional create fields (backend defaults): schemaId, tableId, tableName, typeTableId, typeTableName

blueprint

CRUD operations for Blueprint records.

Subcommand Description
list List all blueprint records
find-first Find first matching blueprint record
get Get a blueprint by id
create Create a new blueprint
update Update an existing blueprint
delete Delete a blueprint

Fields:

Field Type
id UUID
ownerId UUID
databaseId UUID
name String
displayName String
description String
definition JSON
templateId UUID
definitionHash UUID
tableHashes JSON
createdAt Datetime
updatedAt Datetime

Required create fields: ownerId, databaseId, name, displayName, definition Optional create fields (backend defaults): description, templateId, definitionHash, tableHashes

blueprint-template

CRUD operations for BlueprintTemplate records.

Subcommand Description
list List all blueprintTemplate records
find-first Find first matching blueprintTemplate record
get Get a blueprintTemplate by id
create Create a new blueprintTemplate
update Update an existing blueprintTemplate
delete Delete a blueprintTemplate

Fields:

Field Type
id UUID
name String
version String
displayName String
description String
ownerId UUID
visibility String
categories String
tags String
definition JSON
definitionSchemaVersion String
source String
complexity String
copyCount Int
forkCount Int
forkedFromId UUID
definitionHash UUID
tableHashes JSON
createdAt Datetime
updatedAt Datetime

Required create fields: name, displayName, ownerId, definition Optional create fields (backend defaults): version, description, visibility, categories, tags, definitionSchemaVersion, source, complexity, copyCount, forkCount, forkedFromId, definitionHash, tableHashes

blueprint-construction

CRUD operations for BlueprintConstruction records.

Subcommand Description
list List all blueprintConstruction records
find-first Find first matching blueprintConstruction record
get Get a blueprintConstruction by id
create Create a new blueprintConstruction
update Update an existing blueprintConstruction
delete Delete a blueprintConstruction

Fields:

Field Type
id UUID
blueprintId UUID
databaseId UUID
schemaId UUID
status String
errorDetails String
tableMap JSON
constructedDefinition JSON
constructedAt Datetime
createdAt Datetime
updatedAt Datetime

Required create fields: blueprintId, databaseId Optional create fields (backend defaults): schemaId, status, errorDetails, tableMap, constructedDefinition, constructedAt

storage-module

CRUD operations for StorageModule records.

Subcommand Description
list List all storageModule records
find-first Find first matching storageModule record
get Get a storageModule by id
create Create a new storageModule
update Update an existing storageModule
delete Delete a storageModule

Fields:

Field Type
id UUID
databaseId UUID
schemaId UUID
privateSchemaId UUID
bucketsTableId UUID
filesTableId UUID
uploadRequestsTableId UUID
bucketsTableName String
filesTableName String
uploadRequestsTableName String
entityTableId UUID
uploadUrlExpirySeconds Int
downloadUrlExpirySeconds Int
defaultMaxFileSize BigInt
maxFilenameLength Int
cacheTtlSeconds Int

Required create fields: databaseId Optional create fields (backend defaults): schemaId, privateSchemaId, bucketsTableId, filesTableId, uploadRequestsTableId, bucketsTableName, filesTableName, uploadRequestsTableName, entityTableId, uploadUrlExpirySeconds, downloadUrlExpirySeconds, defaultMaxFileSize, maxFilenameLength, cacheTtlSeconds

database-provision-module

CRUD operations for DatabaseProvisionModule records.

Subcommand Description
list List all databaseProvisionModule records
find-first Find first matching databaseProvisionModule record
get Get a databaseProvisionModule by id
create Create a new databaseProvisionModule
update Update an existing databaseProvisionModule
delete Delete a databaseProvisionModule

Fields:

Field Type
id UUID
databaseName String
ownerId UUID
subdomain String
domain String
modules String
options JSON
bootstrapUser Boolean
status String
errorMessage String
databaseId UUID
createdAt Datetime
updatedAt Datetime
completedAt Datetime

Required create fields: databaseName, ownerId, domain Optional create fields (backend defaults): subdomain, modules, options, bootstrapUser, status, errorMessage, databaseId, completedAt

app-admin-grant

CRUD operations for AppAdminGrant records.

Subcommand Description
list List all appAdminGrant records
find-first Find first matching appAdminGrant record
get Get a appAdminGrant by id
create Create a new appAdminGrant
update Update an existing appAdminGrant
delete Delete a appAdminGrant

Fields:

Field Type
id UUID
isGrant Boolean
actorId UUID
grantorId UUID
createdAt Datetime
updatedAt Datetime

Required create fields: actorId Optional create fields (backend defaults): isGrant, grantorId

app-owner-grant

CRUD operations for AppOwnerGrant records.

Subcommand Description
list List all appOwnerGrant records
find-first Find first matching appOwnerGrant record
get Get a appOwnerGrant by id
create Create a new appOwnerGrant
update Update an existing appOwnerGrant
delete Delete a appOwnerGrant

Fields:

Field Type
id UUID
isGrant Boolean
actorId UUID
grantorId UUID
createdAt Datetime
updatedAt Datetime

Required create fields: actorId Optional create fields (backend defaults): isGrant, grantorId

app-grant

CRUD operations for AppGrant records.

Subcommand Description
list List all appGrant records
find-first Find first matching appGrant record
get Get a appGrant by id
create Create a new appGrant
update Update an existing appGrant
delete Delete a appGrant

Fields:

Field Type
id UUID
permissions BitString
isGrant Boolean
actorId UUID
grantorId UUID
createdAt Datetime
updatedAt Datetime

Required create fields: actorId Optional create fields (backend defaults): permissions, isGrant, grantorId

org-membership

CRUD operations for OrgMembership records.

Subcommand Description
list List all orgMembership records
find-first Find first matching orgMembership record
get Get a orgMembership by id
create Create a new orgMembership
update Update an existing orgMembership
delete Delete a orgMembership

Fields:

Field Type
id UUID
createdAt Datetime
updatedAt Datetime
createdBy UUID
updatedBy UUID
isApproved Boolean
isBanned Boolean
isDisabled Boolean
isActive Boolean
isOwner Boolean
isAdmin Boolean
permissions BitString
granted BitString
actorId UUID
entityId UUID
profileId UUID

Required create fields: actorId, entityId Optional create fields (backend defaults): createdBy, updatedBy, isApproved, isBanned, isDisabled, isActive, isOwner, isAdmin, permissions, granted, profileId

org-member

CRUD operations for OrgMember records.

Subcommand Description
list List all orgMember records
find-first Find first matching orgMember record
get Get a orgMember by id
create Create a new orgMember
update Update an existing orgMember
delete Delete a orgMember

Fields:

Field Type
id UUID
isAdmin Boolean
actorId UUID
entityId UUID

Required create fields: actorId, entityId Optional create fields (backend defaults): isAdmin

org-admin-grant

CRUD operations for OrgAdminGrant records.

Subcommand Description
list List all orgAdminGrant records
find-first Find first matching orgAdminGrant record
get Get a orgAdminGrant by id
create Create a new orgAdminGrant
update Update an existing orgAdminGrant
delete Delete a orgAdminGrant

Fields:

Field Type
id UUID
isGrant Boolean
actorId UUID
entityId UUID
grantorId UUID
createdAt Datetime
updatedAt Datetime

Required create fields: actorId, entityId Optional create fields (backend defaults): isGrant, grantorId

org-owner-grant

CRUD operations for OrgOwnerGrant records.

Subcommand Description
list List all orgOwnerGrant records
find-first Find first matching orgOwnerGrant record
get Get a orgOwnerGrant by id
create Create a new orgOwnerGrant
update Update an existing orgOwnerGrant
delete Delete a orgOwnerGrant

Fields:

Field Type
id UUID
isGrant Boolean
actorId UUID
entityId UUID
grantorId UUID
createdAt Datetime
updatedAt Datetime

Required create fields: actorId, entityId Optional create fields (backend defaults): isGrant, grantorId

org-grant

CRUD operations for OrgGrant records.

Subcommand Description
list List all orgGrant records
find-first Find first matching orgGrant record
get Get a orgGrant by id
create Create a new orgGrant
update Update an existing orgGrant
delete Delete a orgGrant

Fields:

Field Type
id UUID
permissions BitString
isGrant Boolean
actorId UUID
entityId UUID
grantorId UUID
createdAt Datetime
updatedAt Datetime

Required create fields: actorId, entityId Optional create fields (backend defaults): permissions, isGrant, grantorId

org-chart-edge

CRUD operations for OrgChartEdge records.

Subcommand Description
list List all orgChartEdge records
find-first Find first matching orgChartEdge record
get Get a orgChartEdge by id
create Create a new orgChartEdge
update Update an existing orgChartEdge
delete Delete a orgChartEdge

Fields:

Field Type
id UUID
createdAt Datetime
updatedAt Datetime
entityId UUID
childId UUID
parentId UUID
positionTitle String
positionLevel Int

Required create fields: entityId, childId Optional create fields (backend defaults): parentId, positionTitle, positionLevel

org-chart-edge-grant

CRUD operations for OrgChartEdgeGrant records.

Subcommand Description
list List all orgChartEdgeGrant records
find-first Find first matching orgChartEdgeGrant record
get Get a orgChartEdgeGrant by id
create Create a new orgChartEdgeGrant
update Update an existing orgChartEdgeGrant
delete Delete a orgChartEdgeGrant

Fields:

Field Type
id UUID
entityId UUID
childId UUID
parentId UUID
grantorId UUID
isGrant Boolean
positionTitle String
positionLevel Int
createdAt Datetime

Required create fields: entityId, childId Optional create fields (backend defaults): parentId, grantorId, isGrant, positionTitle, positionLevel

org-permission-default

CRUD operations for OrgPermissionDefault records.

Subcommand Description
list List all orgPermissionDefault records
find-first Find first matching orgPermissionDefault record
get Get a orgPermissionDefault by id
create Create a new orgPermissionDefault
update Update an existing orgPermissionDefault
delete Delete a orgPermissionDefault

Fields:

Field Type
id UUID
permissions BitString
entityId UUID

Required create fields: entityId Optional create fields (backend defaults): permissions

app-limit

CRUD operations for AppLimit records.

Subcommand Description
list List all appLimit records
find-first Find first matching appLimit record
get Get a appLimit by id
create Create a new appLimit
update Update an existing appLimit
delete Delete a appLimit

Fields:

Field Type
id UUID
name String
actorId UUID
num Int
max Int

Required create fields: actorId Optional create fields (backend defaults): name, num, max

org-limit

CRUD operations for OrgLimit records.

Subcommand Description
list List all orgLimit records
find-first Find first matching orgLimit record
get Get a orgLimit by id
create Create a new orgLimit
update Update an existing orgLimit
delete Delete a orgLimit

Fields:

Field Type
id UUID
name String
actorId UUID
num Int
max Int
entityId UUID

Required create fields: actorId, entityId Optional create fields (backend defaults): name, num, max

app-step

CRUD operations for AppStep records.

Subcommand Description
list List all appStep records
find-first Find first matching appStep record
get Get a appStep by id
create Create a new appStep
update Update an existing appStep
delete Delete a appStep

Fields:

Field Type
id UUID
actorId UUID
name String
count Int
createdAt Datetime
updatedAt Datetime

Required create fields: name Optional create fields (backend defaults): actorId, count

app-achievement

CRUD operations for AppAchievement records.

Subcommand Description
list List all appAchievement records
find-first Find first matching appAchievement record
get Get a appAchievement by id
create Create a new appAchievement
update Update an existing appAchievement
delete Delete a appAchievement

Fields:

Field Type
id UUID
actorId UUID
name String
count Int
createdAt Datetime
updatedAt Datetime

Required create fields: name Optional create fields (backend defaults): actorId, count

app-level

CRUD operations for AppLevel records.

Subcommand Description
list List all appLevel records
find-first Find first matching appLevel record
get Get a appLevel by id
create Create a new appLevel
update Update an existing appLevel
delete Delete a appLevel

Fields:

Field Type
id UUID
name String
description String
image Image
ownerId UUID
createdAt Datetime
updatedAt Datetime

Required create fields: name Optional create fields (backend defaults): description, image, ownerId

email

CRUD operations for Email records.

Subcommand Description
list List all email records
find-first Find first matching email record
get Get a email by id
create Create a new email
update Update an existing email
delete Delete a email

Fields:

Field Type
id UUID
ownerId UUID
email Email
isVerified Boolean
isPrimary Boolean
createdAt Datetime
updatedAt Datetime

Required create fields: email Optional create fields (backend defaults): ownerId, isVerified, isPrimary

phone-number

CRUD operations for PhoneNumber records.

Subcommand Description
list List all phoneNumber records
find-first Find first matching phoneNumber record
get Get a phoneNumber by id
create Create a new phoneNumber
update Update an existing phoneNumber
delete Delete a phoneNumber

Fields:

Field Type
id UUID
ownerId UUID
cc String
number String
isVerified Boolean
isPrimary Boolean
createdAt Datetime
updatedAt Datetime

Required create fields: cc, number Optional create fields (backend defaults): ownerId, isVerified, isPrimary

crypto-address

CRUD operations for CryptoAddress records.

Subcommand Description
list List all cryptoAddress records
find-first Find first matching cryptoAddress record
get Get a cryptoAddress by id
create Create a new cryptoAddress
update Update an existing cryptoAddress
delete Delete a cryptoAddress

Fields:

Field Type
id UUID
ownerId UUID
address String
isVerified Boolean
isPrimary Boolean
createdAt Datetime
updatedAt Datetime

Required create fields: address Optional create fields (backend defaults): ownerId, isVerified, isPrimary

connected-account

CRUD operations for ConnectedAccount records.

Subcommand Description
list List all connectedAccount records
find-first Find first matching connectedAccount record
get Get a connectedAccount by id
create Create a new connectedAccount
update Update an existing connectedAccount
delete Delete a connectedAccount

Fields:

Field Type
id UUID
ownerId UUID
service String
identifier String
details JSON
isVerified Boolean
createdAt Datetime
updatedAt Datetime

Required create fields: service, identifier, details Optional create fields (backend defaults): ownerId, isVerified

invite

CRUD operations for Invite records.

Subcommand Description
list List all invite records
find-first Find first matching invite record
get Get a invite by id
create Create a new invite
update Update an existing invite
delete Delete a invite

Fields:

Field Type
id UUID
email Email
senderId UUID
inviteToken String
inviteValid Boolean
inviteLimit Int
inviteCount Int
multiple Boolean
data JSON
expiresAt Datetime
createdAt Datetime
updatedAt Datetime

Optional create fields (backend defaults): email, senderId, inviteToken, inviteValid, inviteLimit, inviteCount, multiple, data, expiresAt

claimed-invite

CRUD operations for ClaimedInvite records.

Subcommand Description
list List all claimedInvite records
find-first Find first matching claimedInvite record
get Get a claimedInvite by id
create Create a new claimedInvite
update Update an existing claimedInvite
delete Delete a claimedInvite

Fields:

Field Type
id UUID
data JSON
senderId UUID
receiverId UUID
createdAt Datetime
updatedAt Datetime

Optional create fields (backend defaults): data, senderId, receiverId

org-invite

CRUD operations for OrgInvite records.

Subcommand Description
list List all orgInvite records
find-first Find first matching orgInvite record
get Get a orgInvite by id
create Create a new orgInvite
update Update an existing orgInvite
delete Delete a orgInvite

Fields:

Field Type
id UUID
email Email
senderId UUID
receiverId UUID
inviteToken String
inviteValid Boolean
inviteLimit Int
inviteCount Int
multiple Boolean
data JSON
expiresAt Datetime
createdAt Datetime
updatedAt Datetime
entityId UUID

Required create fields: entityId Optional create fields (backend defaults): email, senderId, receiverId, inviteToken, inviteValid, inviteLimit, inviteCount, multiple, data, expiresAt

org-claimed-invite

CRUD operations for OrgClaimedInvite records.

Subcommand Description
list List all orgClaimedInvite records
find-first Find first matching orgClaimedInvite record
get Get a orgClaimedInvite by id
create Create a new orgClaimedInvite
update Update an existing orgClaimedInvite
delete Delete a orgClaimedInvite

Fields:

Field Type
id UUID
data JSON
senderId UUID
receiverId UUID
createdAt Datetime
updatedAt Datetime
entityId UUID

Required create fields: entityId Optional create fields (backend defaults): data, senderId, receiverId

audit-log

CRUD operations for AuditLog records.

Subcommand Description
list List all auditLog records
find-first Find first matching auditLog record
get Get a auditLog by id
create Create a new auditLog
update Update an existing auditLog
delete Delete a auditLog

Fields:

Field Type
id UUID
event String
actorId UUID
origin Origin
userAgent String
ipAddress InternetAddress
success Boolean
createdAt Datetime

Required create fields: event, success Optional create fields (backend defaults): actorId, origin, userAgent, ipAddress

app-permission-default

CRUD operations for AppPermissionDefault records.

Subcommand Description
list List all appPermissionDefault records
find-first Find first matching appPermissionDefault record
get Get a appPermissionDefault by id
create Create a new appPermissionDefault
update Update an existing appPermissionDefault
delete Delete a appPermissionDefault

Fields:

Field Type
id UUID
permissions BitString

Optional create fields (backend defaults): permissions

ref

CRUD operations for Ref records.

Subcommand Description
list List all ref records
find-first Find first matching ref record
get Get a ref by id
create Create a new ref
update Update an existing ref
delete Delete a ref

Fields:

Field Type
id UUID
name String
databaseId UUID
storeId UUID
commitId UUID

Required create fields: name, databaseId, storeId Optional create fields (backend defaults): commitId

store

CRUD operations for Store records.

Subcommand Description
list List all store records
find-first Find first matching store record
get Get a store by id
create Create a new store
update Update an existing store
delete Delete a store

Fields:

Field Type
id UUID
name String
databaseId UUID
hash UUID
createdAt Datetime

Required create fields: name, databaseId Optional create fields (backend defaults): hash

role-type

CRUD operations for RoleType records.

Subcommand Description
list List all roleType records
find-first Find first matching roleType record
get Get a roleType by id
create Create a new roleType
update Update an existing roleType
delete Delete a roleType

Fields:

Field Type
id Int
name String

Required create fields: name

migrate-file

CRUD operations for MigrateFile records.

Subcommand Description
list List all migrateFile records
find-first Find first matching migrateFile record
get Get a migrateFile by id
create Create a new migrateFile
update Update an existing migrateFile
delete Delete a migrateFile

Fields:

Field Type
id UUID
databaseId UUID
upload Upload

Optional create fields (backend defaults): databaseId, upload

app-limit-default

CRUD operations for AppLimitDefault records.

Subcommand Description
list List all appLimitDefault records
find-first Find first matching appLimitDefault record
get Get a appLimitDefault by id
create Create a new appLimitDefault
update Update an existing appLimitDefault
delete Delete a appLimitDefault

Fields:

Field Type
id UUID
name String
max Int

Required create fields: name Optional create fields (backend defaults): max

org-limit-default

CRUD operations for OrgLimitDefault records.

Subcommand Description
list List all orgLimitDefault records
find-first Find first matching orgLimitDefault record
get Get a orgLimitDefault by id
create Create a new orgLimitDefault
update Update an existing orgLimitDefault
delete Delete a orgLimitDefault

Fields:

Field Type
id UUID
name String
max Int

Required create fields: name Optional create fields (backend defaults): max

membership-type

CRUD operations for MembershipType records.

Subcommand Description
list List all membershipType records
find-first Find first matching membershipType record
get Get a membershipType by id
create Create a new membershipType
update Update an existing membershipType
delete Delete a membershipType

Fields:

Field Type
id Int
name String
description String
prefix String

Required create fields: name, description, prefix

app-membership-default

CRUD operations for AppMembershipDefault records.

Subcommand Description
list List all appMembershipDefault records
find-first Find first matching appMembershipDefault record
get Get a appMembershipDefault by id
create Create a new appMembershipDefault
update Update an existing appMembershipDefault
delete Delete a appMembershipDefault

Fields:

Field Type
id UUID
createdAt Datetime
updatedAt Datetime
createdBy UUID
updatedBy UUID
isApproved Boolean
isVerified Boolean

Optional create fields (backend defaults): createdBy, updatedBy, isApproved, isVerified

commit

CRUD operations for Commit records.

Subcommand Description
list List all commit records
find-first Find first matching commit record
get Get a commit by id
create Create a new commit
update Update an existing commit
delete Delete a commit

Fields:

Field Type
id UUID
message String
databaseId UUID
storeId UUID
parentIds UUID
authorId UUID
committerId UUID
treeId UUID
date Datetime

Required create fields: databaseId, storeId Optional create fields (backend defaults): message, parentIds, authorId, committerId, treeId, date

org-membership-default

CRUD operations for OrgMembershipDefault records.

Subcommand Description
list List all orgMembershipDefault records
find-first Find first matching orgMembershipDefault record
get Get a orgMembershipDefault by id
create Create a new orgMembershipDefault
update Update an existing orgMembershipDefault
delete Delete a orgMembershipDefault

Fields:

Field Type
id UUID
createdAt Datetime
updatedAt Datetime
createdBy UUID
updatedBy UUID
isApproved Boolean
entityId UUID
deleteMemberCascadeGroups Boolean
createGroupsCascadeMembers Boolean

Required create fields: entityId Optional create fields (backend defaults): createdBy, updatedBy, isApproved, deleteMemberCascadeGroups, createGroupsCascadeMembers

rls-module

CRUD operations for RlsModule records.

Subcommand Description
list List all rlsModule records
find-first Find first matching rlsModule record
get Get a rlsModule by id
create Create a new rlsModule
update Update an existing rlsModule
delete Delete a rlsModule

Fields:

Field Type
id UUID
databaseId UUID
schemaId UUID
privateSchemaId UUID
sessionCredentialsTableId UUID
sessionsTableId UUID
usersTableId UUID
authenticate String
authenticateStrict String
currentRole String
currentRoleId String

Required create fields: databaseId Optional create fields (backend defaults): schemaId, privateSchemaId, sessionCredentialsTableId, sessionsTableId, usersTableId, authenticate, authenticateStrict, currentRole, currentRoleId

sql-action

CRUD operations for SqlAction records.

Subcommand Description
list List all sqlAction records
find-first Find first matching sqlAction record
get Get a sqlAction by id
create Create a new sqlAction
update Update an existing sqlAction
delete Delete a sqlAction

Fields:

Field Type
id Int
name String
databaseId UUID
deploy String
deps String
payload JSON
content String
revert String
verify String
createdAt Datetime
action String
actionId UUID
actorId UUID

Optional create fields (backend defaults): name, databaseId, deploy, deps, payload, content, revert, verify, action, actionId, actorId

user

CRUD operations for User records.

Subcommand Description
list List all user records
find-first Find first matching user record
search <query> Search user records
get Get a user by id
create Create a new user
update Update an existing user
delete Delete a user

Fields:

Field Type
id UUID
username String
displayName String
profilePicture Image
searchTsv FullText
type Int
createdAt Datetime
updatedAt Datetime
searchTsvRank Float
displayNameTrgmSimilarity Float
searchScore Float

Optional create fields (backend defaults): username, displayName, profilePicture, type

Unified Search API fields: searchTsv, displayNameTrgmSimilarity, searchScore Fields provided by the Unified Search plugin. Includes full-text search (tsvector/BM25), trigram similarity scores, and the combined searchScore. Computed fields are read-only and cannot be set in create/update operations.

Search Examples:

Full-text search via tsvector (searchTsv):

csdk user list --where.searchTsv "search query" --select title,tsvRank

Fuzzy search via trigram similarity (trgmDisplayName):

csdk user list --where.trgmDisplayName.value "approximate query" --where.trgmDisplayName.threshold 0.3 --select title,displayNameTrgmSimilarity

Composite search (unifiedSearch dispatches to all text adapters):

csdk user list --where.unifiedSearch "search query" --select title,tsvRank,displayNameTrgmSimilarity,searchScore

Search with pagination and field projection:

csdk user list --where.unifiedSearch "query" --limit 10 --select id,title,searchScore
csdk user search "query" --limit 10 --select id,title,searchScore

ast-migration

CRUD operations for AstMigration records.

Subcommand Description
list List all astMigration records
find-first Find first matching astMigration record
get Get a astMigration by id
create Create a new astMigration
update Update an existing astMigration
delete Delete a astMigration

Fields:

Field Type
id Int
databaseId UUID
name String
requires String
payload JSON
deploys String
deploy JSON
revert JSON
verify JSON
createdAt Datetime
action String
actionId UUID
actorId UUID

Optional create fields (backend defaults): databaseId, name, requires, payload, deploys, deploy, revert, verify, action, actionId, actorId

app-membership

CRUD operations for AppMembership records.

Subcommand Description
list List all appMembership records
find-first Find first matching appMembership record
get Get a appMembership by id
create Create a new appMembership
update Update an existing appMembership
delete Delete a appMembership

Fields:

Field Type
id UUID
createdAt Datetime
updatedAt Datetime
createdBy UUID
updatedBy UUID
isApproved Boolean
isBanned Boolean
isDisabled Boolean
isVerified Boolean
isActive Boolean
isOwner Boolean
isAdmin Boolean
permissions BitString
granted BitString
actorId UUID
profileId UUID

Required create fields: actorId Optional create fields (backend defaults): createdBy, updatedBy, isApproved, isBanned, isDisabled, isVerified, isActive, isOwner, isAdmin, permissions, granted, profileId

hierarchy-module

CRUD operations for HierarchyModule records.

Subcommand Description
list List all hierarchyModule records
find-first Find first matching hierarchyModule record
get Get a hierarchyModule by id
create Create a new hierarchyModule
update Update an existing hierarchyModule
delete Delete a hierarchyModule

Fields:

Field Type
id UUID
databaseId UUID
schemaId UUID
privateSchemaId UUID
chartEdgesTableId UUID
chartEdgesTableName String
hierarchySprtTableId UUID
hierarchySprtTableName String
chartEdgeGrantsTableId UUID
chartEdgeGrantsTableName String
entityTableId UUID
usersTableId UUID
prefix String
privateSchemaName String
sprtTableName String
rebuildHierarchyFunction String
getSubordinatesFunction String
getManagersFunction String
isManagerOfFunction String
createdAt Datetime

Required create fields: databaseId, entityTableId, usersTableId Optional create fields (backend defaults): schemaId, privateSchemaId, chartEdgesTableId, chartEdgesTableName, hierarchySprtTableId, hierarchySprtTableName, chartEdgeGrantsTableId, chartEdgeGrantsTableName, prefix, privateSchemaName, sprtTableName, rebuildHierarchyFunction, getSubordinatesFunction, getManagersFunction, isManagerOfFunction

Custom Operations

current-user-id

currentUserId

  • Type: query
  • Arguments: none

current-ip-address

currentIpAddress

  • Type: query
  • Arguments: none

current-user-agent

currentUserAgent

  • Type: query
  • Arguments: none

app-permissions-get-padded-mask

appPermissionsGetPaddedMask

  • Type: query

  • Arguments:

    Argument Type
    --mask BitString

org-permissions-get-padded-mask

orgPermissionsGetPaddedMask

  • Type: query

  • Arguments:

    Argument Type
    --mask BitString

steps-achieved

stepsAchieved

  • Type: query

  • Arguments:

    Argument Type
    --vlevel String
    --vroleId UUID

rev-parse

revParse

  • Type: query

  • Arguments:

    Argument Type
    --dbId UUID
    --storeId UUID
    --refname String

org-is-manager-of

orgIsManagerOf

  • Type: query

  • Arguments:

    Argument Type
    --pEntityId UUID
    --pManagerId UUID
    --pUserId UUID
    --pMaxDepth Int

app-permissions-get-mask

appPermissionsGetMask

  • Type: query

  • Arguments:

    Argument Type
    --ids UUID

org-permissions-get-mask

orgPermissionsGetMask

  • Type: query

  • Arguments:

    Argument Type
    --ids UUID

resolve-blueprint-table

Resolves a table_name (with optional schema_name) to a table_id. Resolution order: (1) if schema_name provided, exact lookup via metaschema_public.schema.name + metaschema_public.table; (2) check local table_map (tables created in current blueprint); (3) search metaschema_public.table by name across all schemas; (4) if multiple matches, throw ambiguous error asking for schema_name; (5) if no match, throw not-found error.

  • Type: query

  • Arguments:

    Argument Type
    --databaseId UUID
    --tableName String
    --schemaName String
    --tableMap JSON
    --defaultSchemaId UUID

app-permissions-get-mask-by-names

appPermissionsGetMaskByNames

  • Type: query

  • Arguments:

    Argument Type
    --names String

org-permissions-get-mask-by-names

orgPermissionsGetMaskByNames

  • Type: query

  • Arguments:

    Argument Type
    --names String

get-all-objects-from-root

Reads and enables pagination through a set of Object.

  • Type: query

  • Arguments:

    Argument Type
    --databaseId UUID
    --id UUID
    --first Int
    --offset Int
    --after Cursor

get-path-objects-from-root

Reads and enables pagination through a set of Object.

  • Type: query

  • Arguments:

    Argument Type
    --databaseId UUID
    --id UUID
    --path String
    --first Int
    --offset Int
    --after Cursor

get-object-at-path

getObjectAtPath

  • Type: query

  • Arguments:

    Argument Type
    --dbId UUID
    --storeId UUID
    --path String
    --refname String

app-permissions-get-by-mask

Reads and enables pagination through a set of AppPermission.

  • Type: query

  • Arguments:

    Argument Type
    --mask BitString
    --first Int
    --offset Int
    --after Cursor

org-permissions-get-by-mask

Reads and enables pagination through a set of OrgPermission.

  • Type: query

  • Arguments:

    Argument Type
    --mask BitString
    --first Int
    --offset Int
    --after Cursor

steps-required

Reads and enables pagination through a set of AppLevelRequirement.

  • Type: query

  • Arguments:

    Argument Type
    --vlevel String
    --vroleId UUID
    --first Int
    --offset Int
    --after Cursor

current-user

currentUser

  • Type: query
  • Arguments: none

send-account-deletion-email

sendAccountDeletionEmail

  • Type: mutation

  • Arguments:

    Argument Type
    --input.clientMutationId String

sign-out

signOut

  • Type: mutation

  • Arguments:

    Argument Type
    --input.clientMutationId String

accept-database-transfer

acceptDatabaseTransfer

  • Type: mutation

  • Arguments:

    Argument Type
    --input.clientMutationId String
    --input.transferId UUID

cancel-database-transfer

cancelDatabaseTransfer

  • Type: mutation

  • Arguments:

    Argument Type
    --input.clientMutationId String
    --input.transferId UUID

reject-database-transfer

rejectDatabaseTransfer

  • Type: mutation

  • Arguments:

    Argument Type
    --input.clientMutationId String
    --input.transferId UUID

submit-invite-code

submitInviteCode

  • Type: mutation

  • Arguments:

    Argument Type
    --input.clientMutationId String
    --input.token String

submit-org-invite-code

submitOrgInviteCode

  • Type: mutation

  • Arguments:

    Argument Type
    --input.clientMutationId String
    --input.token String

check-password

checkPassword

  • Type: mutation

  • Arguments:

    Argument Type
    --input.clientMutationId String
    --input.password String

confirm-delete-account

confirmDeleteAccount

  • Type: mutation

  • Arguments:

    Argument Type
    --input.clientMutationId String
    --input.userId UUID
    --input.token String

set-password

setPassword

  • Type: mutation

  • Arguments:

    Argument Type
    --input.clientMutationId String
    --input.currentPassword String
    --input.newPassword String

verify-email

verifyEmail

  • Type: mutation

  • Arguments:

    Argument Type
    --input.clientMutationId String
    --input.emailId UUID
    --input.token String

freeze-objects

freezeObjects

  • Type: mutation

  • Arguments:

    Argument Type
    --input.clientMutationId String
    --input.databaseId UUID
    --input.id UUID

init-empty-repo

initEmptyRepo

  • Type: mutation

  • Arguments:

    Argument Type
    --input.clientMutationId String
    --input.dbId UUID
    --input.storeId UUID

construct-blueprint

Executes a blueprint definition by delegating to provision_* procedures. Creates a blueprint_construction record to track the attempt. Five phases: (1) provision_table() for each table with all nodes[], fields[], policies[], grants, and table-level indexes/fts/unique_constraints in a single call, (2) provision_relation() for each relation, (3) provision_index() for top-level indexes, (4) provision_full_text_search() for top-level FTS, (5) provision_unique_constraint() for top-level unique constraints. Tables are identified by table_name with optional per-table schema_name. Relations use $type for relation_type with source_table/target_table. Returns the construction record ID on success, NULL on failure.

  • Type: mutation

  • Arguments:

    Argument Type
    --input.clientMutationId String
    --input.blueprintId UUID
    --input.schemaId UUID

reset-password

resetPassword

  • Type: mutation

  • Arguments:

    Argument Type
    --input.clientMutationId String
    --input.roleId UUID
    --input.resetToken String
    --input.newPassword String

remove-node-at-path

removeNodeAtPath

  • Type: mutation

  • Arguments:

    Argument Type
    --input.clientMutationId String
    --input.dbId UUID
    --input.root UUID
    --input.path String

copy-template-to-blueprint

Creates a new blueprint by copying a template definition. Checks visibility: owners can always copy their own templates, others require public visibility. Increments the template copy_count. Returns the new blueprint ID.

  • Type: mutation

  • Arguments:

    Argument Type
    --input.clientMutationId String
    --input.templateId UUID
    --input.databaseId UUID
    --input.ownerId UUID
    --input.nameOverride String
    --input.displayNameOverride String

bootstrap-user

bootstrapUser

  • Type: mutation

  • Arguments:

    Argument Type
    --input.clientMutationId String
    --input.targetDatabaseId UUID
    --input.password String
    --input.isAdmin Boolean
    --input.isOwner Boolean
    --input.username String
    --input.displayName String
    --input.returnApiKey Boolean

set-field-order

setFieldOrder

  • Type: mutation

  • Arguments:

    Argument Type
    --input.clientMutationId String
    --input.fieldIds UUID

provision-unique-constraint

Creates a unique constraint on a table. Accepts a jsonb definition with columns (array of field names). Graceful: skips if the exact same unique constraint already exists.

  • Type: mutation

  • Arguments:

    Argument Type
    --input.clientMutationId String
    --input.databaseId UUID
    --input.tableId UUID
    --input.definition JSON

provision-full-text-search

Creates a full-text search configuration on a table. Accepts a jsonb definition with field (tsvector column name) and sources (array of {field, weight, lang}). Graceful: skips if FTS config already exists for the same (table_id, field_id). Returns the fts_id.

  • Type: mutation

  • Arguments:

    Argument Type
    --input.clientMutationId String
    --input.databaseId UUID
    --input.tableId UUID
    --input.definition JSON

provision-index

Creates an index on a table. Accepts a jsonb definition with columns (array of names or single column string), access_method (default BTREE), is_unique, op_classes, options, and name (auto-generated if omitted). Graceful: skips if an index with the same (table_id, field_ids, access_method) already exists. Returns the index_id.

  • Type: mutation

  • Arguments:

    Argument Type
    --input.clientMutationId String
    --input.databaseId UUID
    --input.tableId UUID
    --input.definition JSON

set-data-at-path

setDataAtPath

  • Type: mutation

  • Arguments:

    Argument Type
    --input.clientMutationId String
    --input.dbId UUID
    --input.root UUID
    --input.path String
    --input.data JSON

set-props-and-commit

setPropsAndCommit

  • Type: mutation

  • Arguments:

    Argument Type
    --input.clientMutationId String
    --input.dbId UUID
    --input.storeId UUID
    --input.refname String
    --input.path String
    --input.data JSON

provision-database-with-user

provisionDatabaseWithUser

  • Type: mutation

  • Arguments:

    Argument Type
    --input.clientMutationId String
    --input.pDatabaseName String
    --input.pDomain String
    --input.pSubdomain String
    --input.pModules String
    --input.pOptions JSON

insert-node-at-path

insertNodeAtPath

  • Type: mutation

  • Arguments:

    Argument Type
    --input.clientMutationId String
    --input.dbId UUID
    --input.root UUID
    --input.path String
    --input.data JSON
    --input.kids UUID
    --input.ktree String

update-node-at-path

updateNodeAtPath

  • Type: mutation

  • Arguments:

    Argument Type
    --input.clientMutationId String
    --input.dbId UUID
    --input.root UUID
    --input.path String
    --input.data JSON
    --input.kids UUID
    --input.ktree String

set-and-commit

setAndCommit

  • Type: mutation

  • Arguments:

    Argument Type
    --input.clientMutationId String
    --input.dbId UUID
    --input.storeId UUID
    --input.refname String
    --input.path String
    --input.data JSON
    --input.kids UUID
    --input.ktree String

provision-relation

Composable relation provisioning: creates FK fields, indexes, unique constraints, and junction tables depending on the relation_type. Supports RelationBelongsTo, RelationHasOne, RelationHasMany, and RelationManyToMany. ManyToMany uses provision_table() internally for junction table creation with full node/grant/policy support. All operations are graceful (skip existing). Returns (out_field_id, out_junction_table_id, out_source_field_id, out_target_field_id).

  • Type: mutation

  • Arguments:

    Argument Type
    --input.clientMutationId String
    --input.databaseId UUID
    --input.relationType String
    --input.sourceTableId UUID
    --input.targetTableId UUID
    --input.fieldName String
    --input.deleteAction String
    --input.isRequired Boolean
    --input.apiRequired Boolean
    --input.createIndex Boolean
    --input.junctionTableId UUID
    --input.junctionTableName String
    --input.junctionSchemaId UUID
    --input.sourceFieldName String
    --input.targetFieldName String
    --input.useCompositeKey Boolean
    --input.exposeInApi Boolean
    --input.nodes JSON
    --input.grants JSON
    --input.grantRoles String
    --input.policies JSON

apply-rls

applyRls

  • Type: mutation

  • Arguments:

    Argument Type
    --input.clientMutationId String
    --input.tableId UUID
    --input.grants JSON
    --input.policyType String
    --input.vars JSON
    --input.fieldIds UUID
    --input.permissive Boolean
    --input.name String

sign-in-one-time-token

signInOneTimeToken

  • Type: mutation

  • Arguments:

    Argument Type
    --input.clientMutationId String
    --input.token String
    --input.credentialKind String

create-user-database

Creates a new user database with all required modules, permissions, and RLS policies.

Parameters:

  • database_name: Name for the new database (required)
  • owner_id: UUID of the owner user (required)
  • include_invites: Include invite system (default: true)
  • include_groups: Include group-level memberships (default: false)
  • include_levels: Include levels/achievements (default: false)
  • bitlen: Bit length for permission masks (default: 64)
  • tokens_expiration: Token expiration interval (default: 30 days)

Returns the database_id UUID of the newly created database.

Example usage: SELECT metaschema_public.create_user_database('my_app', 'a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11'::uuid); SELECT metaschema_public.create_user_database('my_app', 'a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11'::uuid, true, true); -- with invites and groups

  • Type: mutation

  • Arguments:

    Argument Type
    --input.clientMutationId String
    --input.databaseName String
    --input.ownerId UUID
    --input.includeInvites Boolean
    --input.includeGroups Boolean
    --input.includeLevels Boolean
    --input.bitlen Int
    --input.tokensExpiration IntervalInput

extend-token-expires

extendTokenExpires

  • Type: mutation

  • Arguments:

    Argument Type
    --input.clientMutationId String
    --input.amount IntervalInput

sign-in

signIn

  • Type: mutation

  • Arguments:

    Argument Type
    --input.clientMutationId String
    --input.email String
    --input.password String
    --input.rememberMe Boolean
    --input.credentialKind String
    --input.csrfToken String

sign-up

signUp

  • Type: mutation

  • Arguments:

    Argument Type
    --input.clientMutationId String
    --input.email String
    --input.password String
    --input.rememberMe Boolean
    --input.credentialKind String
    --input.csrfToken String

one-time-token

oneTimeToken

  • Type: mutation

  • Arguments:

    Argument Type
    --input.clientMutationId String
    --input.email String
    --input.password String
    --input.origin Origin
    --input.rememberMe Boolean

provision-table

Composable table provisioning: creates or finds a table, then creates fields (so Data* modules can reference them), applies N nodes (Data* modules), enables RLS, creates grants, creates N policies, and optionally creates table-level indexes/full_text_searches/unique_constraints. All operations are graceful (skip existing). Accepts multiple nodes and multiple policies per call, unlike secure_table_provision which is limited to one of each. Returns (out_table_id, out_fields).

  • Type: mutation

  • Arguments:

    Argument Type
    --input.clientMutationId String
    --input.databaseId UUID
    --input.schemaId UUID
    --input.tableName String
    --input.tableId UUID
    --input.nodes JSON
    --input.fields JSON
    --input.policies JSON
    --input.grants JSON
    --input.grantRoles String
    --input.useRls Boolean
    --input.indexes JSON
    --input.fullTextSearches JSON
    --input.uniqueConstraints JSON

send-verification-email

sendVerificationEmail

  • Type: mutation

  • Arguments:

    Argument Type
    --input.clientMutationId String
    --input.email Email

forgot-password

forgotPassword

  • Type: mutation

  • Arguments:

    Argument Type
    --input.clientMutationId String
    --input.email Email

verify-password

verifyPassword

  • Type: mutation

  • Arguments:

    Argument Type
    --input.clientMutationId String
    --input.password String (required)

verify-totp

verifyTotp

  • Type: mutation

  • Arguments:

    Argument Type
    --input.clientMutationId String
    --input.totpValue String (required)

Output

All commands output JSON to stdout. Pipe to jq for formatting:

csdk car list | jq '.[]'
csdk car get --id <uuid> | jq '.'

Non-Interactive Mode

Use --no-tty to skip all interactive prompts (useful for scripts and CI):

csdk --no-tty car create --name "Sedan" --year 2024

Built by the Constructive team.

Disclaimer

AS DESCRIBED IN THE LICENSES, THE SOFTWARE IS PROVIDED "AS IS", AT YOUR OWN RISK, AND WITHOUT WARRANTIES OF ANY KIND.

No developer or entity involved in creating this software will be liable for any claims or damages whatsoever associated with your use, inability to use, or your interaction with other users of the code, including any direct, indirect, incidental, special, exemplary, punitive or consequential damages, or loss of profits, cryptocurrencies, tokens, or anything else of value.