@couchbase-community/ionic-couchbase-lite

Integration for Couchbase Lite in Ionic apps

Install

npm install @couchbase-community/ionic-couchbase-lite
npx cap sync

API

• Plugin_Configure(...)
• Database_Open(...)
• Database_Save(...)
• Database_GetCount(...)
• Database_GetPath(...)
• Database_Copy(...)
• Database_CreateIndex(...)
• Database_DeleteIndex(...)
• Database_GetIndexes(...)
• Database_Exists(...)
• Database_Close(...)
• Database_Compact(...)
• Database_Delete(...)
• Database_PurgeDocument(...)
• Database_DeleteDocument(...)
• Database_GetDocument(...)
• Database_AddChangeListener(...)
• Database_SetLogLevel(...)
• Database_SetFileLoggingConfig(...)
• Document_GetBlobContent(...)
• Query_Execute(...)
• ResultSet_Next(...)
• ResultSet_NextBatch(...)
• ResultSet_AllResults(...)
• ResultSet_Cleanup(...)
• Replicator_Create(...)
• Replicator_Start(...)
• Replicator_Restart(...)
• Replicator_AddChangeListener(...)
• Replicator_AddDocumentListener(...)
• Replicator_Stop(...)
• Replicator_ResetCheckpoint(...)
• Replicator_GetStatus(...)
• Replicator_Cleanup(...)
• Interfaces
• Enums

Plugin_Configure(...)

Plugin_Configure(args: PluginConfigureArgs) => any

| Param | Type | | ---------- | ------------------------------------------------------------------- | | args | PluginConfigureArgs |

Returns: any

Database_Open(...)

Database_Open(args: DatabaseOpenArgs) => any

| Param | Type | | ---------- | ------------------------------------------------------------- | | args | DatabaseOpenArgs |

Returns: any

Database_Save(...)

Database_Save(args: DatabaseSaveArgs) => any

| Param | Type | | ---------- | ------------------------------------------------------------- | | args | DatabaseSaveArgs |

Returns: any

Database_GetCount(...)

Database_GetCount(args: DatabaseArgs) => any

| Param | Type | | ---------- | ----------------------------------------------------- | | args | DatabaseArgs |

Returns: any

Database_GetPath(...)

Database_GetPath(args: DatabaseArgs) => any

| Param | Type | | ---------- | ----------------------------------------------------- | | args | DatabaseArgs |

Returns: any

Database_Copy(...)

Database_Copy(args: DatabaseCopyArgs) => any

| Param | Type | | ---------- | ------------------------------------------------------------- | | args | DatabaseCopyArgs |

Returns: any

Database_CreateIndex(...)

Database_CreateIndex(args: DatabaseCreateIndexArgs) => any

| Param | Type | | ---------- | --------------------------------------------------------------------------- | | args | DatabaseCreateIndexArgs |

Returns: any

Database_DeleteIndex(...)

Database_DeleteIndex(args: DatabaseDeleteIndexArgs) => any

| Param | Type | | ---------- | --------------------------------------------------------------------------- | | args | DatabaseDeleteIndexArgs |

Returns: any

Database_GetIndexes(...)

Database_GetIndexes(args: DatabaseArgs) => any

| Param | Type | | ---------- | ----------------------------------------------------- | | args | DatabaseArgs |

Returns: any

Database_Exists(...)

Database_Exists(args: DatabaseExistsArgs) => any

| Param | Type | | ---------- | ----------------------------------------------------------------- | | args | DatabaseExistsArgs |

Returns: any

Database_Close(...)

Database_Close(args: DatabaseArgs) => any

| Param | Type | | ---------- | ----------------------------------------------------- | | args | DatabaseArgs |

Returns: any

Database_Compact(...)

Database_Compact(args: DatabaseArgs) => any

| Param | Type | | ---------- | ----------------------------------------------------- | | args | DatabaseArgs |

Returns: any

Database_Delete(...)

Database_Delete(args: DatabaseArgs) => any

| Param | Type | | ---------- | ----------------------------------------------------- | | args | DatabaseArgs |

Returns: any

Database_PurgeDocument(...)

Database_PurgeDocument(args: DatabasePurgeDocumentArgs) => any

| Param | Type | | ---------- | ------------------------------------------------------------------------------- | | args | DatabasePurgeDocumentArgs |

Returns: any

Database_DeleteDocument(...)

Database_DeleteDocument(args: DatabaseDeleteDocumentArgs) => any

| Param | Type | | ---------- | --------------------------------------------------------------------------------- | | args | DatabaseDeleteDocumentArgs |

Returns: any

Database_GetDocument(...)

Database_GetDocument(args: DatabaseGetDocumentArgs) => any

| Param | Type | | ---------- | --------------------------------------------------------------------------- | | args | DatabaseGetDocumentArgs |

Returns: any

Database_AddChangeListener(...)

Database_AddChangeListener(args: DatabaseArgs, cb: PluginCallback) => any

| Param | Type | | ---------- | --------------------------------------------------------------------------- | | args | DatabaseArgs | | cb | (data: PluginResultData, error?: PluginResultError) => void |

Returns: any

Database_SetLogLevel(...)

Database_SetLogLevel(args: DatabaseSetLogLevelArgs) => any

| Param | Type | | ---------- | --------------------------------------------------------------------------- | | args | DatabaseSetLogLevelArgs |

Returns: any

Database_SetFileLoggingConfig(...)

Database_SetFileLoggingConfig(args: DatabaseSetFileLoggingConfigArgs) => any

| Param | Type | | ---------- | --------------------------------------------------------------------------------------------- | | args | DatabaseSetFileLoggingConfigArgs |

Returns: any

Document_GetBlobContent(...)

Document_GetBlobContent(args: DocumentGetBlobContentArgs) => any

| Param | Type | | ---------- | --------------------------------------------------------------------------------- | | args | DocumentGetBlobContentArgs |

Returns: any

Query_Execute(...)

Query_Execute(args: QueryExecuteArgs) => any

| Param | Type | | ---------- | ------------------------------------------------------------- | | args | QueryExecuteArgs |

Returns: any

ResultSet_Next(...)

ResultSet_Next(args: ResultSetNextArgs) => any

| Param | Type | | ---------- | --------------------------------------------------------------- | | args | ResultSetNextArgs |

Returns: any

ResultSet_NextBatch(...)

ResultSet_NextBatch(args: ResultSetNextBatchArgs) => any

| Param | Type | | ---------- | ------------------------------------------------------------------------- | | args | ResultSetNextBatchArgs |

Returns: any

ResultSet_AllResults(...)

ResultSet_AllResults(args: ResultSetAllResultsArgs, callback: PluginCallback) => any

| Param | Type | | -------------- | --------------------------------------------------------------------------- | | args | ResultSetAllResultsArgs | | callback | (data: PluginResultData, error?: PluginResultError) => void |

Returns: any

ResultSet_Cleanup(...)

ResultSet_Cleanup(args: ResultSetCleanupArgs) => any

| Param | Type | | ---------- | --------------------------------------------------------------------- | | args | ResultSetCleanupArgs |

Returns: any

Replicator_Create(...)

Replicator_Create(args: ReplicatorCreateArgs) => any

| Param | Type | | ---------- | --------------------------------------------------------------------- | | args | ReplicatorCreateArgs |

Returns: any

Replicator_Start(...)

Replicator_Start(args: ReplicatorArgs) => any

| Param | Type | | ---------- | --------------------------------------------------------- | | args | ReplicatorArgs |

Returns: any

Replicator_Restart(...)

Replicator_Restart(args: ReplicatorArgs) => any

| Param | Type | | ---------- | --------------------------------------------------------- | | args | ReplicatorArgs |

Returns: any

Replicator_AddChangeListener(...)

Replicator_AddChangeListener(args: ReplicatorArgs, cb: PluginCallback) => any

| Param | Type | | ---------- | --------------------------------------------------------------------------- | | args | ReplicatorArgs | | cb | (data: PluginResultData, error?: PluginResultError) => void |

Returns: any

Replicator_AddDocumentListener(...)

Replicator_AddDocumentListener(args: ReplicatorArgs, cb: PluginCallback) => any

| Param | Type | | ---------- | --------------------------------------------------------------------------- | | args | ReplicatorArgs | | cb | (data: PluginResultData, error?: PluginResultError) => void |

Returns: any

Replicator_Stop(...)

Replicator_Stop(args: ReplicatorArgs) => any

| Param | Type | | ---------- | --------------------------------------------------------- | | args | ReplicatorArgs |

Returns: any

Replicator_ResetCheckpoint(...)

Replicator_ResetCheckpoint(args: ReplicatorArgs) => any

| Param | Type | | ---------- | --------------------------------------------------------- | | args | ReplicatorArgs |

Returns: any

Replicator_GetStatus(...)

Replicator_GetStatus(args: ReplicatorArgs) => any

| Param | Type | | ---------- | --------------------------------------------------------- | | args | ReplicatorArgs |

Returns: any

Replicator_Cleanup(...)

Replicator_Cleanup(args: ReplicatorArgs) => any

| Param | Type | | ---------- | --------------------------------------------------------- | | args | ReplicatorArgs |

Returns: any

Interfaces

PluginConfigureArgs

| Prop | Type | | ------------ | ---------------- | | config | any |

DatabaseOpenArgs

| Prop | Type | | ------------ | ---------------------------------- | | config | DatabaseConfiguration |

DatabaseSaveArgs

| Prop | Type | | -------------- | ------------------------------------ | | id | string | | document | { [key: string]: any; } |

DatabaseArgs

| Prop | Type | | ---------- | ------------------- | | name | string |

DatabaseCopyArgs

| Prop | Type | | ------------- | ---------------------------------- | | path | string | | newName | string | | config | DatabaseConfiguration |

DatabaseCreateIndexArgs

| Prop | Type | | --------------- | ------------------- | | indexName | string | | index | any |

DatabaseDeleteIndexArgs

| Prop | Type | | --------------- | ------------------- | | indexName | string |

DatabaseExistsArgs

| Prop | Type | | ---------------- | ------------------- | | existsName | string | | directory | string |

DatabasePurgeDocumentArgs

| Prop | Type | | ----------- | ------------------- | | docId | string |

DatabaseDeleteDocumentArgs

| Prop | Type | | ------------------------ | ----------------------------------------------------------------- | | docId | string | | document | { [key: string]: any; } | | concurrencyControl | ConcurrencyControl |

DatabaseGetDocumentArgs

| Prop | Type | | ----------- | ------------------- | | docId | string |

PluginListenerHandle

| Prop | Type | | ------------ | ------------------------- | | remove | () => any |

DatabaseSetLogLevelArgs

| Prop | Type | | -------------- | ------------------- | | domain | string | | logLevel | number |

DatabaseSetFileLoggingConfigArgs

| Prop | Type | | ------------ | --------------------------------------------------------------------------------------------- | | config | DatabaseFileLoggingConfiguration |

DatabaseFileLoggingConfiguration

| Prop | Type | | -------------------- | -------------------- | | level | number | | directory | string | | maxRotateCount | number | | maxSize | number | | usePlaintext | boolean |

DocumentGetBlobContentArgs

| Prop | Type | | ---------------- | ------------------- | | documentId | string | | key | string |

QueryExecuteArgs

| Prop | Type | | ----------------- | ------------------------------------- | | query | any | | columnNames | { [name: string]: any; } |

ResultSetNextArgs

| Prop | Type | | ----------------- | ------------------- | | resultSetId | string |

ResultSetNextBatchArgs

| Prop | Type | | ----------------- | ------------------- | | resultSetId | string |

ResultSetAllResultsArgs

| Prop | Type | | ----------------- | ------------------- | | resultSetId | string |

ResultSetCleanupArgs

| Prop | Type | | ----------------- | ------------------- | | resultSetId | string |

ReplicatorCreateArgs

| Prop | Type | | ------------ | ---------------- | | config | any |

ReplicatorArgs

| Prop | Type | | ------------------ | ------------------- | | replicatorId | string |

Enums

ConcurrencyControl

| Members | Value | | ---------------------- | -------------- | | LAST_WRITE_WINS | 0 | | FAIL_ON_CONFLICT | 1 |