- GC
- GC.Data
- GC.Pivot
- GC.Spread.Pivot
- GC.Spread.Slicers
- GC.Spread.CalcEngine
- GC.Spread.Commands
- GC.Spread.Common
- GC.Spread.Formatter
- GC.Spread.Report
- GC.Spread.Sheets
- GC.Spread.Sheets.AutoMerge
- GC.Spread.Sheets.Barcode
- GC.Spread.Sheets.IO
- GC.Spread.Sheets.Bindings
- GC.Spread.Sheets.CalcEngine
- GC.Spread.Sheets.Search
- GC.Spread.Sheets.CellState
- GC.Spread.Sheets.CellTypes
- GC.Spread.Sheets.Charts
- GC.Spread.Sheets.DataCharts
- GC.Spread.Sheets.Commands
- GC.Spread.Sheets.Comments
- GC.Spread.Sheets.ThreadedComments
- GC.Spread.Sheets.ConditionalFormatting
- GC.Spread.Sheets.ContextMenu
- GC.Spread.Sheets.Collaboration
- GC.Spread.Sheets.DataValidation
- GC.Spread.Sheets.DataRange
- GC.Spread.Sheets.Fill
- GC.Spread.Sheets.Filter
- GC.Spread.Sheets.FloatingObjects
- GC.Spread.Sheets.FormulaTextBox
- GC.Spread.Sheets.Hyperlink
- GC.Spread.Sheets.OutlineColumn
- GC.Spread.Sheets.Outlines
- GC.Spread.Sheets.FormulaPanel
- GC.Spread.Sheets.PDF
- GC.Spread.Sheets.InputMask
- GC.Spread.Sheets.Print
- GC.Spread.Sheets.NameBox
- GC.Spread.Sheets.Shapes
- GC.Spread.Sheets.Slicers
- GC.Spread.Sheets.Sparklines
- GC.Spread.Sheets.StatusBar
- GC.Spread.Sheets.Tables
- GC.Spread.Sheets.TableSheet
- GC.Spread.Sheets.Touch
- GC.Spread.Sheets.Designer
- GC.Spread.Sheets.GanttSheet
- GC.Spread.Sheets.AI
-
Collaboration
- js-collaboration
- js-collaboration-client
-
js-collaboration-ot
- classes
- enums
-
interfaces
- ICommitSnapshot
- IContext
- ICustomOptions
- ICreateComponent
- IDatabaseAdapter
- IMilestoneDatabaseAdapter
- IDocConfig
- IDocHookContext
- IDocMiddlewareContext
- IDocMiddlewareContextBase
- IDocReadOpMiddlewareContext
- IDocReadSnapshotsMiddlewareContext
- IDocReceiveMiddlewareContext
- IDocReplyMiddlewareContext
- IDocSubmitMiddlewareContext
- IDocument
- IErrorData
- IOp
- IReplyMessage
- IRequestMessage
- IRequestMessageExtra
- ISnapshot
- ISnapshotFragmentsRequest
- ISnapshotFragmentsChanges
- ISnapshotMeta
- OT_Type
- IReadOpRequest
- IRestoreComponent
- Overview
- js-collaboration-ot-client
- js-collaboration-ot-postgres
- js-collaboration-ot-sqlite
- js-collaboration-presence
- js-collaboration-presence-client
- spread-sheets-collaboration
- spread-sheets-collaboration-client
- GC.Spread.Excel
IDatabaseAdapter
Interface: IDatabaseAdapter<S, T>
Defines the interface for a database adapter in operational transformation.
Type parameters
| Name | Type | Description |
|---|---|---|
S |
unknown |
The type of snapshot data. |
T |
unknown |
The type of operation data. |
Implemented by
Table of contents
Methods
Methods
close
▸ close(): Promise<void>
Closes the database connection.
Returns
Promise<void>
A promise that resolves when the database is closed.
commitOp
▸ commitOp(id, op, document, options?): Promise<boolean>
Commits an operation to the database.
Parameters
| Name | Type | Description |
|---|---|---|
id |
string |
The document ID. |
op |
IOp<T> |
The operation to commit. |
document |
IDocument |
The document metadata. |
options? |
unknown |
- |
Returns
Promise<boolean>
A promise resolving to true if the operation was committed, false otherwise.
commitSnapshot
▸ commitSnapshot(id, snapshot, options?): Promise<boolean>
Commits a snapshot to the database.
Parameters
| Name | Type | Description |
|---|---|---|
id |
string |
The document ID. |
snapshot |
ICommitSnapshot<S> |
The snapshot to commit. |
options? |
unknown |
- |
Returns
Promise<boolean>
A promise resolving to true if the snapshot was committed, false otherwise.
getCommittedOpVersion
▸ getCommittedOpVersion(id, to, op): Promise<null | number>
Retrieves the committed version of an operation, if it exists.
Parameters
| Name | Type | Description |
|---|---|---|
id |
string |
The document ID. |
to |
number |
The ending version to check up to. |
op |
IOp<unknown> |
The operation to verify. |
Returns
Promise<null | number>
A promise resolving to the committed version or null if not committed.
getDocument
▸ getDocument(id, options?): Promise<null | IDocument>
Retrieves document information by ID.
Parameters
| Name | Type | Description |
|---|---|---|
id |
string |
The document ID. |
options? |
unknown |
- |
Returns
Promise<null | IDocument>
A promise resolving to the document info or null if not found.
getFragment
▸ getFragment(id, fragmentId, options?): Promise<null | { data: null | S ; version: number }>
Retrieves a specific fragment of a document by ID.
Parameters
| Name | Type | Description |
|---|---|---|
id |
string |
The document ID. |
fragmentId |
string |
The ID of the fragment. |
options? |
unknown |
- |
Returns
Promise<null | { data: null | S ; version: number }>
| null>} Resolves to an object with fragment version and data, or null if the document does not exist. If the document exists but the fragment does not, data is null.
getOps
▸ getOps(id, from, to?, options?): Promise<IOp<T>[]>
Retrieves operations between two versions (inclusive of 'from', exclusive of 'to').
Parameters
| Name | Type | Description |
|---|---|---|
id |
string |
The document ID. |
from |
number |
The starting version. |
to? |
number |
- |
options? |
unknown |
- |
Returns
Promise<IOp<T>[]>
A promise resolving to an array of operations.
getSnapshot
▸ getSnapshot(id, options?): Promise<null | ISnapshot<S>>
Retrieves the snapshot of a document by ID.
Parameters
| Name | Type | Description |
|---|---|---|
id |
string |
The document ID. |
options? |
unknown |
- |
Returns
Promise<null | ISnapshot<S>>
A promise resolving to the snapshot or null if not found.