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

# Module: runtime/adapters/datasets

> Reference for the bijection/runtime/adapters/datasets entry point.

## Type Aliases

### AllocationRef

Ƭ **AllocationRef**: `string` & \{ `[allocationIdentity]`: `true`  }

Native custody identity. A reference grants neither access nor permission
to write, and must never be reconstructed from a catalog/table address.

***

### VersionAllocation

Ƭ **VersionAllocation**: `Object`

Not exported: an exported type refers to it.

#### Type declaration

| Name | Type |
| :- | :- |
| `allocationRef` | [`AllocationRef`](https://docs.bijection.com/api/modules/runtime_adapters_datasets#allocationref) |
| `version` | `string` |
| `availability` | `string` |

***

### WriterAllocation

Ƭ **WriterAllocation**: `Object`

Not exported: an exported type refers to it.

#### Type declaration

| Name | Type |
| :- | :- |
| `allocationRef` | [`AllocationRef`](https://docs.bijection.com/api/modules/runtime_adapters_datasets#allocationref) |
| `scope` | `string` |
| `credential` | `string` |

***

### DatasetVersionsMethods

Ƭ **DatasetVersionsMethods**: [`ResourceMethods`](https://docs.bijection.com/api/modules/server#resourcemethods)\[`"datasetVersions"`]

***

### DatasetVersionsFunctions

Ƭ **DatasetVersionsFunctions**: [`ResourceFunctions`](https://docs.bijection.com/api/modules/server#resourcefunctions)\[`"datasetVersions"`]

***

### DatasetVersionsContinuation

Ƭ **DatasetVersionsContinuation**: [`ResourceContinuation`](https://docs.bijection.com/api/modules/server#resourcecontinuation)

***

### MethodValidators

Ƭ **MethodValidators**\<`Definition`>: `Definition` extends [`Contract`](https://docs.bijection.com/api/modules/server#contract) ? \{ `args`: [`Validator`](https://docs.bijection.com/api/modules/values#validator)\<[`ContractValue`](https://docs.bijection.com/api/modules/server#contractvalue)\<`Definition`\[`"args"`]>> ; `returns`: [`Validator`](https://docs.bijection.com/api/modules/values#validator)\<[`ContractValue`](https://docs.bijection.com/api/modules/server#contractvalue)\<`Definition`\[`"returns"`]>>  } : `never`

Not exported: an exported type refers to it.

#### Type parameters

| Name |
| :- |
| `Definition` |

## Variables

### allocationRef

• `Const` **allocationRef**: [`VString`](https://docs.bijection.com/api/classes/values.VString)\<[`AllocationRef`](https://docs.bijection.com/api/modules/runtime_adapters_datasets#allocationref), `"required"`>

Store the native reference unchanged in the owning component's records.

***

### datasetAllocations

• `Const` **datasetAllocations**: `Object`

The original physical allocation outlives bindings, branches and writers.
Native code validates the actual component records in the same transaction.
Closing admission never certifies that outstanding object I/O has settled.

#### Type declaration

| Name | Type |
| :- | :- |
| `reserve` | (`input`: \{ `binding`: `string` ; `catalog`: `string` ; `dataset`: `string` ; `uuid`: `string` ; `prefix`: `string`  }) => `Promise`\<[`AllocationRef`](https://docs.bijection.com/api/modules/runtime_adapters_datasets#allocationref)> |
| `retainVersion` | (`input`: [`VersionAllocation`](https://docs.bijection.com/api/modules/runtime_adapters_datasets#versionallocation)) => `Promise`\<`null`> |
| `releaseVersion` | (`input`: [`VersionAllocation`](https://docs.bijection.com/api/modules/runtime_adapters_datasets#versionallocation)) => `Promise`\<`null`> |
| `releaseBinding` | (`input`: \{ `allocationRef`: [`AllocationRef`](https://docs.bijection.com/api/modules/runtime_adapters_datasets#allocationref)  }) => `Promise`\<`null`> |
| `isReleased` | (`input`: \{ `allocationRef`: [`AllocationRef`](https://docs.bijection.com/api/modules/runtime_adapters_datasets#allocationref)  }) => `Promise`\<`boolean`> |
| `admitWriter` | (`input`: [`WriterAllocation`](https://docs.bijection.com/api/modules/runtime_adapters_datasets#writerallocation)) => `Promise`\<`null`> |
| `requireWriter` | (`input`: [`WriterAllocation`](https://docs.bijection.com/api/modules/runtime_adapters_datasets#writerallocation)) => `Promise`\<`null`> |
| `closeWriter` | (`input`: \{ `allocationRef`: [`AllocationRef`](https://docs.bijection.com/api/modules/runtime_adapters_datasets#allocationref) ; `scope`: `string`  }) => `Promise`\<`null`> |
| `catalogAccess` | \<Result>(`ctx`: `Pick`\<[`GenericActionCtx`](https://docs.bijection.com/api/interfaces/server.GenericActionCtx)\<`any`>, `"runQuery"`>, `input`: \{ `owner`: [`FunctionReference`](https://docs.bijection.com/api/modules/server#functionreference)\<`"query"`, `"public"` \| `"internal"`, \{ `digest`: `string`  }, `Result`> ; `digest`: `string`  }) => `Promise`\<`Result`> |

***

### datasetDeclarations

• `Const` **datasetDeclarations**: `Object`

Read the root program's analyzed logical declarations before a publisher
binds them. The containing application must authorize metadata disclosure;
source locations, physical placement and credentials are never returned.

#### Type declaration

| Name | Type |
| :- | :- |
| `list` | (`_ctx`: `Pick`\<[`GenericQueryCtx`](https://docs.bijection.com/api/interfaces/server.GenericQueryCtx)\<`any`>, `"runQuery"`>, `options`: \{ `limit`: `number` ; `key?`: `string`  }) => `Promise`\<\{ `declarations`: `string`\[] ; `isComplete`: `boolean`  }> |

***

### datasetVersions

• `Const` **datasetVersions**: `Readonly`\<\{ `protocol`: `"datasetVersions"` ; `contractDigest`: `"c228a2f84cf3a431ddc3c4afbdfcf1e598a741a93b73e078c124eb91cfd8b703"` ; `functions`: (`ctx`: [`ResourceFunctionContext`](https://docs.bijection.com/api/modules/server#resourcefunctioncontext), `resource`: [`ResourceBinding`](https://docs.bijection.com/api/modules/server#resourcebinding)\<`"datasetVersions"`>) => `Promise`\<\{ `check`: `string` & [`FunctionReference`](https://docs.bijection.com/api/modules/server#functionreference)\<`"query"`, `"internal"`, \{ `inputs`: \{ readonly contract: string; readonly dataset: string; readonly fields: string\[]; readonly pin: string; readonly table: string; readonly version: string; } & \{}\[]  } & \{}, \{ `inputs`: \{ readonly contract: string; readonly dataset: string; readonly definition: any; readonly fields: string\[]; readonly metadata: any; readonly physical: any; readonly table: string; readonly version: string; } & \{}\[] ; `ready`: `boolean`  } & \{}> ; `release`: `string` & [`FunctionReference`](https://docs.bijection.com/api/modules/server#functionreference)\<`"mutation"`, `"internal"`, \{ `pins`: `string`\[]  } & \{}, \{ `released`: `boolean`  } & \{}> ; `resolve`: `string` & [`FunctionReference`](https://docs.bijection.com/api/modules/server#functionreference)\<`"query"`, `"internal"`, \{ `inputs`: \{ readonly contract: string; readonly dataset: string; readonly fields: string\[]; readonly table: string; } & \{}\[]  } & \{ `context?`: `null` | `string` ; `versions?`: `null` | `Record`\<`string`, `string`>  } | \{ `input`: \{ readonly component: string; readonly dataset: string; readonly fields: string\[]; readonly series: string; readonly table: string; } & \{}  } & \{}, \{ `contract`: `string` ; `dataset`: `string` ; `definition`: `any` ; `fields`: `string`\[] ; `metadata`: `any` ; `physical`: `any` ; `table`: `string` ; `version`: `string`  } & \{}\[]> ; `retain`: `string` & [`FunctionReference`](https://docs.bijection.com/api/modules/server#functionreference)\<`"mutation"`, `"internal"`, \{ `inputs`: \{ readonly contract: string; readonly dataset: string; readonly fields: string\[]; readonly pin: string; readonly table: string; readonly version: string; } & \{}\[]  } & \{ `replay?`: \{ `pin`: `string` ; `table`: `string` ; `until_ms`: `number`  } & \{}\[]  }, \{ `continuation`: \{ readonly contractDigest: string; readonly methods: Record\<string, string>; readonly record: string; } & \{} ; `contract`: `string` ; `dataset`: `string` ; `definition`: `any` ; `fields`: `string`\[] ; `metadata`: `any` ; `owner`: `string` ; `physical`: `any` ; `pin`: `string` ; `table`: `string` ; `version`: `string`  } & \{}\[]>  }> ; `continuationValidator`:  ; `retainCallbacks`: (`ctx`: `Pick`\<[`GenericMutationCtx`](https://docs.bijection.com/api/interfaces/server.GenericMutationCtx)\<[`GenericDataModel`](https://docs.bijection.com/api/modules/server#genericdatamodel)>, `"db"`>, `methods`: `Pick`\<\{ `check`: [`FunctionReference`](https://docs.bijection.com/api/modules/server#functionreference)\<`"query"`, `"internal"`, \{ `inputs`: \{ readonly contract: string; readonly dataset: string; readonly fields: string\[]; readonly pin: string; readonly table: string; readonly version: string; } & \{}\[]  } & \{}, \{ `inputs`: \{ readonly contract: string; readonly dataset: string; readonly definition: any; readonly fields: string\[]; readonly metadata: any; readonly physical: any; readonly table: string; readonly version: string; } & \{}\[] ; `ready`: `boolean`  } & \{}> ; `release`: [`FunctionReference`](https://docs.bijection.com/api/modules/server#functionreference)\<`"mutation"`, `"internal"`, \{ `pins`: `string`\[]  } & \{}, \{ `released`: `boolean`  } & \{}> ; `resolve`: [`FunctionReference`](https://docs.bijection.com/api/modules/server#functionreference)\<`"query"`, `"internal"`, \{ `inputs`: \{ readonly contract: string; readonly dataset: string; readonly fields: string\[]; readonly table: string; } & \{}\[]  } & \{ `context?`: `null` | `string` ; `versions?`: `null` | `Record`\<`string`, `string`>  } | \{ `input`: \{ readonly component: string; readonly dataset: string; readonly fields: string\[]; readonly series: string; readonly table: string; } & \{}  } & \{}, \{ `contract`: `string` ; `dataset`: `string` ; `definition`: `any` ; `fields`: `string`\[] ; `metadata`: `any` ; `physical`: `any` ; `table`: `string` ; `version`: `string`  } & \{}\[]> ; `retain`: [`FunctionReference`](https://docs.bijection.com/api/modules/server#functionreference)\<`"mutation"`, `"internal"`, \{ `inputs`: \{ readonly contract: string; readonly dataset: string; readonly fields: string\[]; readonly pin: string; readonly table: string; readonly version: string; } & \{}\[]  } & \{ `replay?`: \{ `pin`: `string` ; `table`: `string` ; `until_ms`: `number`  } & \{}\[]  }, \{ `continuation`: \{ readonly contractDigest: string; readonly methods: Record\<string, string>; readonly record: string; } & \{} ; `contract`: `string` ; `dataset`: `string` ; `definition`: `any` ; `fields`: `string`\[] ; `metadata`: `any` ; `owner`: `string` ; `physical`: `any` ; `pin`: `string` ; `table`: `string` ; `version`: `string`  } & \{}\[]>  }, `"check"` | `"release"`>, `options`: \{ `record`: `string`  }) => `Promise`\<[`ResourceContinuation`](https://docs.bijection.com/api/modules/server#resourcecontinuation)> ; `contract`:  ; `implement`: (`methods`: \{ `check`: [`FunctionReference`](https://docs.bijection.com/api/modules/server#functionreference)\<`"query"`, `"internal"`, \{ `inputs`: \{ readonly contract: string; readonly dataset: string; readonly fields: string\[]; readonly pin: string; readonly table: string; readonly version: string; } & \{}\[]  } & \{}, \{ `inputs`: \{ readonly contract: string; readonly dataset: string; readonly definition: any; readonly fields: string\[]; readonly metadata: any; readonly physical: any; readonly table: string; readonly version: string; } & \{}\[] ; `ready`: `boolean`  } & \{}> ; `release`: [`FunctionReference`](https://docs.bijection.com/api/modules/server#functionreference)\<`"mutation"`, `"internal"`, \{ `pins`: `string`\[]  } & \{}, \{ `released`: `boolean`  } & \{}> ; `resolve`: [`FunctionReference`](https://docs.bijection.com/api/modules/server#functionreference)\<`"query"`, `"internal"`, \{ `inputs`: \{ readonly contract: string; readonly dataset: string; readonly fields: string\[]; readonly table: string; } & \{}\[]  } & \{ `context?`: `null` | `string` ; `versions?`: `null` | `Record`\<`string`, `string`>  } | \{ `input`: \{ readonly component: string; readonly dataset: string; readonly fields: string\[]; readonly series: string; readonly table: string; } & \{}  } & \{}, \{ `contract`: `string` ; `dataset`: `string` ; `definition`: `any` ; `fields`: `string`\[] ; `metadata`: `any` ; `physical`: `any` ; `table`: `string` ; `version`: `string`  } & \{}\[]> ; `retain`: [`FunctionReference`](https://docs.bijection.com/api/modules/server#functionreference)\<`"mutation"`, `"internal"`, \{ `inputs`: \{ readonly contract: string; readonly dataset: string; readonly fields: string\[]; readonly pin: string; readonly table: string; readonly version: string; } & \{}\[]  } & \{ `replay?`: \{ `pin`: `string` ; `table`: `string` ; `until_ms`: `number`  } & \{}\[]  }, \{ `continuation`: \{ readonly contractDigest: string; readonly methods: Record\<string, string>; readonly record: string; } & \{} ; `contract`: `string` ; `dataset`: `string` ; `definition`: `any` ; `fields`: `string`\[] ; `metadata`: `any` ; `owner`: `string` ; `physical`: `any` ; `pin`: `string` ; `table`: `string` ; `version`: `string`  } & \{}\[]>  }) => [`ResourceProvider`](https://docs.bijection.com/api/modules/server#resourceprovider)\<`"datasetVersions"`>  }>

Exact dataset resolution and custody through an explicitly selected installation.


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