Skip to content
plasma
Search
Ctrl
K
Cancel
Select theme
Dark
Light
Auto
Select language
English
日本語
Getting Started
Install
Quick Start
Next Steps
Concepts
Mental Model
Optimistic vs Canonical
clientID vs clientGroupID
Internals
Schema and Mutators (types)
Push, Pull, Rebase (wire)
Change Log and Cookies (DDL)
Guides
Migrating from Drizzle
Schema
Query Builder
Mutators
Auth and Permissions
Migrations
Live Queries
Files and Blobs
Conflict Resolution
CRDT Columns
Encryption
Offline Mode
Multi-Region
Presence
Server-Side Operations
Devtools
Testing
Deployment
Reference
All Capabilities
All Capabilities
generated
client
src
functions
Function: classifyIvm()
Function: createIdbEngine()
Function: createPlasmaClient()
Function: createWebSocketSubscription()
Function: isIvmEligible()
interfaces
Interface: IdbEngine
Interface: IdbEngineOptions
Interface: IvmLiveQueryLike<T>
Interface: PlasmaClient<S, M>
Interface: PlasmaClientOptions<S, TCtx, M>
Interface: RowChange
Interface: RowDelta<T>
Interface: WebSocketSubscriptionOptions
client/src
type-aliases
Type Alias: ClientArg<T>
Type Alias: FileInput
Type Alias: IvmKind
Type Alias: PlasmaFileReadResult
Type Alias: SyncClientError
core
src
classes
Class: Column<TData, TNotNull, THasDefault, TTable>
Class: Db<S>
Class: DeleteBuilder<_T>
Class: InsertBuilder<T>
Class: MutatorValidationError
Class: SelectBuilder<TSources, TProjection>
Class: SelectStart<TProjection>
Class: UpdateBuilder<_T>
Class: UpdateStart<T>
functions
Function: and()
Function: applyInsertDefaults()
Function: asc()
Function: avg()
Function: bigint()
Function: blob()
Function: boolean()
Function: colRef()
Function: cookieCovers()
Function: count()
Function: crdtCounter()
Function: crdtIncrement()
Function: crdtLwwRegister()
Function: crdtOrSet()
Function: crdtPnCounter()
Function: createDb()
Function: decodeCookie()
Function: decodeFromSql()
Function: decodeRowFromSql()
Function: decryptField()
Function: decryptFieldPq()
Function: defineMutators()
Function: defineSchema()
Function: desc()
Function: encodeCookie()
Function: encodeForSql()
Function: encodeRowForSql()
Function: encryptField()
Function: encryptFieldPq()
Function: eq()
Function: file()
Function: getTableMeta()
Function: gt()
Function: gte()
Function: id()
Function: inArray()
Function: insecurePlaceholderProvider()
Function: int()
Function: invokeMutator()
Function: isBrokenFileRef()
Function: isEnvelope()
Function: isFileRef()
Function: isNotNull()
Function: isNull()
Function: isPqEnvelope()
Function: json()
Function: like()
Function: lt()
Function: lte()
Function: lwwRead()
Function: lwwSet()
Function: max()
Function: mergeCookie()
Function: mergeCrdtCounter()
Function: mergeLwwRegister()
Function: mergeOrSet()
Function: mergePnCounter()
Function: min()
Function: ne()
Function: not()
Function: or()
Function: orSetAdd()
Function: orSetHas()
Function: orSetRemove()
Function: orSetValues()
Function: packRegionVersion()
~~Function: plainDekProvider()~~
Function: pnDecrement()
Function: pnIncrement()
Function: pnRead()
Function: ref()
Function: storageRef()
Function: sum()
Function: sumCrdtCounter()
Function: table()
Function: text()
Function: unpackRegionVersion()
Function: validateEnvelope()
interfaces
Interface: Aggregate
Interface: AggregateExpr<T>
Interface: BrokenFileRef
Interface: ColRef
Interface: ColumnMeta
Interface: Compare
Interface: DbOptions<S>
Interface: DeleteQuery
Interface: EncryptionAAD
Interface: Engine
Interface: Envelope
Interface: FileColumnMeta
Interface: FileColumnOptions
Interface: FileRef
Interface: InList
Interface: InsertQuery
Interface: Join
Interface: Like
Interface: LiveQuery<T>
Interface: LogicalAnd
Interface: LogicalNot
Interface: LogicalOr
Interface: LwwRegister<T>
Interface: MutationEnvelope
Interface: MutatorObject<S, TCtx, TArgs>
Interface: MutatorOrigin
Interface: NoProjection
Interface: NullCheck
Interface: Ordering
Interface: OrSet<T>
Interface: OrTag
Interface: Param
Interface: PnCounterMap
Interface: PqEnvelope
Interface: PqHybridProvider
Interface: PullRequest
Interface: PullResponse
Interface: PushRequest
Interface: PushResponse
Interface: RowDelta<T>
Interface: SelectQuery
Interface: StandardSchemaIssue
Interface: StandardSchemaV1<Input, Output>
Interface: StorageRef
Interface: TableAuth<TCtx>
Interface: TableMeta<TName, TCols>
Interface: TableOptions<TCtx>
Interface: UpdateQuery
core/src
type-aliases
Type Alias: AggregateFn
Type Alias: AnyColumn
Type Alias: AnyTable
Type Alias: CausalCookie
Type Alias: ChangeOp
Type Alias: ColumnKind
Type Alias: CompareOp
Type Alias: ConflictResolver
Type Alias: CrdtCounterMap
Type Alias: Direction
Type Alias: Expr
Type Alias: InferColumnData<C>
Type Alias: InferColumnHasDefault<C>
Type Alias: InferColumnNotNull<C>
Type Alias: InferInsertRow<T>
Type Alias: InferRow<T>
Type Alias: InferUpdateRow<T>
Type Alias: JoinKind
Type Alias: Mutator<S, TCtx, TArgs>
Type Alias: MutatorFn<S, TCtx, TArgs>
Type Alias: Mutators<S, TCtx>
Type Alias: OnDeleteAction
Type Alias: Projection
Type Alias: ProjectionItem
Type Alias: ProjectionValue
Type Alias: Query
Type Alias: Schema<T>
Type Alias: SelectRow<TSources, TProjection>
Type Alias: StandardSchemaResult<Output>
Type Alias: SyncCookie
Type Alias: SyncError
Type Alias: Table<TName, TCols>
variables
Variable: PROTOCOL_VERSION
Variable: TABLE_META
Variable: unimplementedEngine
devtools
src
functions
Function: attachDevtoolsBridge()
Function: isDevtoolsMessage()
Function: PlasmaDevtools()
Function: useDevtoolsSnapshot()
interfaces
Interface: AttachOptions<S>
Interface: CommandMessage
Interface: CommandResultMessage
Interface: DevtoolsSnapshot
Interface: DevtoolsStateSnapshot
Interface: HelloMessage
Interface: PlasmaDevtoolsProps<S, M>
Interface: StateUpdateMessage
devtools/src
type-aliases
Type Alias: DevtoolsMessage
variables
Variable: PLASMA_DEVTOOLS_SOURCE
react
src
functions
Function: PlasmaProvider()
Function: useLiveQuery()
Function: useMutation()
Function: usePlasma()
Function: usePlasmaFile()
interfaces
Interface: PlasmaProviderProps<S, M>
Interface: UseMutationResult<M, K>
react/src
type-aliases
Type Alias: FileHandle
plasma
server
src
classes
Class: MemorySequencerStorage
Class: MigrationRefused
Class: PlasmaAuthorizationError
Class: SequencerDO
Class: SequencerDoSimulator
functions
Function: advanceCookieFromChanges()
Function: compactChangeLog()
Function: createServerDb()
Function: createSyncHandler()
Function: ensureRegionVersionsTable()
Function: ensureSchema()
Function: fromBetterSqlite3()
Function: fromD1()
Function: gcOrphanedBlobs()
Function: r2Storage()
Function: reconcileBlobRefs()
Function: reserveRegionVersions()
Function: runMigrations()
Function: schemaTableNames()
Function: serverLiveSelect()
Function: snapshotAsOf()
interfaces
Interface: AuthorizePolicy
Interface: CompactionResult
Interface: GcOrphanedBlobsOptions
Interface: GcResult
Interface: MigrationEvent
Interface: MigrationResult
Interface: PresignedDownload
Interface: PresignedUpload
Interface: R2StorageConfig
Interface: ReconcileBlobRefsOptions<S>
Interface: ReconcileResult
Interface: ReserveResult
Interface: RunMigrationsOptions<S>
Interface: SchemaDiff
Interface: SequencerState
Interface: SequencerStorage
Interface: ServerDbOptions<S>
Interface: ServerLiveHandle
Interface: ServerLiveOptions<T>
Interface: SqlDialect
Interface: SqlEngineOptions
Interface: SqlExecutor
Interface: SqlWriteObserver
Interface: Storage
Interface: StorageDownload
Interface: StorageDownloadParams
Interface: StorageObjectMeta
Interface: StorageRange
Interface: StorageUploadParams
Interface: SyncHandlerOptions<S, TCtx>
server/src
type-aliases
Type Alias: AuthResult<TCtx>
Type Alias: Mutator<S, TCtx, TArgs>
Type Alias: Mutators<S, TCtx>
Type Alias: SqlWriteEvent
Type Alias: SyncServerError
variables
Variable: postgresDialect
Variable: REGION_VERSIONS_TABLE
Variable: sqliteDialect
@sh1n4ps/plasma-client
@sh1n4ps/plasma-core
@sh1n4ps/plasma-devtools
@sh1n4ps/plasma-react
@sh1n4ps/plasma-server
Recipes
Todo App
Offline Notes
Troubleshooting
Auth Denied
Blob Upload Stuck
Cloudflare Deploy
Schema Mismatch
Sync Errors
Reference
Changelog
Roadmap
Select theme
Dark
Light
Auto
Select language
English
日本語
Variable: TABLE_META
Variable: TABLE_META
Section titled “Variable: TABLE_META”
const
TABLE_META
: unique
symbol
Defined in:
core/src/schema/table.ts:37