Skip to main content

Home > git-documentdb > DatabaseInfo

DatabaseInfo type#

Database information

export declare type DatabaseInfo = {
dbId: string;
creator: string;
version: string;
serialize: SerializeFormatLabel;



  • This is metadata unique to GitDocumentDB.

  • This metadata is saved to '.gitddb/info.json' in JSON format.

  • dbId: ULID of the database. (See for ULID.) The dbId is used for combining databases.

  • creator: A creator of the database. Default is 'GitDocumentDB'. 'GitDocumentDB' ensures that the repository is created according to the GitDocumentDB scheme.

  • version: A version of the GitDocumentDB specification. The version can be used for database migration.

  • serialize: Serialize format of the database.