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

# Database

> Coassemble local sync: searchable entities, `.search()` filters, and operators.

The Coassemble plugin syncs data locally. Use `corsair.coassemble.db.<entity>.search({ data, limit?, offset? })` with the filters listed per entity.

> [!NOTE]
>
> **New to Corsair?** See [database operations](https://docs.corsair.dev/concepts/database.md), [data synchronization](https://docs.corsair.dev/concepts/integrations.md), and [multi-tenancy](https://docs.corsair.dev/concepts/multi-tenancy.md).

## Clients

Path: `coassemble.db.clients.search`

```ts theme={null}
const rows = await corsair.coassemble.db.clients.search({
    data: { /* filters below */ },
    limit: 100,
    offset: 0,
});
```

### Searchable filters

| Field | Type | Operators |
| - | - | - |
| `entity_id` | `string` | equals, contains, startsWith, endsWith, in |
| `clientIdentifier` | `string` | equals, contains, startsWith, endsWith, in |
| `userCount` | `number` | equals, gt, gte, lt, lte, in |

*Every `.search()` also accepts `limit` and `offset` for pagination. `.list()` is available on the same path without the `.search` suffix in code — see [database operations](https://docs.corsair.dev/concepts/database.md).*

***

## Courses

Path: `coassemble.db.courses.search`

```ts theme={null}
const rows = await corsair.coassemble.db.courses.search({
    data: { /* filters below */ },
    limit: 100,
    offset: 0,
});
```

### Searchable filters

| Field | Type | Operators |
| - | - | - |
| `entity_id` | `string` | equals, contains, startsWith, endsWith, in |
| `id` | `number` | equals, gt, gte, lt, lte, in |
| `title` | `string` | equals, contains, startsWith, endsWith, in |
| `description` | `string` | equals, contains, startsWith, endsWith, in |
| `image` | `string` | equals, contains, startsWith, endsWith, in |
| `imageAltText` | `string` | equals, contains, startsWith, endsWith, in |
| `imageSource` | `number` | equals, gt, gte, lt, lte, in |
| `thumbnail` | `string` | equals, contains, startsWith, endsWith, in |
| `thumbnailRevision` | `string` | equals, contains, startsWith, endsWith, in |
| `thumbnailOutdated` | `boolean` | equals |
| `timeEstimateMinutes` | `number` | equals, gt, gte, lt, lte, in |
| `clientId` | `number` | equals, gt, gte, lt, lte, in |
| `active` | `boolean` | equals |
| `identified` | `boolean` | equals |
| `private` | `boolean` | equals |
| `paid` | `boolean` | equals |
| `domain` | `boolean` | equals |
| `price` | `number` | equals, gt, gte, lt, lte, in |
| `key` | `string` | equals, contains, startsWith, endsWith, in |
| `source` | `string` | equals, contains, startsWith, endsWith, in |
| `identifier` | `string` | equals, contains, startsWith, endsWith, in |
| `clientIdentifier` | `string` | equals, contains, startsWith, endsWith, in |
| `language` | `string` | equals, contains, startsWith, endsWith, in |
| `collabSeq` | `number` | equals, gt, gte, lt, lte, in |
| `narrationLanguage` | `string` | equals, contains, startsWith, endsWith, in |
| `type` | `string` | equals, contains, startsWith, endsWith, in |
| `legacy` | `boolean` | equals |
| `documentFlow` | `string` | equals, contains, startsWith, endsWith, in |
| `folderId` | `number` | equals, gt, gte, lt, lte, in |
| `parentId` | `number` | equals, gt, gte, lt, lte, in |
| `themeId` | `number` | equals, gt, gte, lt, lte, in |
| `draftId` | `number` | equals, gt, gte, lt, lte, in |
| `startScreenId` | `number` | equals, gt, gte, lt, lte, in |
| `finishScreenId` | `number` | equals, gt, gte, lt, lte, in |
| `sequence` | `number` | equals, gt, gte, lt, lte, in |

*Every `.search()` also accepts `limit` and `offset` for pagination. `.list()` is available on the same path without the `.search` suffix in code — see [database operations](https://docs.corsair.dev/concepts/database.md).*

***

## Trackings

Path: `coassemble.db.trackings.search`

```ts theme={null}
const rows = await corsair.coassemble.db.trackings.search({
    data: { /* filters below */ },
    limit: 100,
    offset: 0,
});
```

### Searchable filters

| Field | Type | Operators |
| - | - | - |
| `entity_id` | `string` | equals, contains, startsWith, endsWith, in |
| `id` | `number` | equals, gt, gte, lt, lte, in |
| `feedback` | `string` | equals, contains, startsWith, endsWith, in |
| `email` | `string` | equals, contains, startsWith, endsWith, in |
| `identifier` | `string` | equals, contains, startsWith, endsWith, in |
| `clientIdentifier` | `string` | equals, contains, startsWith, endsWith, in |
| `passed` | `boolean` | equals |
| `score` | `number` | equals, gt, gte, lt, lte, in |
| `progress_percent` | `number` | equals, gt, gte, lt, lte, in |
| `total_time` | `number` | equals, gt, gte, lt, lte, in |
| `language` | `string` | equals, contains, startsWith, endsWith, in |
| `scorm` | `boolean` | equals |
| `success` | `boolean` | equals |
| `score_percent` | `number` | equals, gt, gte, lt, lte, in |
| `runtime_errors` | `number` | equals, gt, gte, lt, lte, in |
| `has_progress_signal` | `boolean` | equals |
| `progress_status` | `string` | equals, contains, startsWith, endsWith, in |
| `attempt_count` | `number` | equals, gt, gte, lt, lte, in |

*Every `.search()` also accepts `limit` and `offset` for pagination. `.list()` is available on the same path without the `.search` suffix in code — see [database operations](https://docs.corsair.dev/concepts/database.md).*

***

## Users

Path: `coassemble.db.users.search`

```ts theme={null}
const rows = await corsair.coassemble.db.users.search({
    data: { /* filters below */ },
    limit: 100,
    offset: 0,
});
```

### Searchable filters

| Field | Type | Operators |
| - | - | - |
| `entity_id` | `string` | equals, contains, startsWith, endsWith, in |
| `identifier` | `string` | equals, contains, startsWith, endsWith, in |
| `clientIdentifier` | `string` | equals, contains, startsWith, endsWith, in |
| `name` | `string` | equals, contains, startsWith, endsWith, in |
| `avatar` | `string` | equals, contains, startsWith, endsWith, in |
| `testMode` | `boolean` | equals |

*Every `.search()` also accepts `limit` and `offset` for pagination. `.list()` is available on the same path without the `.search` suffix in code — see [database operations](https://docs.corsair.dev/concepts/database.md).*

***


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