<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [git-documentdb](./git-documentdb.md) &gt; [DatabaseOption](./git-documentdb.databaseoption.md)

## DatabaseOption type

> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
> 

Database location

<b>Signature:</b>

```typescript
export declare type DatabaseOption = {
    local_dir?: string;
    db_name: string;
    log_level?: 'trace' | 'debug' | 'info' | 'warn' | 'error' | 'fatal';
};
```

## Remarks

OS specific options. <b>It is recommended to use ASCII characters and case-insensitive names for cross-platform.</b>

```
* local_dir: Local directory path that stores repositories of GitDocumentDB.
  - Default is './gitddb'.
  - A directory name allows Unicode characters excluding OS reserved filenames and following characters: < > : " | ? * \0.
  - A colon : is generally not allowed, but a drive letter followed by a colon is allowed. e.g.) C: D:
  - A directory name cannot end with a period or a white space, but the current directory . and the parent directory .. are allowed.
  - A trailing slash / could be omitted.

* db_name: Name of a git repository
  - dbName allows Unicode characters excluding OS reserved filenames and following characters: < > : " ¥ / \ | ? * \0.
  - dbName cannot end with a period or a white space.
  - dbName does not allow '.' and '..'.

```

