Skip to content

Main Navigation Docs

Appearance

Sidebar Navigation

Getting Started

Overview

Quick Start

Configuring Primitive Services

App Secrets

One App, Several Clients

Example Apps

Error Handling

Users and Auth

Authentication

Users and Groups

Access Control

Resource Metadata

Invitations

Data Persistence

Choosing Your Data Model

Working with Documents

Collections

Working with Databases

Blobs and Files

Server Functions

Overview

Invoking and Triggers

Tasks and Requests

The Function Context

Inbound Webhooks

Platform Services

Locks

Notifications

Prompts

API Integrations

Analytics

Deploying to Production

Tools

Admin Console

Primitive CLI

Inspecting and Debugging

Dev Tools

Releases

Changelog

Reference

primitive-app

JsBaoClientService

js-bao-wss-client

Client Setup

JsBaoClientOptions

JsBaoEvents

Documents

aliases

ingests

snapshots

addTag()

approveAccessRequest()

blobs()

cancelPendingCreate()

clearLinkAccess()

close()

commitOfflineCreate()

create()

createWithAlias()

delete()

denyAccessRequest()

evict()

evictAll()

for()

get()

getAwarenessStates()

getDocumentPermission()

getLinkAccess()

getLocalMetadata()

getOrCreateWithAlias()

getPermissions()

getRoot()

getUploadConcurrency()

grantGroupPermission()

hasLocalCopy()

includesWrites()

inSync()

isOpen()

isPendingCreate()

isReadOnly()

isSynced()

listAccessRequests()

listGroupPermissions()

listOpen()

listPendingCreates()

listPendingInvitations()

open()

openAlias()

openRoot()

pauseAllUploads()

pauseUpload()

removeAwareness()

removePermission()

removeTag()

requestAccess()

resumeAllUploads()

resumeUpload()

revokeGroupPermission()

setAwareness()

setLinkAccess()

setUploadConcurrency()

transferOwnership()

update()

updatePermissions()

uploads()

validateAccess()

waitForInSync()

waitForWriteConfirmation()

blobs()

clearLinkAccess()

delete()

get()

getLinkAccess()

getLocalMetadata()

getPermissions()

getUploadConcurrency()

grantGroupPermission()

isReadOnly()

isRoot()

listGroupPermissions()

pauseAllUploads()

pauseUpload()

resumeAllUploads()

resumeUpload()

revokeGroupPermission()

setLinkAccess()

setUploadConcurrency()

transferOwnership()

update()

uploads()

Types

DocumentInfo

DocumentPermissionEntry

DocumentGroupPermissionEntry

DocumentAccessResult

DocumentCollectionInfo

Collections

addDocument()

addMember()

create()

delete()

get()

getAccess()

grantGroupPermission()

list()

listAll()

listCollectionsForDocument()

listDocuments()

listPendingInvitations()

removeDocument()

removeMember()

revokeGroupPermission()

update()

Types

CollectionInfo

CollectionDocumentInfo

CollectionGroupPermissionInfo

CollectionMemberInfo

CollectionAccessInfo

Users & Groups

getBasic()

getProfiles()

lookup()

cacheInfo()

clearCache()

get()

ownedDocuments()

sharedDocuments()

update()

uploadAvatar()

get()

addMember()

create()

delete()

get()

list()

listDatabases()

listDocuments()

listMembers()

listPendingInvitations()

listUserMemberships()

removeMember()

update()

create()

delete()

get()

list()

update()

Types

BasicUserInfo

UserProfile

SessionInfo

GroupInfo

GroupMemberInfo

GroupMembershipInfo

GroupDocumentInfo

GroupTypeConfigInfo

Authentication

checkOAuthAvailable()

emailSignInRequest()

getAppConfig()

getAuthConfig()

getAuthPersistenceInfo()

getAuthState()

getRootDocId()

getToken()

getUserId()

handleOAuthCallback()

isAuthenticated()

logout()

magicLinkVerify()

otpVerify()

passkeyAuthFinish()

passkeyAuthStart()

passkeyDelete()

passkeyList()

passkeyRegisterFinish()

passkeyRegisterStart()

passkeyUpdate()

setToken()

startOAuthFlow()

waitForAuthBootstrap()

waitForAuthReady()

waitForUserId()

exchangeOAuthCode()

Types

AuthError

AuthStateEvent

JsBaoError

Server Functions

FunctionsAPI

FunctionInvokeOptions

FunctionInvokeResult

FunctionInvokeLimits

FunctionStartOptions

FunctionStartResult

FunctionWaitOptions

FunctionRunRef

FunctionRun

FunctionRunError

FunctionRunStatus

Analytics

flush()

logEvent()

logSnapshot()

setAppVersionOverride()

setPlanOverride()

Types

AnalyticsAutoEventsOptions

AnalyticsEventInput

Blobs & Files

delete()

downloadUrl()

get()

hasServiceWorkerControl()

list()

pauseAll()

pauseUpload()

prefetch()

proxyUrl()

read()

resumeAll()

resumeUpload()

upload()

uploadFile()

uploads()

Types

BlobUploadSourceOptions

BlobUploadResult

BlobListResult

BlobUploadStatus

BlobReadOptions

BlobPrefetchOptions

BlobProxyUrlOptions

BlobUploadProgressEvent

BlobUploadCompletedEvent

BlobUploadFailedEvent

Offline & Cache

clear

clearAll

fetchCached

fetchHttp

info

key

Types

StorageProvider

Rule Sets

create()

debug()

delete()

get()

list()

schema()

test()

update()

Types

RuleSetInfo

RuleSetSchema

RuleSetTestResult

RuleSetDebugResult

TraceEntry

TriggerDefInfo

ModelRulesInfo

Other Types

AcceptInviteResult

AcquireOptions

AddManagerParams

AggregateDefinition

AggregateOperation

AppInvitationInfo

ApplyToQueryAction

ApplyToQueryDefinition

ApplyToQuerySource

AuthRefreshDeferredEvent

AwarenessEvent

BatchBlobDeleteResult

BatchUserProfile

BlobBucketInfo

BlobBucketsAPI

BlobDownloadUrlParams

BlobInfo

BlobListOptions

BlobListParams

BlobManager

BlobSignedUrlResult

BlobsQueueDrainedEvent

BlobUploadParams

BlobUploadPausedEvent

BlobUploadRequest

BlockingAcquireOptions

BucketBlobListResult

BucketBlobUploadResult

CelContextResult

ChannelMessageEvent

ChannelSubscribeFailedEvent

ChannelSubscription

ClaimApplyOptions

ClaimApplyResult

CollectionTypeConfigInfo

CollectionTypeConfigsAPI

ConfirmApplyOptions

ConfirmApplyResult

CountDefinition

CreateBlobBucketParams

CreateCollectionParams

CreateCollectionTypeConfigParams

CreateCronTriggerParams

CreateDatabaseParams

CreateDatabaseTypeConfigParams

CreateDocumentOptions

CreateGroupParams

CreateGroupTypeConfigParams

CreateInvitationParams

CreateOfflineOptions

CreateOperationParamsOf

CreateRuleSetParams

CreateWithAliasOptions

CronTriggerInfo

CronTriggerListResult

CronTriggersAPI

CsvImportOptions

CsvImportProgress

CsvImportResult

DatabaseChangeEvent

DatabaseChangePayload

DatabaseConfig

DatabaseGroupPermissionEntry

DatabaseInfo

DatabaseOperationInfoOf

DatabaseOwnershipTransferResult

DatabasePermissionEntry

DatabasesAPI

DatabaseSubscribeOptions

DatabaseTypeConfigInfo

DatabaseTypeConfigsAPI

DebugRuleSetParams

DeclaredManifestPathFrom

DeclaredManifestPathRootFrom

DeclaredMetadataManifest

DeferredCollectionAdd

DeferredDocumentGrant

DeferredGrantListOptions

DeferredGrantListResult

DeferredGrantRevokeResult

DeferredGroupAdd

DeferredGroupGrant

DeferredPermissionGrant

DeleteDocumentOptions

DirectCollectionAdd

DirectGroupAdd

DirectMessageEvent

DirectPermissionGrant

DiscoveredConstraint

DiscoveredField

DiscoveredModel

DiscoveredRelationship

DiscoveredSchema

DOClientEngine

DocumentAccessRequest

DocumentAccessRequestResponse

DocumentAliasesAPI

DocumentAliasInfo

DocumentClosedEvent

DocumentCreateCommitFailedEvent

DocumentDebugSnapshot

DocumentEvent

DocumentFormatMismatchEvent

DocumentIngestChunkUpload

DocumentIngestChunkUploadResult

DocumentIngestCounterBucket

DocumentIngestPage

DocumentIngestsAPI

DocumentIngestSession

DocumentIngestStageCounters

DocumentListPage

DocumentLoadedEvent

DocumentMetadataChangedEvent

DocumentOfflineWritesResolvedEvent

DocumentSnapshotBuild

DocumentSnapshotLoadEvent

DocumentSnapshotPage

DocumentSnapshotsAPI

DocumentSyncStateChangedEvent

DocumentWriteRefusedEvent

DoDb

EnableOfflineAccessOptions

EvictAllDocumentsOptions

EvictAllLocalOptions

EvictDocumentOptions

ExecuteOperationOptions

ExecutePromptOptions

ExecutePromptResult

FetchCachedOptions

GetMeOptions

GetOrCreateWithAliasOptions

GetUserOptions

GetWorkflowStatusOptions

GoOfflineOptions

GoogleClientConfig

GoogleClientsConfig

GrantCollectionGroupPermissionParams

GrantDatabaseGroupPermissionParams

GrantGroupPermissionParams

GrantPermissionParams

GroupDatabaseInfo

IntegrationCallRequest

IntegrationCallResponse

IntegrationsAPI

InvitationListOptions

InvitationListResult

InvitationQuota

InvitationsAPI

LinkAccessResult

ListCollectionsOptions

ListDatabasesOptions

ListGroupsOptions

ListLocalDocumentsOptions

ListResult

ListRuleSetsOptions

ListUserMembershipsOptions

ListWorkflowRunsOptions

ListWorkflowRunsResult

ListWorkflowStepRunsOptions

ListWorkflowStepRunsResult

LocalDocumentEntry

LocalMetadataEntry

LockContention

LockHandle

LockListEntry

LockListResult

LocksAPI

LogoutOptions

MeUpdatedEvent

MeUpdateFailedEvent

ModelFieldInfo

MutationDefinition

MutationOperation

NetworkModeEvent

NotificationEvent

NotificationInfo

NotificationListOptions

NotificationListResult

NotificationsAPI

NotificationSendResult

NotificationTokenAttempt

OfflineAuthEnabledEvent

OfflineAuthExpiringSoonEvent

OfflineAuthFailedEvent

OfflineAuthRenewedEvent

OfflineAuthUnlockedEvent

OperationDefinitionByType

OwnedDocumentsOptions

PaginatedResult

PaginationOptions

PathDeclaration

PendingApply

PendingCollectionInvitationEntry

PendingCreateCommittedEvent

PendingCreateFailedEvent

PendingGroupInvitationEntry

PendingInvitationEntry

PermissionEvent

PermissionUpdateResult

PipelineAggregateStep

PipelineCountStep

PipelineDefinition

PipelineQueryStep

PromptsAPI

PushDeviceInfo

QueryDefinition

RegisterPushDeviceParams

ReleaseApplyOptions

ReleaseApplyResult

ReleaseResult

RenewResult

RequestOptions

ResolveAliasParams

ResourceMetadataAPI

ResourceMetadataBatchParams

ResourceMetadataBatchRequestItem

ResourceMetadataBatchResult

ResourceMetadataDeleteResult

ResourceMetadataListEntry

ResourceMetadataListResult

ResourceMetadataResolveParams

ResourceMetadataWriteResult

RevokeOfflineGrantOptions

RuleLoads

RunSyncWorkflowOptions

RunSyncWorkflowResult

SaveOptions

SchemaDiscoveredEvent

SendNotificationParams

SetAliasParams

SharedDocument

SharedDocumentListResult

SharedDocumentsOptions

StartWorkflowOptions

StartWorkflowResult

StatusChangedEvent

StorageRecord

SyncEvent

SyncMetadataOptions

TerminateWorkflowOptions

TestRuleSetParams

UpdateBlobBucketParams

UpdateCollectionParams

UpdateCollectionTypeConfigParams

UpdateCronTriggerParams

UpdateDatabaseParams

UpdateDatabaseTypeConfigParams

UpdateDocumentData

UpdateGroupParams

UpdateGroupTypeConfigParams

UpdateMeParams

UpdateOperationParams

UpdateRuleSetParams

WaitForAuthReadyOptions

WaitForUserIdOptions

WaitForWorkflowOptions

WaitForWorkflowResult

WorkflowDefineOptions

WorkflowRun

WorkflowRunError

WorkflowsAPI

WorkflowStartedEvent

WorkflowStatusEvent

WorkflowStatusResult

WorkflowStatusSlice

WorkflowStepRunRecord

YjsPersistenceContext

YjsPersistenceProvider

On this page

js-bao-wss-client

js-bao-wss-client / DatabaseConfig

Interface: DatabaseConfig

Properties

options?

optional options?: DatabaseEngineOptions

type

type: DatabaseEngineType

Pager

Previous pageDatabaseChangePayload

Next pageDatabaseGroupPermissionEntry

Documentation validated against js-bao-wss-client 3.4.0 · js-bao 0.11.0 · primitive-admin 1.0.62 · primitive-app 3.1.0 — 2026-09-30