> ## 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: deployment

> Reference for the bijection/deployment entry point.

## Type Aliases

### DatasetLayout

Ƭ **DatasetLayout**: `Object`

#### Type declaration

| Name | Type |
| :- | :- |
| `partition?` | readonly [`DatasetPartition`](https://docs.bijection.com/api/modules/deployment#datasetpartition)\[] |
| `sort?` | readonly [`DatasetSort`](https://docs.bijection.com/api/modules/deployment#datasetsort)\[] |

***

### DatasetPartition

Ƭ **DatasetPartition**: \{ `transform`: `"identity"` ; `field`: `string`  } | \{ `transform`: `"year"` ; `field`: `string`  } | \{ `transform`: `"month"` ; `field`: `string`  } | \{ `transform`: `"day"` ; `field`: `string`  } | \{ `transform`: `"hour"` ; `field`: `string`  } | \{ `transform`: `"bucket"` ; `field`: `string` ; `count`: `number`  } | \{ `transform`: `"truncate"` ; `field`: `string` ; `width`: `number`  }

Not exported: an exported type refers to it.

***

### DatasetSort

Ƭ **DatasetSort**: `Object`

Not exported: an exported type refers to it.

#### Type declaration

| Name | Type |
| :- | :- |
| `field` | `string` |
| `nulls` | [`NullPlacement`](https://docs.bijection.com/api/modules/deployment#nullplacement) |

***

### NullPlacement

Ƭ **NullPlacement**: `"first"` | `"last"`

Not exported: an exported type refers to it.

***

### BrowserBinding

Ƭ **BrowserBinding**\<`R`>: `R` extends [`BrowserResourceReference`](https://docs.bijection.com/api/modules/server#browserresourcereference)\<`any`> ? `0` extends `1` & `R`\[`"_browser"`] ? `false` : `true` : `false`

Not exported: an exported type refers to it.

#### Type parameters

| Name |
| :- |
| `R` |

***

### BrowserExecution

Ƭ **BrowserExecution**: \{ `browser`: [`BrowserResourceReference`](https://docs.bijection.com/api/modules/server#browserresourcereference)\<`any`, `"enforced"`> ; `confinement?`: `"enforced"`  } | \{ `browser`: [`BrowserResourceReference`](https://docs.bijection.com/api/modules/server#browserresourcereference)\<`any`, `"unenforced"`> ; `confinement`: `"unenforced"`  }

An enforced capability is the default. A capability whose provider cannot
block traffic that bypasses the native broker requires an explicit
`confinement: "unenforced"`, so weaker guarantees are never selected silently.

***

### DeclaredConnection

Ƭ **DeclaredConnection**\<`Connector`, `Setup`>: `Object`

A deployment-owned connection declaration. Its resource identifies the
native connection contract; credentials remain private inventory references.
Native preflight resolves defaults and activation installs its exact identity.

#### Type parameters

| Name | Type |
| :- | :- |
| `Connector` | extends `string` = `string` |
| `Setup` | extends `Record`\<`string`, [`Value`](https://docs.bijection.com/api/modules/values#value)> = `Record`\<`string`, [`Value`](https://docs.bijection.com/api/modules/values#value)> |

#### Type declaration

| Name | Type |
| :- | :- |
| `declaration` | \{ `resource`: \{ `module`: `string` ; `export`: `string`  } ; `component?`: `string` ; `setup`: `Setup` ; `credential?`: [`CredentialReference`](https://docs.bijection.com/api/modules/server#credentialreference)  } |
| `declaration.resource` | \{ `module`: `string` ; `export`: `string`  } |
| `declaration.resource.module` | `string` |
| `declaration.resource.export` | `string` |
| `declaration.component?` | `string` |
| `declaration.setup` | `Setup` |
| `declaration.credential?` | [`CredentialReference`](https://docs.bijection.com/api/modules/server#credentialreference) |
| `_connector` | `Connector` |

***

### ConnectionSetup

Ƭ **ConnectionSetup**\<`R`>: `Pick`\<`R`\[`"_setup"`], `Extract`\<`R`\[`"_connectionKeys"`], keyof `R`\[`"_setup"`]>>

Not exported: an exported type refers to it.

#### Type parameters

| Name | Type |
| :- | :- |
| `R` | extends [`ResourceReference`](https://docs.bijection.com/api/modules/server#resourcereference)\<`any`, `any`, `any`> |

***

### ConnectionInput

Ƭ **ConnectionInput**\<`R`>: \{ `setup`: [`ConnectionSetup`](https://docs.bijection.com/api/modules/deployment#connectionsetup)\<`R`> ; `component?`: `string`  } & `R`\[`"_credential"`] extends `"none"` ? \{ `credential?`: `never`  } : \{ `credential`: [`CredentialReference`](https://docs.bijection.com/api/modules/server#credentialreference)\<`R`\[`"_credential"`]>  }

#### Type parameters

| Name | Type |
| :- | :- |
| `R` | extends [`ResourceReference`](https://docs.bijection.com/api/modules/server#resourcereference)\<`any`, `any`, `any`> |

***

### BindingInput

Ƭ **BindingInput**\<`R`>: \{ `acquisition?`: [`BrowserBinding`](https://docs.bijection.com/api/modules/deployment#browserbinding)\<`R`> extends `true` ? `never` : \{ `every`: [`SyncEvery`](https://docs.bijection.com/api/modules/server#syncevery)  } ; `component?`: [`BrowserBinding`](https://docs.bijection.com/api/modules/deployment#browserbinding)\<`R`> extends `true` ? `never` : `string` ; `execution?`: [`BrowserBinding`](https://docs.bijection.com/api/modules/deployment#browserbinding)\<`R`> extends `true` ? `never` : [`BrowserExecution`](https://docs.bijection.com/api/modules/deployment#browserexecution)  } & [`BrowserBinding`](https://docs.bijection.com/api/modules/deployment#browserbinding)\<`R`> extends `true` ? \{ `name?`: `never`  } : \{ `name?`: `string`  } & \{ `setup`: `R`\[`"_setup"`] ; `connection?`: `never`  } & `R`\[`"_credential"`] extends `"none"` ? \{ `credential?`: `never`  } : \{ `credential`: [`CredentialReference`](https://docs.bijection.com/api/modules/server#credentialreference)\<`R`\[`"_credential"`]>  } | \{ `connection`: [`BrowserBinding`](https://docs.bijection.com/api/modules/deployment#browserbinding)\<`R`> extends `true` ? `never` : [`ConnectionReference`](https://docs.bijection.com/api/modules/server#connectionreference)\<`R`\[`"_connector"`], [`ConnectionSetup`](https://docs.bijection.com/api/modules/deployment#connectionsetup)\<`R`>> | [`DeclaredConnection`](https://docs.bijection.com/api/modules/deployment#declaredconnection)\<`R`\[`"_connector"`], [`ConnectionSetup`](https://docs.bijection.com/api/modules/deployment#connectionsetup)\<`R`>> ; `setup`: `Omit`\<`R`\[`"_setup"`], `R`\[`"_connectionKeys"`]> ; `credential?`: `never`  }

#### Type parameters

| Name | Type |
| :- | :- |
| `R` | extends [`ResourceReference`](https://docs.bijection.com/api/modules/server#resourcereference)\<`any`, `any`, `any`> |

***

### BindingAddress

Ƭ **BindingAddress**: `Object`

#### Type declaration

| Name | Type |
| :- | :- |
| `resource` | \{ `module`: `string` ; `export`: `string`  } |
| `resource.module` | `string` |
| `resource.export` | `string` |
| `name` | `string` |
| `component?` | `string` |

***

### ResourceBinding

Ƭ **ResourceBinding**: `Object`

One desired binding. It contains references and non-secret setup only.

#### Type declaration

| Name | Type |
| :- | :- |
| `address` | [`BindingAddress`](https://docs.bijection.com/api/modules/deployment#bindingaddress) |
| `setup` | `Record`\<`string`, [`Value`](https://docs.bijection.com/api/modules/values#value)> |
| `storage?` | `never` |
| `acquisition?` | \{ `every`: [`SyncEvery`](https://docs.bijection.com/api/modules/server#syncevery)  } |
| `acquisition.every` | [`SyncEvery`](https://docs.bijection.com/api/modules/server#syncevery) |
| `publication?` | \{ `group`: `string`  } |
| `publication.group` | `string` |
| `credential?` | [`CredentialReference`](https://docs.bijection.com/api/modules/server#credentialreference) |
| `connection?` | [`ConnectionReference`](https://docs.bijection.com/api/modules/server#connectionreference) \| [`DeclaredConnection`](https://docs.bijection.com/api/modules/deployment#declaredconnection) |
| `execution?` | \{ `browser`: [`BindingAddress`](https://docs.bijection.com/api/modules/deployment#bindingaddress) ; `confinement`: [`BrowserConfinement`](https://docs.bijection.com/api/modules/server#browserconfinement)  } |
| `execution.browser` | [`BindingAddress`](https://docs.bijection.com/api/modules/deployment#bindingaddress) |
| `execution.confinement` | [`BrowserConfinement`](https://docs.bijection.com/api/modules/server#browserconfinement) |

***

### DatasetStorage

Ƭ **DatasetStorage**: `Object`

Physical placement of one logical dataset. Catalog credentials belong to
the registered catalog, independently of the source connection.

#### Type declaration

| Name | Type |
| :- | :- |
| `catalog` | `string` |
| `table` | readonly `string`\[] |
| `buckets?` | `number` |
| `layout?` | [`DatasetLayout`](https://docs.bijection.com/api/modules/deployment#datasetlayout) |

***

### DatasetBindingInput

Ƭ **DatasetBindingInput**: `Object`

#### Type declaration

| Name | Type |
| :- | :- |
| `storage` | [`DatasetStorage`](https://docs.bijection.com/api/modules/deployment#datasetstorage) |

***

### DatasetBinding

Ƭ **DatasetBinding**: `Object`

#### Type declaration

| Name | Type |
| :- | :- |
| `address` | [`BindingAddress`](https://docs.bijection.com/api/modules/deployment#bindingaddress) |
| `storage` | `Readonly`\<[`DatasetStorage`](https://docs.bijection.com/api/modules/deployment#datasetstorage)> |
| `setup?` | `never` |
| `execution?` | `never` |
| `acquisition?` | `never` |
| `publication?` | `never` |
| `credential?` | `never` |
| `connection?` | `never` |

***

### DeploymentBinding

Ƭ **DeploymentBinding**: [`ResourceBinding`](https://docs.bijection.com/api/modules/deployment#resourcebinding) | [`DatasetBinding`](https://docs.bijection.com/api/modules/deployment#datasetbinding)

## Functions

### connect

▸ **connect**\<`R`>(`resource`, `input`): [`DeclaredConnection`](https://docs.bijection.com/api/modules/deployment#declaredconnection)\<`R`\[`"_connector"`], [`ConnectionSetup`](https://docs.bijection.com/api/modules/deployment#connectionsetup)\<`R`>>

Declare one connection that any compatible resource bindings may share.

#### Type parameters

| Name | Type |
| :- | :- |
| `R` | extends [`ResourceReference`](https://docs.bijection.com/api/modules/server#resourcereference)\<`any`, `any`, `any`> |

#### Parameters

| Name | Type |
| :- | :- |
| `resource` | `R` |
| `input` | [`BrowserBinding`](https://docs.bijection.com/api/modules/deployment#browserbinding)\<`R`> extends `true` ? `never` : [`ConnectionInput`](https://docs.bijection.com/api/modules/deployment#connectioninput)\<`R`> |

#### Returns

[`DeclaredConnection`](https://docs.bijection.com/api/modules/deployment#declaredconnection)\<`R`\[`"_connector"`], [`ConnectionSetup`](https://docs.bijection.com/api/modules/deployment#connectionsetup)\<`R`>>

***

### bind

▸ **bind**\<`R`>(`resource`, `input`): [`ResourceBinding`](https://docs.bijection.com/api/modules/deployment#resourcebinding)

Bind a resource declaration to deployment-owned coordinates and custody.

#### Type parameters

| Name | Type |
| :- | :- |
| `R` | extends [`ResourceReference`](https://docs.bijection.com/api/modules/server#resourcereference)\<`any`, `any`, `any`> |

#### Parameters

| Name | Type |
| :- | :- |
| `resource` | `R` |
| `input` | [`BindingInput`](https://docs.bijection.com/api/modules/deployment#bindinginput)\<`R`> |

#### Returns

[`ResourceBinding`](https://docs.bijection.com/api/modules/deployment#resourcebinding)

▸ **bind**(`resource`, `input`): [`DatasetBinding`](https://docs.bijection.com/api/modules/deployment#datasetbinding)

#### Parameters

| Name | Type |
| :- | :- |
| `resource` | [`DatasetReference`](https://docs.bijection.com/api/modules/server#datasetreference) |
| `input` | [`DatasetBindingInput`](https://docs.bijection.com/api/modules/deployment#datasetbindinginput) |

#### Returns

[`DatasetBinding`](https://docs.bijection.com/api/modules/deployment#datasetbinding)

***

### publishTogether

▸ **publishTogether**(`group`, `bindings`): readonly [`ResourceBinding`](https://docs.bijection.com/api/modules/deployment#resourcebinding)\[]

Join independently acquired inputs in one local visibility commit. Each
member retains its own provider cut; this declares no shared snapshot.

#### Parameters

| Name | Type |
| :- | :- |
| `group` | `string` |
| `bindings` | readonly [`ResourceBinding`](https://docs.bijection.com/api/modules/deployment#resourcebinding)\[] |

#### Returns

readonly [`ResourceBinding`](https://docs.bijection.com/api/modules/deployment#resourcebinding)\[]

***

### defineBindings

▸ **defineBindings**(`bindings`): readonly [`DeploymentBinding`](https://docs.bijection.com/api/modules/deployment#deploymentbinding)\[]

Evaluate this deployment-only module after application code generation.
Removing an entry does not erase retained source data or private credentials.

#### Parameters

| Name | Type |
| :- | :- |
| `bindings` | readonly [`DeploymentBinding`](https://docs.bijection.com/api/modules/deployment#deploymentbinding)\[] |

#### Returns

readonly [`DeploymentBinding`](https://docs.bijection.com/api/modules/deployment#deploymentbinding)\[]


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