Skip to main content

Home > git-documentdb

git-documentdb package#

Offline-first Database that Syncs with Git

Classes#

ClassDescription
CollectionDocuments under a collectionPath are gathered together in a collection.
GitDocumentDBMain class of GitDocumentDB
RemoteRepositoryRemote repository class
SyncSynchronizer class
TaskQueueTaskQueue
ValidatorValidator Class

Functions#

FunctionDescription
encodeToGitRemoteName(remoteURL)encodeToGitRemoteName

Interfaces#

InterfaceDescription
CollectionInterfaceInterface for Collection
CRUDInterfaceInterface for GitDocumentDB CRUD
GitDDBInterfaceInterface of GitDocumentDB body
SyncEventInterfaceInterface for SyncEvent
SyncInterfaceInterface of Sync

Namespaces#

NamespaceDescription
ErrNamespace for errors
RemoteErrRemoteError

Variables#

VariableDescription
DATABASE_CREATOR
DATABASE_VERSION
DEFAULT_COMBINE_DB_STRATEGY
DEFAULT_CONFLICT_RESOLUTION_STRATEGY
DEFAULT_LOCAL_DIR
DEFAULT_LOG_LEVEL
DEFAULT_SYNC_INTERVAL
DUPLICATED_FILE_POSTFIX
FILE_CREATE_TIMEOUT
FILE_REMOVE_TIMEOUT
FIRST_COMMIT_MESSAGE
FRONT_MATTER_POSTFIX
GIT_DOCUMENTDB_INFO_ID
GIT_DOCUMENTDB_METADATA_DIR
JSON_POSTFIX
MAX_FILE_PATH_LENGTH
MINIMUM_SYNC_INTERVAL
NETWORK_RETRY_INTERVAL
NETWORK_RETRY
NETWORK_TIMEOUT
PUT_APP_INFO_MESSAGE
RemoteEngineRemoteEngine
SET_DATABASE_ID_MESSAGE
SHORT_SHA_LENGTH
YAML_POSTFIX

Type Aliases#

Type AliasDescription
AcceptedConflictAccepted conflict
BinaryDocMetadataMetadata for BinaryDoc
ChangedFileUnion type of changed files in a merge operation
ChangedFileDeleteDeleted file in a merge operation
ChangedFileInsertInserted file in a merge operation
ChangedFileUpdateUpdated file in a merge operation
CollectionOptionsOptions for Collection constructor
CollectionPathCollectionPath
CombineDbStrategiesBehavior when combining inconsistent DBs Default is 'combine-head-with-theirs'.
ConflictResolutionStrategiesStrategy for resolving conflicts
ConflictResolutionStrategyLabels
ConnectionSettingsConnection settings for RemoteOptions
ConnectionSettingsGitHubConnection settings for GitHub
ConnectionSettingsNoneConnection settings do not exist.
ConnectionSettingsSSHConnection settings for SSH
DatabaseCloseOptionHow to close a database
DatabaseInfoDatabase information
DatabaseOpenResultResult of opening database
DatabaseOptionsDatabase Options
DeleteOptionsOptions for delete
DeleteResultResult of delete()
DeleteResultBinary
DeleteResultJsonDoc
DeleteResultText
DocUnion type of Doc types
DocMetadataUnion type of Document metadata
DocTypeType of document
DuplicatedFileDuplicated file in combining operation
FatBinaryDocBinary (Uint8Array) with metadata
FatDocUnion type of documents with a metadata
FatJsonDocJsonDoc with metadata
FatTextDocText (string) with metadata
FindOptionsOptions for find and findFatDoc
GetOptionsOptions for get APIs (get, getFatDoc, getOldRevision, getFatDocOldRevision, getHistory, getFatDocHistory)
HistoryFilterFilter for file history
HistoryOptionsOptions for getHistory() and getFatDocHistory()
ICollectionType for Collection Class
JsonDiffPatchOptionsJsonDiffPatchOptions
JsonDocThe type for a JSON document that is stored in a database
JsonDocMetadataMetadata for JsonDoc
NormalizedCommitNormalized Commit
OpenOptionsDatabase open options
PluginTypesPlugin types
PutOptionsOptions for put APIs (put, update, insert, putFatDoc, updateFatDoc, and insertFatDoc)
PutResultResult of put APIs (put, update, insert, putFatDoc, updateFatDoc, and insertFatDoc)
PutResultBinary
PutResultJsonDoc
PutResultText
RemoteOptionsOptions for Sync class
SchemaSchema for specific document type
SerializeFormatLabelFormat for serialization
SyncCallbackUnion type of SyncEventCallbacks
SyncChangeCallbackCallback of 'change' event
SyncCombineDatabaseCallbackCallback of 'combine' event
SyncCompleteCallbackCallback of 'complete' event
SyncDirectionSynchronization direction
SyncErrorCallbackCallback of 'error' event
SyncEventUnion type of SyncEvents
SyncLocalChangeCallbackCallback of 'localChange' event
SyncPauseCallbackCallback of 'pause' event
SyncRemoteChangeCallbackCallback of 'remoteChange' event
SyncResultUnion type of results from trySync() and tryPush()
SyncResultCancelSynchronization was canceled.
SyncResultCombineDatabaseSynchronization combined databases.
SyncResultFastForwardMergeSynchronization invoked fast-forward merge.
SyncResultMergeAndPushSynchronization created a merge commit and pushed it.
SyncResultMergeAndPushErrorSynchronization created a merge commit and failed to push it.
SyncResultNopSynchronization did nothing.
SyncResultPushSynchronization pushed commits.
SyncResultResolveConflictsAndPushSynchronization resolved conflicts, created a merge commit, and pushed it.
SyncResultResolveConflictsAndPushErrorSynchronization resolved conflicts, created a merge commit, and failed to push it.
SyncResumeCallbackCallback of 'resume' event
SyncStartCallbackCallback of 'start' event
TaskLabelUnion type of properties of TaskStatistics
TaskMetadataMetadata of a task
TaskStatisticsTask statistics after opening database
TextDocMetadataMetadata for TextDoc
WriteOperationWrite operation in resolving conflicts