Class Database<Schema>

A Couchbase Lite database. Contains one or more named collections, which contain documents.

Call open to create a Database instance (the constructor is private.)

Type Parameters

Schema extends SchemaLike<Schema> = NoSchema
An optional interface type that improves type-safety of collection and document accessors. Its keys must be the names of the collections, and each value type is an interface that describes the properties of a document in that collection:
```
 interface MySchema {
   shoes: {style: string, foot: "left" | "right", size: number},
 }
```
If you don't give a schema, the collections property will accept any string as a key, and collections will use CBLDictionary as their document type.

Index

Properties

`Readonly`config

config: DatabaseConfig<Schema>

`Readonly`logger

logger: Logger

`Readonly`name

name: string

The database's name.

Accessors

collectionNames

get collectionNames(): readonly Extract<keyof Schema, string>[]
The names of the Collections in this Database.

Returns readonly Extract<keyof Schema, string>[]
- Defined in src/database/database.ts:312

collections

get collections(): { readonly [K in string]: Collection<Schema[K]> }
An object whose keys are collection names and values are Collections. In TypeScript, this object is typed accoring to the database's schema type, so accessing a nonexistent collection will result in a compile error, and Collection instances access from this will be typed according to their document schema.

Returns { readonly [K in string]: Collection<Schema[K]> }
- Defined in src/database/database.ts:296

defaultCollection

get defaultCollection(): Collection
Returns the Collection named "_default".

Returns Collection
Throws
if there is no such collection.
- Defined in src/database/database.ts:319

isOpen

get isOpen(): boolean
True if the database is open.

Returns boolean
- Defined in src/database/database.ts:223

Methods

[dispose]

"[dispose]"(): void
Allows Database to be used with the using statement:
```
{
    using db = new Database(config);
    // `db` will be closed implicitly when it exits scope
}
```
See: https://www.totaltypescript.com/typescript-5-2-new-keyword-using
Returns void
- Defined in src/database/database.ts:259

changeEncryptionKey

changeEncryptionKey(
password: string | undefined,
exceptProperties?: UnencryptedProperties,
): Promise<void>
Encrypts or decrypts a database, or changes the encryption key.
Parameters
- password: string | undefined
  The new password for encryption, or undefined to decrypt.
- OptionalexceptProperties: UnencryptedProperties
  Optional top-level properties to leave unencrypted, by collection (in addition to indexed properties, which cannot be encrypted.) Key is collection name, value is array or set of properties.
Returns Promise<void>
Throws
EncryptionError if it's already encrypted.
- Defined in src/database/database.ts:548

close

close(): void
Closes the database.

You MUST NOT call any instance methods after this except for reopen.

You MUST NOT use or keep reference to the Database's Collections; they're invalidated.

Returns void
- Defined in src/database/database.ts:240

closeAndDelete

closeAndDelete(): Promise<void>
Closes the database, then deletes its persistent storage.

Note: You can call reopen, and have an empty database.

Returns Promise<void>
- Defined in src/database/database.ts:264

countBlobs

countBlobs(): Promise<number>
Returns the number of blobs stored in the database.

Returns Promise<number>
- Defined in src/database/database.ts:619

createQuery

createQuery(select: string): Query<Schema>
Creates a Query object from a N1QL/SQL++ SELECT statement.
Parameters
- select: string
Returns Query<Schema>
- Defined in src/database/database.ts:384

decrypt

decrypt(): Promise<void>
Decrypts the database. (Same as encrypt(undefined).)

Returns Promise<void>
- Defined in src/database/database.ts:590

getCollection

getCollection(name: string): Collection
Returns the Collection object for the named collection.
Parameters
- name: string
Returns Collection
Throws
if there is no such collection.
- Defined in src/database/database.ts:303

performMaintenance

performMaintenance(type: "compact"): Promise<number>
Deletes all blobs that are no longer referenced by any documents.
Parameters
- type: "compact"
Returns Promise<number>
The number of blobs deleted.
- Defined in src/database/database.ts:626

reopen

reopen(password?: string): Promise<void>
Reopens the database after a close or closeAndDelete call.
Parameters
- Optionalpassword: string
  If the database is encrypted, you must provide the password.
Returns Promise<void>
- Defined in src/database/database.ts:228

`Static`debugMode

debugMode(debug: boolean): void
Enable's Dexie's debug mode, which provides meaningful stack backtraces in exceptions.
Parameters
- debug: boolean
Returns void
- Defined in src/database/database.ts:112

`Static`delete

delete(name: string): Promise<void>
Static method that deletes a database by name. You MUST close any open Database instance using it first.
Parameters
- name: string
Returns Promise<void>
- Defined in src/database/database.ts:274

`Static`open

open<Schema extends SchemaLike<Schema> = NoSchema>(
config: DatabaseConfig<Schema>,
): Promise<Database<Schema>>
Creates a Database instance and opens the database. If a local IndexedDB database with this name exists, it will be opened; otherwise a new one is created.
Type Parameters
- Schema extends SchemaLike<Schema> = NoSchema
  An optional interface type that improves type-safety of collection and document accessors. Its keys must be the names of the collections, and each value type is an interface that describes the properties of a document in that collection.
Parameters
- config: DatabaseConfig<Schema>
  The database configuration
Returns Promise<Database<Schema>>
- Defined in src/database/database.ts:123

`Static`useIndexedDB

useIndexedDB(
    indexedDB: IDBFactory,
    idbKeyRange: {
        prototype: IDBKeyRange;
        bound(
            lower: any,
            upper: any,
            lowerOpen?: boolean,
            upperOpen?: boolean,
        ): IDBKeyRange;
        lowerBound(lower: any, open?: boolean): IDBKeyRange;
        only(value: any): IDBKeyRange;
        upperBound(upper: any, open?: boolean): IDBKeyRange;
        new (): IDBKeyRange;
    },
): void
Call this to use a non-default implementation of IndexedDB. This is required in non-browser environments like Node, Bun and Deno! It should be called only once, before creating any Database objects. Example:
```
    import { indexedDB, IDBKeyRange } from "fake-indexeddb";
    Database.useIndexedDB(indexedDB, IDBKeyRange);
```
Parameters
- indexedDB: IDBFactory
- idbKeyRange: {
      prototype: IDBKeyRange;
      bound(
          lower: any,
          upper: any,
          lowerOpen?: boolean,
          upperOpen?: boolean,
      ): IDBKeyRange;
      lowerBound(lower: any, open?: boolean): IDBKeyRange;
      only(value: any): IDBKeyRange;
      upperBound(upper: any, open?: boolean): IDBKeyRange;
      new (): IDBKeyRange;
  }
  - new (): IDBKeyRange
    Returns IDBKeyRange
  - prototype: IDBKeyRange
  - bound: function
    bound(
        lower: any,
        upper: any,
        lowerOpen?: boolean,
        upperOpen?: boolean,
    ): IDBKeyRange
    The bound() static method of the IDBKeyRange interface creates a new key range with the specified upper and lower bounds.
    
    MDN Reference
    
    Parameters
    lower: any
    upper: any
    OptionallowerOpen: boolean
    OptionalupperOpen: boolean
    Returns IDBKeyRange
    Defined in node_modules/typescript/lib/lib.dom.d.ts:18239
  - lowerBound: function
    lowerBound(lower: any, open?: boolean): IDBKeyRange
    The lowerBound() static method of the By default, it includes the lower endpoint value and is closed.
    
    MDN Reference
    
    Parameters
    lower: any
    Optionalopen: boolean
    Returns IDBKeyRange
    Defined in node_modules/typescript/lib/lib.dom.d.ts:18245
  - only: function
    only(value: any): IDBKeyRange
    The only() static method of the IDBKeyRange interface creates a new key range containing a single value.
    
    MDN Reference
    
    Parameters
    value: any
    Returns IDBKeyRange
    Defined in node_modules/typescript/lib/lib.dom.d.ts:18251
  - upperBound: function
    upperBound(upper: any, open?: boolean): IDBKeyRange
    The upperBound() static method of the it includes the upper endpoint value and is closed.
    
    MDN Reference
    
    Parameters
    upper: any
    Optionalopen: boolean
    Returns IDBKeyRange
    Defined in node_modules/typescript/lib/lib.dom.d.ts:18257
Returns void
- Defined in src/database/database.ts:107

Class Database<Schema>

Type Parameters

Index

Properties

Accessors

Methods

Properties

Readonlyconfig

Readonlylogger

Readonlyname

Accessors

collectionNames

Returns readonly Extract<keyof Schema, string>[]

collections

Returns { readonly [K in string]: Collection<Schema[K]> }

defaultCollection

Returns Collection

Throws

isOpen

Returns boolean

Methods

[dispose]

Returns void

changeEncryptionKey

Parameters

Returns Promise<void>

Throws

close

Returns void

closeAndDelete

Returns Promise<void>

countBlobs

Returns Promise<number>

createQuery

Parameters

Returns Query<Schema>

decrypt

Returns Promise<void>

getCollection

Parameters

Returns Collection

Throws

performMaintenance

Parameters

Returns Promise<number>

reopen

Parameters

Returns Promise<void>

StaticdebugMode

Parameters

Returns void

Staticdelete

Parameters

Returns Promise<void>

Staticopen

Type Parameters

Parameters

Returns Promise<Database<Schema>>

StaticuseIndexedDB

Parameters

Returns IDBKeyRange

prototype: IDBKeyRange

bound: function

Parameters

Returns IDBKeyRange

lowerBound: function

Parameters

Returns IDBKeyRange

only: function

Parameters

Returns IDBKeyRange

upperBound: function

Parameters

Returns IDBKeyRange

Returns void

Settings

On This Page

`Readonly`config

`Readonly`logger

`Readonly`name

`Static`debugMode

`Static`delete

`Static`open

`Static`useIndexedDB