> ## Documentation Index
> Fetch the complete documentation index at: https://dev.marginnote.com.cn/llms.txt
> Use this file to discover all available pages before exploring further.

# Database

> Native instance exported as .

Native instance exported as `Database`.

## Methods

### allDocuments()

```typescript
allDocuments(): unknown[] | null
```

Exported member.

#### Returns

`unknown[] | null`

### allNotebooks()

```typescript
allNotebooks(): unknown[] | null
```

Exported member.

#### Returns

`unknown[] | null`

### cloneNotesToFlashcardsToTopic()

```typescript
cloneNotesToFlashcardsToTopic(_notes: unknown[] | null, _topicid: string | null): unknown[] | null
```

Exported member.

#### Parameters

**\_notes** `unknown[] | null` *required*

**\_topicid** `string | null` *required*

#### Returns

`unknown[] | null`

### cloneNotesToTopic()

```typescript
cloneNotesToTopic(_notes: unknown[] | null, _topicid: string | null): unknown[] | null
```

Exported member.

#### Parameters

**\_notes** `unknown[] | null` *required*

**\_topicid** `string | null` *required*

#### Returns

`unknown[] | null`

### createNoteWithTitleTopicid()

```typescript
createNoteWithTitleTopicid(_title: string | null, _topicid: string | null): Note | null
```

Exported member.

#### Parameters

**\_title** `string | null` *required*

**\_topicid** `string | null` *required*

#### Returns

`Note | null`

### createNoteWithTitleTopicidBookmd5Page()

```typescript
createNoteWithTitleTopicidBookmd5Page(_title: string | null, _topicid: string | null, _bookmd5: string | null, _page: number): Note | null
```

Exported member.

#### Parameters

**\_title** `string | null` *required*

**\_topicid** `string | null` *required*

**\_bookmd5** `string | null` *required*

**\_page** `number` *required*

#### Returns

`Note | null`

### deleteBookNote()

```typescript
deleteBookNote(_noteid: string | null): void
```

Exported member.

#### Parameters

**\_noteid** `string | null` *required*

### deleteBookNoteTree()

```typescript
deleteBookNoteTree(_noteid: string | null): void
```

Exported member.

#### Parameters

**\_noteid** `string | null` *required*

### exportNotebookStorePath()

```typescript
exportNotebookStorePath(_topicid: string | null, _storePath: string | null): boolean
```

Exported member.

#### Parameters

**\_topicid** `string | null` *required*

**\_storePath** `string | null` *required*

#### Returns

`boolean`

### getDocumentById()

```typescript
getDocumentById(_md5: string | null): unknown
```

Exported member.

#### Parameters

**\_md5** `string | null` *required*

#### Returns

`unknown`

### getFlashcardByNoteId()

```typescript
getFlashcardByNoteId(_noteid: string | null, _topicid: string | null): unknown
```

Exported member.

#### Parameters

**\_noteid** `string | null` *required*

**\_topicid** `string | null` *required*

#### Returns

`unknown`

### getFlashcardsByNoteId()

```typescript
getFlashcardsByNoteId(_noteid: string | null): unknown[] | null
```

Exported member.

#### Parameters

**\_noteid** `string | null` *required*

#### Returns

`unknown[] | null`

### getMediaByHash()

```typescript
getMediaByHash(_hash: string | null): NSData | null
```

Exported member.

#### Parameters

**\_hash** `string | null` *required*

#### Returns

`NSData | null`

### getNotebookById()

```typescript
getNotebookById(_topicid: string | null): unknown
```

Exported member.

#### Parameters

**\_topicid** `string | null` *required*

#### Returns

`unknown`

### getNoteById()

```typescript
getNoteById(_noteid: string | null): unknown
```

Exported member.

#### Parameters

**\_noteid** `string | null` *required*

#### Returns

`unknown`

### getNotesByHashtag()

```typescript
getNotesByHashtag(_hashtag: string | null, _topicid: string | null): unknown[] | null
```

Exported member.

#### Parameters

**\_hashtag** `string | null` *required*

**\_topicid** `string | null` *required*

#### Returns

`unknown[] | null`

### getSketchNoteForDocumentMd5Page()

```typescript
getSketchNoteForDocumentMd5Page(_topicid: string | null, _md5: string | null, _page: number): Note | null
```

Exported member.

#### Parameters

**\_topicid** `string | null` *required*

**\_md5** `string | null` *required*

**\_page** `number` *required*

#### Returns

`Note | null`

### getSketchNoteForMindMapFocusNoteId()

```typescript
getSketchNoteForMindMapFocusNoteId(_topicid: string | null, _focusNoteId: string | null): Note | null
```

Exported member.

#### Parameters

**\_topicid** `string | null` *required*

**\_focusNoteId** `string | null` *required*

#### Returns

`Note | null`

### getSketchNotesForDocumentMd5Page()

```typescript
getSketchNotesForDocumentMd5Page(_topicid: string | null, _md5: string | null, _page: number): Note[] | null
```

Exported member.

#### Parameters

**\_topicid** `string | null` *required*

**\_md5** `string | null` *required*

**\_page** `number` *required*

#### Returns

`Note[] | null`

### getSketchNotesForMindMap()

```typescript
getSketchNotesForMindMap(_topicid: string | null): Note[] | null
```

Exported member.

#### Parameters

**\_topicid** `string | null` *required*

#### Returns

`Note[] | null`

### hasFlashcardByNoteId()

```typescript
hasFlashcardByNoteId(_noteid: string | null): boolean
```

Exported member.

#### Parameters

**\_noteid** `string | null` *required*

#### Returns

`boolean`

### importNotebookFromStorePathMerge()

```typescript
importNotebookFromStorePathMerge(_storePath: string | null, _merge: boolean): unknown
```

Exported member.

#### Parameters

**\_storePath** `string | null` *required*

**\_merge** `boolean` *required*

#### Returns

`unknown`

### loadHistoryArchiveKey()

```typescript
loadHistoryArchiveKey(_topicid: string | null, _key: string | null): unknown[] | null
```

Exported member.

#### Parameters

**\_topicid** `string | null` *required*

**\_key** `string | null` *required*

#### Returns

`unknown[] | null`

### savedb()

```typescript
savedb(): void
```

Exported member.

### saveHistoryArchiveKey()

```typescript
saveHistoryArchiveKey(_topicid: string | null, _key: string | null): unknown[] | null
```

Exported member.

#### Parameters

**\_topicid** `string | null` *required*

**\_key** `string | null` *required*

#### Returns

`unknown[] | null`

### setNotebookSyncDirty()

```typescript
setNotebookSyncDirty(_topicid: string | null): void
```

Exported member.

#### Parameters

**\_topicid** `string | null` *required*


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.