> ## 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.

# sql

> Resources, examples, configuration and evidence for sql.

Use the `@bijection/connectors/sql` entrypoint to declare sql resources.

## Availability

This page describes the pinned source package. Published availability is unestablished for this artifact. [Source build and package availability](https://docs.bijection.com/client/sdk-distribution.md).

## Resources and modes

| Resource | Mode | Description |
| - | - | - |
| table | `sourceChanges` | Source change records |
| table | `watermark` | Monotonic column |

Declare a resource in application code, then bind deployment-specific settings and credentials. See [typed resources](https://docs.bijection.com/integrations/resources.md), [connections](https://docs.bijection.com/integrations/connections.md) and [source inspection](https://docs.bijection.com/integrations/cli.md).

## table

### sourceChanges: Source change records

The following example matches configuration `standard`.

```ts theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}}
import { sql } from "@bijection/connectors/sql";
import { v } from "bijection/values";
export const records = sql.table.sourceChanges({
  schema: { id: v.int64() },
  dialect: "mysql",
  key: ["id"],
});
```

> **Inferred record types**
>
> ```ts theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}}
> {
>   "id": bigint;
> }
> ```

#### Configuration: standard

Case: `sql/table/sourceChanges/standard`.

Connection and resource configuration are declared by this exact case.

Credential kind: `sql`. Keep credential material in the private credential inventory.

| Setting | Type | Required | Owner |
| - | - | - | - |
| `connection` | object or object or object or object or object or object | Yes | Shared connection |
| `table` | object | No | Resource binding |
| `receipts` | object or null | No | Resource binding |
| `changeRecord` | null or object or object | No | Resource binding |
| `icebergCatalogs` | record of string | No | Resource binding |

> **Complete configuration contract**
>
> ```json theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}}
> {
>   "setup": [],
>   "resource": {
>     "access": {},
>     "defaults": {},
>     "connector": "sql",
>     "output": {
>       "kind": "single",
>       "collection": "records"
>     },
>     "credential_kind": "sql",
>     "connection_fields": [
>       "connection"
>     ]
>   },
>   "connection_setup": {
>     "type": "object",
>     "value": {
>       "connection": {
>         "fieldType": {
>           "type": "union",
>           "value": [
>             {
>               "type": "object",
>               "value": {
>                 "kind": {
>                   "fieldType": {
>                     "type": "literal",
>                     "value": "clickhouse"
>                   },
>                   "optional": false
>                 },
>                 "endpoint": {
>                   "fieldType": {
>                     "type": "string"
>                   },
>                   "optional": false
>                 }
>               }
>             },
>             {
>               "type": "object",
>               "value": {
>                 "kind": {
>                   "fieldType": {
>                     "type": "literal",
>                     "value": "executor"
>                   },
>                   "optional": false
>                 },
>                 "engine": {
>                   "fieldType": {
>                     "type": "string"
>                   },
>                   "optional": false
>                 },
>                 "endpoint": {
>                   "fieldType": {
>                     "type": "string"
>                   },
>                   "optional": false
>                 }
>               }
>             },
>             {
>               "type": "object",
>               "value": {
>                 "kind": {
>                   "fieldType": {
>                     "type": "literal",
>                     "value": "gateway"
>                   },
>                   "optional": false
>                 },
>                 "endpoint": {
>                   "fieldType": {
>                     "type": "string"
>                   },
>                   "optional": false
>                 },
>                 "connection": {
>                   "fieldType": {
>                     "type": "union",
>                     "value": [
>                       {
>                         "type": "object",
>                         "value": {
>                           "kind": {
>                             "fieldType": {
>                               "type": "literal",
>                               "value": "server"
>                             },
>                             "optional": false
>                           },
>                           "host": {
>                             "fieldType": {
>                               "type": "string"
>                             },
>                             "optional": false
>                           },
>                           "port": {
>                             "fieldType": {
>                               "type": "union",
>                               "value": [
>                                 {
>                                   "type": "number"
>                                 },
>                                 {
>                                   "type": "null"
>                                 }
>                               ]
>                             },
>                             "optional": true
>                           },
>                           "instance": {
>                             "fieldType": {
>                               "type": "union",
>                               "value": [
>                                 {
>                                   "type": "string"
>                                 },
>                                 {
>                                   "type": "null"
>                                 }
>                               ]
>                             },
>                             "optional": true
>                           },
>                           "database": {
>                             "fieldType": {
>                               "type": "union",
>                               "value": [
>                                 {
>                                   "type": "string"
>                                 },
>                                 {
>                                   "type": "null"
>                                 }
>                               ]
>                             },
>                             "optional": true
>                           },
>                           "readFrom": {
>                             "fieldType": {
>                               "type": "union",
>                               "value": [
>                                 {
>                                   "type": "literal",
>                                   "value": "primary"
>                                 },
>                                 {
>                                   "type": "literal",
>                                   "value": "readable_secondary"
>                                 }
>                               ]
>                             },
>                             "optional": true
>                           },
>                           "replicaServerId": {
>                             "fieldType": {
>                               "type": "union",
>                               "value": [
>                                 {
>                                   "type": "number"
>                                 },
>                                 {
>                                   "type": "null"
>                                 }
>                               ]
>                             },
>                             "optional": true
>                           },
>                           "properties": {
>                             "fieldType": {
>                               "type": "record",
>                               "keys": {
>                                 "type": "string"
>                               },
>                               "values": {
>                                 "fieldType": {
>                                   "type": "string"
>                                 },
>                                 "optional": false
>                               }
>                             },
>                             "optional": true
>                           }
>                         }
>                       },
>                       {
>                         "type": "object",
>                         "value": {
>                           "kind": {
>                             "fieldType": {
>                               "type": "literal",
>                               "value": "url"
>                             },
>                             "optional": false
>                           },
>                           "url": {
>                             "fieldType": {
>                               "type": "string"
>                             },
>                             "optional": false
>                           },
>                           "quote": {
>                             "fieldType": {
>                               "type": "union",
>                               "value": [
>                                 {
>                                   "type": "literal",
>                                   "value": "double"
>                                 },
>                                 {
>                                   "type": "literal",
>                                   "value": "backtick"
>                                 },
>                                 {
>                                   "type": "literal",
>                                   "value": "bracket"
>                                 }
>                               ]
>                             },
>                             "optional": false
>                           },
>                           "properties": {
>                             "fieldType": {
>                               "type": "record",
>                               "keys": {
>                                 "type": "string"
>                               },
>                               "values": {
>                                 "fieldType": {
>                                   "type": "string"
>                                 },
>                                 "optional": false
>                               }
>                             },
>                             "optional": true
>                           }
>                         }
>                       },
>                       {
>                         "type": "object",
>                         "value": {
>                           "kind": {
>                             "fieldType": {
>                               "type": "literal",
>                               "value": "quack"
>                             },
>                             "optional": false
>                           },
>                           "host": {
>                             "fieldType": {
>                               "type": "string"
>                             },
>                             "optional": false
>                           },
>                           "port": {
>                             "fieldType": {
>                               "type": "number"
>                             },
>                             "optional": false
>                           },
>                           "database": {
>                             "fieldType": {
>                               "type": "string"
>                             },
>                             "optional": false
>                           }
>                         }
>                       }
>                     ]
>                   },
>                   "optional": false
>                 }
>               }
>             },
>             {
>               "type": "object",
>               "value": {
>                 "kind": {
>                   "fieldType": {
>                     "type": "literal",
>                     "value": "snowflake"
>                   },
>                   "optional": false
>                 },
>                 "endpoint": {
>                   "fieldType": {
>                     "type": "string"
>                   },
>                   "optional": false
>                 },
>                 "warehouse": {
>                   "fieldType": {
>                     "type": "string"
>                   },
>                   "optional": false
>                 },
>                 "role": {
>                   "fieldType": {
>                     "type": "union",
>                     "value": [
>                       {
>                         "type": "string"
>                       },
>                       {
>                         "type": "null"
>                       }
>                     ]
>                   },
>                   "optional": true
>                 }
>               }
>             },
>             {
>               "type": "object",
>               "value": {
>                 "kind": {
>                   "fieldType": {
>                     "type": "literal",
>                     "value": "bigquery"
>                   },
>                   "optional": false
>                 },
>                 "endpoint": {
>                   "fieldType": {
>                     "type": "string"
>                   },
>                   "optional": false
>                 },
>                 "project": {
>                   "fieldType": {
>                     "type": "string"
>                   },
>                   "optional": false
>                 },
>                 "location": {
>                   "fieldType": {
>                     "type": "string"
>                   },
>                   "optional": false
>                 },
>                 "maxBytesBilled": {
>                   "fieldType": {
>                     "type": "string"
>                   },
>                   "optional": false
>                 }
>               }
>             },
>             {
>               "type": "object",
>               "value": {
>                 "kind": {
>                   "fieldType": {
>                     "type": "literal",
>                     "value": "databricks"
>                   },
>                   "optional": false
>                 },
>                 "endpoint": {
>                   "fieldType": {
>                     "type": "string"
>                   },
>                   "optional": false
>                 },
>                 "warehouseId": {
>                   "fieldType": {
>                     "type": "string"
>                   },
>                   "optional": false
>                 }
>               }
>             }
>           ]
>         },
>         "optional": false
>       },
>       "table": {
>         "fieldType": {
>           "type": "object",
>           "value": {
>             "database": {
>               "fieldType": {
>                 "type": "union",
>                 "value": [
>                   {
>                     "type": "string"
>                   },
>                   {
>                     "type": "null"
>                   }
>                 ]
>               },
>               "optional": true
>             },
>             "schema": {
>               "fieldType": {
>                 "type": "union",
>                 "value": [
>                   {
>                     "type": "string"
>                   },
>                   {
>                     "type": "null"
>                   }
>                 ]
>               },
>               "optional": true
>             },
>             "name": {
>               "fieldType": {
>                 "type": "string"
>               },
>               "optional": false
>             }
>           }
>         },
>         "optional": true
>       },
>       "receipts": {
>         "fieldType": {
>           "type": "union",
>           "value": [
>             {
>               "type": "object",
>               "value": {
>                 "database": {
>                   "fieldType": {
>                     "type": "union",
>                     "value": [
>                       {
>                         "type": "string"
>                       },
>                       {
>                         "type": "null"
>                       }
>                     ]
>                   },
>                   "optional": true
>                 },
>                 "schema": {
>                   "fieldType": {
>                     "type": "union",
>                     "value": [
>                       {
>                         "type": "string"
>                       },
>                       {
>                         "type": "null"
>                       }
>                     ]
>                   },
>                   "optional": true
>                 },
>                 "name": {
>                   "fieldType": {
>                     "type": "string"
>                   },
>                   "optional": false
>                 }
>               }
>             },
>             {
>               "type": "null"
>             }
>           ]
>         },
>         "optional": true
>       },
>       "changeRecord": {
>         "fieldType": {
>           "type": "union",
>           "value": [
>             {
>               "type": "null"
>             },
>             {
>               "type": "object",
>               "value": {
>                 "kind": {
>                   "fieldType": {
>                     "type": "literal",
>                     "value": "capture"
>                   },
>                   "optional": false
>                 },
>                 "captureInstance": {
>                   "fieldType": {
>                     "type": "string"
>                   },
>                   "optional": false
>                 }
>               }
>             },
>             {
>               "type": "object",
>               "value": {
>                 "kind": {
>                   "fieldType": {
>                     "type": "literal",
>                     "value": "logminer"
>                   },
>                   "optional": false
>                 },
>                 "root": {
>                   "fieldType": {
>                     "type": "union",
>                     "value": [
>                       {
>                         "type": "union",
>                         "value": [
>                           {
>                             "type": "object",
>                             "value": {
>                               "kind": {
>                                 "fieldType": {
>                                   "type": "literal",
>                                   "value": "server"
>                                 },
>                                 "optional": false
>                               },
>                               "host": {
>                                 "fieldType": {
>                                   "type": "string"
>                                 },
>                                 "optional": false
>                               },
>                               "port": {
>                                 "fieldType": {
>                                   "type": "union",
>                                   "value": [
>                                     {
>                                       "type": "number"
>                                     },
>                                     {
>                                       "type": "null"
>                                     }
>                                   ]
>                                 },
>                                 "optional": true
>                               },
>                               "instance": {
>                                 "fieldType": {
>                                   "type": "union",
>                                   "value": [
>                                     {
>                                       "type": "string"
>                                     },
>                                     {
>                                       "type": "null"
>                                     }
>                                   ]
>                                 },
>                                 "optional": true
>                               },
>                               "database": {
>                                 "fieldType": {
>                                   "type": "union",
>                                   "value": [
>                                     {
>                                       "type": "string"
>                                     },
>                                     {
>                                       "type": "null"
>                                     }
>                                   ]
>                                 },
>                                 "optional": true
>                               },
>                               "readFrom": {
>                                 "fieldType": {
>                                   "type": "union",
>                                   "value": [
>                                     {
>                                       "type": "literal",
>                                       "value": "primary"
>                                     },
>                                     {
>                                       "type": "literal",
>                                       "value": "readable_secondary"
>                                     }
>                                   ]
>                                 },
>                                 "optional": true
>                               },
>                               "replicaServerId": {
>                                 "fieldType": {
>                                   "type": "union",
>                                   "value": [
>                                     {
>                                       "type": "number"
>                                     },
>                                     {
>                                       "type": "null"
>                                     }
>                                   ]
>                                 },
>                                 "optional": true
>                               },
>                               "properties": {
>                                 "fieldType": {
>                                   "type": "record",
>                                   "keys": {
>                                     "type": "string"
>                                   },
>                                   "values": {
>                                     "fieldType": {
>                                       "type": "string"
>                                     },
>                                     "optional": false
>                                   }
>                                 },
>                                 "optional": true
>                               }
>                             }
>                           },
>                           {
>                             "type": "object",
>                             "value": {
>                               "kind": {
>                                 "fieldType": {
>                                   "type": "literal",
>                                   "value": "url"
>                                 },
>                                 "optional": false
>                               },
>                               "url": {
>                                 "fieldType": {
>                                   "type": "string"
>                                 },
>                                 "optional": false
>                               },
>                               "quote": {
>                                 "fieldType": {
>                                   "type": "union",
>                                   "value": [
>                                     {
>                                       "type": "literal",
>                                       "value": "double"
>                                     },
>                                     {
>                                       "type": "literal",
>                                       "value": "backtick"
>                                     },
>                                     {
>                                       "type": "literal",
>                                       "value": "bracket"
>                                     }
>                                   ]
>                                 },
>                                 "optional": false
>                               },
>                               "properties": {
>                                 "fieldType": {
>                                   "type": "record",
>                                   "keys": {
>                                     "type": "string"
>                                   },
>                                   "values": {
>                                     "fieldType": {
>                                       "type": "string"
>                                     },
>                                     "optional": false
>                                   }
>                                 },
>                                 "optional": true
>                               }
>                             }
>                           },
>                           {
>                             "type": "object",
>                             "value": {
>                               "kind": {
>                                 "fieldType": {
>                                   "type": "literal",
>                                   "value": "quack"
>                                 },
>                                 "optional": false
>                               },
>                               "host": {
>                                 "fieldType": {
>                                   "type": "string"
>                                 },
>                                 "optional": false
>                               },
>                               "port": {
>                                 "fieldType": {
>                                   "type": "number"
>                                 },
>                                 "optional": false
>                               },
>                               "database": {
>                                 "fieldType": {
>                                   "type": "string"
>                                 },
>                                 "optional": false
>                               }
>                             }
>                           }
>                         ]
>                       },
>                       {
>                         "type": "null"
>                       }
>                     ]
>                   },
>                   "optional": true
>                 }
>               }
>             }
>           ]
>         },
>         "optional": true
>       },
>       "icebergCatalogs": {
>         "fieldType": {
>           "type": "record",
>           "keys": {
>             "type": "string"
>           },
>           "values": {
>             "fieldType": {
>               "type": "string"
>             },
>             "optional": false
>           }
>         },
>         "optional": true
>       }
>     }
>   },
>   "execution": null
> }
> ```

Native admission analysis is available for this exact declaration.

**Collection: records**

| Contract | Meaning |
| - | - |
| Initial | Enumeration of observed records |
| Changes | Current record read after a change indication |
| Deletions | Explicit deletion evidence |
| Resume | Opaque cursor |
| Gap | Explicit repair required after a gap |
| Retention | Unspecified |

> **Complete native profile**
>
> ```json theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}}
> {
>   "movement": {
>     "exchanges": {},
>     "nativeInputLimitBytes": "0",
>     "steps": [
>       {
>         "id": "acquire.1",
>         "inputs": [],
>         "action": {
>           "operation": "acquire",
>           "subject": "native input",
>           "limitBytes": "0"
>         }
>       },
>       {
>         "id": "retain.1",
>         "inputs": [
>           "acquire.1"
>         ],
>         "action": {
>           "operation": "retain",
>           "subject": "acquisition evidence",
>           "reason": "recovery",
>           "release": "acquisition_custody"
>         }
>       },
>       {
>         "id": "interpret.1",
>         "inputs": [
>           "retain.1"
>         ],
>         "action": {
>           "operation": "interpret",
>           "subject": "acquired input",
>           "produces": "records"
>         }
>       },
>       {
>         "id": "materialize.1",
>         "inputs": [
>           "interpret.1"
>         ],
>         "action": {
>           "operation": "materialize",
>           "subject": "source rows",
>           "reason": "serving",
>           "release": "replacement"
>         }
>       },
>       {
>         "id": "publish.1",
>         "inputs": [
>           "materialize.1"
>         ],
>         "action": {
>           "operation": "publish",
>           "subject": "source rows",
>           "visibility": "with_acquisition"
>         }
>       }
>     ]
>   },
>   "initial": "enumeration",
>   "changes": "current_state_after_change",
>   "deletions": "explicit_events",
>   "resume": "opaque_cursor",
>   "retentionMs": null,
>   "gap": "explicit_repair",
>   "limits": {
>     "exchange_evidence_bytes": "524288",
>     "publication_page_records": "128",
>     "record_fields": "32"
>   },
>   "restrictions": [],
>   "commands": {}
> }
> ```

> **Commands, occurrences and artifacts**
>
> ```json theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}}
> {
>   "records": {
>     "records": {
>       "protocol": "record_observation",
>       "coverage": "incremental_snapshot",
>       "consistency": "observations",
>       "atomicity": "record",
>       "history": "observations",
>       "recordRefresh": false,
>       "reconciliation": false,
>       "notifications": false,
>       "snapshotMaxRows": null,
>       "profile": {
>         "movement": {
>           "exchanges": {},
>           "nativeInputLimitBytes": "0",
>           "steps": [
>             {
>               "id": "acquire.1",
>               "inputs": [],
>               "action": {
>                 "operation": "acquire",
>                 "subject": "native input",
>                 "limitBytes": "0"
>               }
>             },
>             {
>               "id": "retain.1",
>               "inputs": [
>                 "acquire.1"
>               ],
>               "action": {
>                 "operation": "retain",
>                 "subject": "acquisition evidence",
>                 "reason": "recovery",
>                 "release": "acquisition_custody"
>               }
>             },
>             {
>               "id": "interpret.1",
>               "inputs": [
>                 "retain.1"
>               ],
>               "action": {
>                 "operation": "interpret",
>                 "subject": "acquired input",
>                 "produces": "records"
>               }
>             },
>             {
>               "id": "materialize.1",
>               "inputs": [
>                 "interpret.1"
>               ],
>               "action": {
>                 "operation": "materialize",
>                 "subject": "source rows",
>                 "reason": "serving",
>                 "release": "replacement"
>               }
>             },
>             {
>               "id": "publish.1",
>               "inputs": [
>                 "materialize.1"
>               ],
>               "action": {
>                 "operation": "publish",
>                 "subject": "source rows",
>                 "visibility": "with_acquisition"
>               }
>             }
>           ]
>         },
>         "initial": "enumeration",
>         "changes": "current_state_after_change",
>         "deletions": "explicit_events",
>         "resume": "opaque_cursor",
>         "retentionMs": null,
>         "gap": "explicit_repair",
>         "limits": {
>           "exchange_evidence_bytes": "524288",
>           "publication_page_records": "128",
>           "record_fields": "32"
>         },
>         "restrictions": [],
>         "commands": {}
>       }
>     }
>   },
>   "occurrences": null,
>   "artifacts": {
>     "raw_archive": false,
>     "native_file_transfer_limit_bytes": null,
>     "external_versions": false,
>     "files": {}
>   },
>   "commands": {}
> }
> ```

**Recorded checks**

| Requirement | Scope | Evidence | Result |
| - | - | - | - |
| change-history-gap | \{"kind":"collection","name":"records"} | This resource is inventoried from its executable declaration. No case-scoped check receipt is attached; historical provider observations do not qualify this configuration. | Execution result unavailable |
| page-publication-recovery | \{"kind":"collection","name":"records"} | This resource is inventoried from its executable declaration. No case-scoped check receipt is attached; historical provider observations do not qualify this configuration. | Execution result unavailable |

Hosted qualification: **unestablished for this catalog configuration**. Installed connections report their own identity, authority and current status.

### watermark: Monotonic column

The following example matches configuration `standard`.

```ts theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}}
import { sql } from "@bijection/connectors/sql";
import { v } from "bijection/values";
export const records = sql.table.watermark({
  schema: { id: v.int64(), updated_at: v.int64() },
  dialect: "mysql",
  key: ["id"],
  watermark: { column: "updated_at" },
});
```

> **Inferred record types**
>
> ```ts theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}}
> {
>   "id": bigint;
>   "updated_at": bigint;
> }
> ```

#### Configuration: standard

Case: `sql/table/watermark/standard`.

Connection and resource configuration are declared by this exact case.

Credential kind: `sql`. Keep credential material in the private credential inventory.

| Setting | Type | Required | Owner |
| - | - | - | - |
| `connection` | object or object or object or object or object or object | Yes | Shared connection |
| `table` | object | No | Resource binding |
| `receipts` | object or null | No | Resource binding |
| `changeRecord` | null or object or object | No | Resource binding |
| `icebergCatalogs` | record of string | No | Resource binding |

> **Complete configuration contract**
>
> ```json theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}}
> {
>   "setup": [],
>   "resource": {
>     "access": {},
>     "defaults": {},
>     "connector": "sql",
>     "output": {
>       "kind": "single",
>       "collection": "records"
>     },
>     "credential_kind": "sql",
>     "connection_fields": [
>       "connection"
>     ]
>   },
>   "connection_setup": {
>     "type": "object",
>     "value": {
>       "connection": {
>         "fieldType": {
>           "type": "union",
>           "value": [
>             {
>               "type": "object",
>               "value": {
>                 "kind": {
>                   "fieldType": {
>                     "type": "literal",
>                     "value": "clickhouse"
>                   },
>                   "optional": false
>                 },
>                 "endpoint": {
>                   "fieldType": {
>                     "type": "string"
>                   },
>                   "optional": false
>                 }
>               }
>             },
>             {
>               "type": "object",
>               "value": {
>                 "kind": {
>                   "fieldType": {
>                     "type": "literal",
>                     "value": "executor"
>                   },
>                   "optional": false
>                 },
>                 "engine": {
>                   "fieldType": {
>                     "type": "string"
>                   },
>                   "optional": false
>                 },
>                 "endpoint": {
>                   "fieldType": {
>                     "type": "string"
>                   },
>                   "optional": false
>                 }
>               }
>             },
>             {
>               "type": "object",
>               "value": {
>                 "kind": {
>                   "fieldType": {
>                     "type": "literal",
>                     "value": "gateway"
>                   },
>                   "optional": false
>                 },
>                 "endpoint": {
>                   "fieldType": {
>                     "type": "string"
>                   },
>                   "optional": false
>                 },
>                 "connection": {
>                   "fieldType": {
>                     "type": "union",
>                     "value": [
>                       {
>                         "type": "object",
>                         "value": {
>                           "kind": {
>                             "fieldType": {
>                               "type": "literal",
>                               "value": "server"
>                             },
>                             "optional": false
>                           },
>                           "host": {
>                             "fieldType": {
>                               "type": "string"
>                             },
>                             "optional": false
>                           },
>                           "port": {
>                             "fieldType": {
>                               "type": "union",
>                               "value": [
>                                 {
>                                   "type": "number"
>                                 },
>                                 {
>                                   "type": "null"
>                                 }
>                               ]
>                             },
>                             "optional": true
>                           },
>                           "instance": {
>                             "fieldType": {
>                               "type": "union",
>                               "value": [
>                                 {
>                                   "type": "string"
>                                 },
>                                 {
>                                   "type": "null"
>                                 }
>                               ]
>                             },
>                             "optional": true
>                           },
>                           "database": {
>                             "fieldType": {
>                               "type": "union",
>                               "value": [
>                                 {
>                                   "type": "string"
>                                 },
>                                 {
>                                   "type": "null"
>                                 }
>                               ]
>                             },
>                             "optional": true
>                           },
>                           "readFrom": {
>                             "fieldType": {
>                               "type": "union",
>                               "value": [
>                                 {
>                                   "type": "literal",
>                                   "value": "primary"
>                                 },
>                                 {
>                                   "type": "literal",
>                                   "value": "readable_secondary"
>                                 }
>                               ]
>                             },
>                             "optional": true
>                           },
>                           "replicaServerId": {
>                             "fieldType": {
>                               "type": "union",
>                               "value": [
>                                 {
>                                   "type": "number"
>                                 },
>                                 {
>                                   "type": "null"
>                                 }
>                               ]
>                             },
>                             "optional": true
>                           },
>                           "properties": {
>                             "fieldType": {
>                               "type": "record",
>                               "keys": {
>                                 "type": "string"
>                               },
>                               "values": {
>                                 "fieldType": {
>                                   "type": "string"
>                                 },
>                                 "optional": false
>                               }
>                             },
>                             "optional": true
>                           }
>                         }
>                       },
>                       {
>                         "type": "object",
>                         "value": {
>                           "kind": {
>                             "fieldType": {
>                               "type": "literal",
>                               "value": "url"
>                             },
>                             "optional": false
>                           },
>                           "url": {
>                             "fieldType": {
>                               "type": "string"
>                             },
>                             "optional": false
>                           },
>                           "quote": {
>                             "fieldType": {
>                               "type": "union",
>                               "value": [
>                                 {
>                                   "type": "literal",
>                                   "value": "double"
>                                 },
>                                 {
>                                   "type": "literal",
>                                   "value": "backtick"
>                                 },
>                                 {
>                                   "type": "literal",
>                                   "value": "bracket"
>                                 }
>                               ]
>                             },
>                             "optional": false
>                           },
>                           "properties": {
>                             "fieldType": {
>                               "type": "record",
>                               "keys": {
>                                 "type": "string"
>                               },
>                               "values": {
>                                 "fieldType": {
>                                   "type": "string"
>                                 },
>                                 "optional": false
>                               }
>                             },
>                             "optional": true
>                           }
>                         }
>                       },
>                       {
>                         "type": "object",
>                         "value": {
>                           "kind": {
>                             "fieldType": {
>                               "type": "literal",
>                               "value": "quack"
>                             },
>                             "optional": false
>                           },
>                           "host": {
>                             "fieldType": {
>                               "type": "string"
>                             },
>                             "optional": false
>                           },
>                           "port": {
>                             "fieldType": {
>                               "type": "number"
>                             },
>                             "optional": false
>                           },
>                           "database": {
>                             "fieldType": {
>                               "type": "string"
>                             },
>                             "optional": false
>                           }
>                         }
>                       }
>                     ]
>                   },
>                   "optional": false
>                 }
>               }
>             },
>             {
>               "type": "object",
>               "value": {
>                 "kind": {
>                   "fieldType": {
>                     "type": "literal",
>                     "value": "snowflake"
>                   },
>                   "optional": false
>                 },
>                 "endpoint": {
>                   "fieldType": {
>                     "type": "string"
>                   },
>                   "optional": false
>                 },
>                 "warehouse": {
>                   "fieldType": {
>                     "type": "string"
>                   },
>                   "optional": false
>                 },
>                 "role": {
>                   "fieldType": {
>                     "type": "union",
>                     "value": [
>                       {
>                         "type": "string"
>                       },
>                       {
>                         "type": "null"
>                       }
>                     ]
>                   },
>                   "optional": true
>                 }
>               }
>             },
>             {
>               "type": "object",
>               "value": {
>                 "kind": {
>                   "fieldType": {
>                     "type": "literal",
>                     "value": "bigquery"
>                   },
>                   "optional": false
>                 },
>                 "endpoint": {
>                   "fieldType": {
>                     "type": "string"
>                   },
>                   "optional": false
>                 },
>                 "project": {
>                   "fieldType": {
>                     "type": "string"
>                   },
>                   "optional": false
>                 },
>                 "location": {
>                   "fieldType": {
>                     "type": "string"
>                   },
>                   "optional": false
>                 },
>                 "maxBytesBilled": {
>                   "fieldType": {
>                     "type": "string"
>                   },
>                   "optional": false
>                 }
>               }
>             },
>             {
>               "type": "object",
>               "value": {
>                 "kind": {
>                   "fieldType": {
>                     "type": "literal",
>                     "value": "databricks"
>                   },
>                   "optional": false
>                 },
>                 "endpoint": {
>                   "fieldType": {
>                     "type": "string"
>                   },
>                   "optional": false
>                 },
>                 "warehouseId": {
>                   "fieldType": {
>                     "type": "string"
>                   },
>                   "optional": false
>                 }
>               }
>             }
>           ]
>         },
>         "optional": false
>       },
>       "table": {
>         "fieldType": {
>           "type": "object",
>           "value": {
>             "database": {
>               "fieldType": {
>                 "type": "union",
>                 "value": [
>                   {
>                     "type": "string"
>                   },
>                   {
>                     "type": "null"
>                   }
>                 ]
>               },
>               "optional": true
>             },
>             "schema": {
>               "fieldType": {
>                 "type": "union",
>                 "value": [
>                   {
>                     "type": "string"
>                   },
>                   {
>                     "type": "null"
>                   }
>                 ]
>               },
>               "optional": true
>             },
>             "name": {
>               "fieldType": {
>                 "type": "string"
>               },
>               "optional": false
>             }
>           }
>         },
>         "optional": true
>       },
>       "receipts": {
>         "fieldType": {
>           "type": "union",
>           "value": [
>             {
>               "type": "object",
>               "value": {
>                 "database": {
>                   "fieldType": {
>                     "type": "union",
>                     "value": [
>                       {
>                         "type": "string"
>                       },
>                       {
>                         "type": "null"
>                       }
>                     ]
>                   },
>                   "optional": true
>                 },
>                 "schema": {
>                   "fieldType": {
>                     "type": "union",
>                     "value": [
>                       {
>                         "type": "string"
>                       },
>                       {
>                         "type": "null"
>                       }
>                     ]
>                   },
>                   "optional": true
>                 },
>                 "name": {
>                   "fieldType": {
>                     "type": "string"
>                   },
>                   "optional": false
>                 }
>               }
>             },
>             {
>               "type": "null"
>             }
>           ]
>         },
>         "optional": true
>       },
>       "changeRecord": {
>         "fieldType": {
>           "type": "union",
>           "value": [
>             {
>               "type": "null"
>             },
>             {
>               "type": "object",
>               "value": {
>                 "kind": {
>                   "fieldType": {
>                     "type": "literal",
>                     "value": "capture"
>                   },
>                   "optional": false
>                 },
>                 "captureInstance": {
>                   "fieldType": {
>                     "type": "string"
>                   },
>                   "optional": false
>                 }
>               }
>             },
>             {
>               "type": "object",
>               "value": {
>                 "kind": {
>                   "fieldType": {
>                     "type": "literal",
>                     "value": "logminer"
>                   },
>                   "optional": false
>                 },
>                 "root": {
>                   "fieldType": {
>                     "type": "union",
>                     "value": [
>                       {
>                         "type": "union",
>                         "value": [
>                           {
>                             "type": "object",
>                             "value": {
>                               "kind": {
>                                 "fieldType": {
>                                   "type": "literal",
>                                   "value": "server"
>                                 },
>                                 "optional": false
>                               },
>                               "host": {
>                                 "fieldType": {
>                                   "type": "string"
>                                 },
>                                 "optional": false
>                               },
>                               "port": {
>                                 "fieldType": {
>                                   "type": "union",
>                                   "value": [
>                                     {
>                                       "type": "number"
>                                     },
>                                     {
>                                       "type": "null"
>                                     }
>                                   ]
>                                 },
>                                 "optional": true
>                               },
>                               "instance": {
>                                 "fieldType": {
>                                   "type": "union",
>                                   "value": [
>                                     {
>                                       "type": "string"
>                                     },
>                                     {
>                                       "type": "null"
>                                     }
>                                   ]
>                                 },
>                                 "optional": true
>                               },
>                               "database": {
>                                 "fieldType": {
>                                   "type": "union",
>                                   "value": [
>                                     {
>                                       "type": "string"
>                                     },
>                                     {
>                                       "type": "null"
>                                     }
>                                   ]
>                                 },
>                                 "optional": true
>                               },
>                               "readFrom": {
>                                 "fieldType": {
>                                   "type": "union",
>                                   "value": [
>                                     {
>                                       "type": "literal",
>                                       "value": "primary"
>                                     },
>                                     {
>                                       "type": "literal",
>                                       "value": "readable_secondary"
>                                     }
>                                   ]
>                                 },
>                                 "optional": true
>                               },
>                               "replicaServerId": {
>                                 "fieldType": {
>                                   "type": "union",
>                                   "value": [
>                                     {
>                                       "type": "number"
>                                     },
>                                     {
>                                       "type": "null"
>                                     }
>                                   ]
>                                 },
>                                 "optional": true
>                               },
>                               "properties": {
>                                 "fieldType": {
>                                   "type": "record",
>                                   "keys": {
>                                     "type": "string"
>                                   },
>                                   "values": {
>                                     "fieldType": {
>                                       "type": "string"
>                                     },
>                                     "optional": false
>                                   }
>                                 },
>                                 "optional": true
>                               }
>                             }
>                           },
>                           {
>                             "type": "object",
>                             "value": {
>                               "kind": {
>                                 "fieldType": {
>                                   "type": "literal",
>                                   "value": "url"
>                                 },
>                                 "optional": false
>                               },
>                               "url": {
>                                 "fieldType": {
>                                   "type": "string"
>                                 },
>                                 "optional": false
>                               },
>                               "quote": {
>                                 "fieldType": {
>                                   "type": "union",
>                                   "value": [
>                                     {
>                                       "type": "literal",
>                                       "value": "double"
>                                     },
>                                     {
>                                       "type": "literal",
>                                       "value": "backtick"
>                                     },
>                                     {
>                                       "type": "literal",
>                                       "value": "bracket"
>                                     }
>                                   ]
>                                 },
>                                 "optional": false
>                               },
>                               "properties": {
>                                 "fieldType": {
>                                   "type": "record",
>                                   "keys": {
>                                     "type": "string"
>                                   },
>                                   "values": {
>                                     "fieldType": {
>                                       "type": "string"
>                                     },
>                                     "optional": false
>                                   }
>                                 },
>                                 "optional": true
>                               }
>                             }
>                           },
>                           {
>                             "type": "object",
>                             "value": {
>                               "kind": {
>                                 "fieldType": {
>                                   "type": "literal",
>                                   "value": "quack"
>                                 },
>                                 "optional": false
>                               },
>                               "host": {
>                                 "fieldType": {
>                                   "type": "string"
>                                 },
>                                 "optional": false
>                               },
>                               "port": {
>                                 "fieldType": {
>                                   "type": "number"
>                                 },
>                                 "optional": false
>                               },
>                               "database": {
>                                 "fieldType": {
>                                   "type": "string"
>                                 },
>                                 "optional": false
>                               }
>                             }
>                           }
>                         ]
>                       },
>                       {
>                         "type": "null"
>                       }
>                     ]
>                   },
>                   "optional": true
>                 }
>               }
>             }
>           ]
>         },
>         "optional": true
>       },
>       "icebergCatalogs": {
>         "fieldType": {
>           "type": "record",
>           "keys": {
>             "type": "string"
>           },
>           "values": {
>             "fieldType": {
>               "type": "string"
>             },
>             "optional": false
>           }
>         },
>         "optional": true
>       }
>     }
>   },
>   "execution": null
> }
> ```

Native admission analysis is available for this exact declaration.

**Collection: records**

| Contract | Meaning |
| - | - |
| Initial | Enumeration of observed records |
| Changes | Repeated observations of current records |
| Deletions | Deletion detection unsupported |
| Resume | Opaque cursor |
| Gap | Explicit repair required after a gap |
| Retention | Unspecified |

> **Complete native profile**
>
> ```json theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}}
> {
>   "movement": {
>     "exchanges": {},
>     "nativeInputLimitBytes": "0",
>     "steps": [
>       {
>         "id": "acquire.1",
>         "inputs": [],
>         "action": {
>           "operation": "acquire",
>           "subject": "native input",
>           "limitBytes": "0"
>         }
>       },
>       {
>         "id": "retain.1",
>         "inputs": [
>           "acquire.1"
>         ],
>         "action": {
>           "operation": "retain",
>           "subject": "acquisition evidence",
>           "reason": "recovery",
>           "release": "acquisition_custody"
>         }
>       },
>       {
>         "id": "interpret.1",
>         "inputs": [
>           "retain.1"
>         ],
>         "action": {
>           "operation": "interpret",
>           "subject": "acquired input",
>           "produces": "records"
>         }
>       },
>       {
>         "id": "materialize.1",
>         "inputs": [
>           "interpret.1"
>         ],
>         "action": {
>           "operation": "materialize",
>           "subject": "source rows",
>           "reason": "serving",
>           "release": "replacement"
>         }
>       },
>       {
>         "id": "publish.1",
>         "inputs": [
>           "materialize.1"
>         ],
>         "action": {
>           "operation": "publish",
>           "subject": "source rows",
>           "visibility": "with_acquisition"
>         }
>       }
>     ]
>   },
>   "initial": "enumeration",
>   "changes": "observations",
>   "deletions": "unsupported",
>   "resume": "opaque_cursor",
>   "retentionMs": null,
>   "gap": "explicit_repair",
>   "limits": {
>     "exchange_evidence_bytes": "524288",
>     "publication_page_records": "128",
>     "record_fields": "32"
>   },
>   "restrictions": [
>     "Watermark reads can miss late commits or updates that do not advance the watermark"
>   ],
>   "commands": {}
> }
> ```

> **Commands, occurrences and artifacts**
>
> ```json theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}}
> {
>   "records": {
>     "records": {
>       "protocol": "record_observation",
>       "coverage": "records",
>       "consistency": "observations",
>       "atomicity": "record",
>       "history": "observations",
>       "recordRefresh": false,
>       "reconciliation": false,
>       "notifications": false,
>       "snapshotMaxRows": null,
>       "profile": {
>         "movement": {
>           "exchanges": {},
>           "nativeInputLimitBytes": "0",
>           "steps": [
>             {
>               "id": "acquire.1",
>               "inputs": [],
>               "action": {
>                 "operation": "acquire",
>                 "subject": "native input",
>                 "limitBytes": "0"
>               }
>             },
>             {
>               "id": "retain.1",
>               "inputs": [
>                 "acquire.1"
>               ],
>               "action": {
>                 "operation": "retain",
>                 "subject": "acquisition evidence",
>                 "reason": "recovery",
>                 "release": "acquisition_custody"
>               }
>             },
>             {
>               "id": "interpret.1",
>               "inputs": [
>                 "retain.1"
>               ],
>               "action": {
>                 "operation": "interpret",
>                 "subject": "acquired input",
>                 "produces": "records"
>               }
>             },
>             {
>               "id": "materialize.1",
>               "inputs": [
>                 "interpret.1"
>               ],
>               "action": {
>                 "operation": "materialize",
>                 "subject": "source rows",
>                 "reason": "serving",
>                 "release": "replacement"
>               }
>             },
>             {
>               "id": "publish.1",
>               "inputs": [
>                 "materialize.1"
>               ],
>               "action": {
>                 "operation": "publish",
>                 "subject": "source rows",
>                 "visibility": "with_acquisition"
>               }
>             }
>           ]
>         },
>         "initial": "enumeration",
>         "changes": "observations",
>         "deletions": "unsupported",
>         "resume": "opaque_cursor",
>         "retentionMs": null,
>         "gap": "explicit_repair",
>         "limits": {
>           "exchange_evidence_bytes": "524288",
>           "publication_page_records": "128",
>           "record_fields": "32"
>         },
>         "restrictions": [
>           "Watermark reads can miss late commits or updates that do not advance the watermark"
>         ],
>         "commands": {}
>       }
>     }
>   },
>   "occurrences": null,
>   "artifacts": {
>     "raw_archive": false,
>     "native_file_transfer_limit_bytes": null,
>     "external_versions": false,
>     "files": {}
>   },
>   "commands": {}
> }
> ```

**Recorded checks**

| Requirement | Scope | Evidence | Result |
| - | - | - | - |
| page-publication-recovery | \{"kind":"collection","name":"records"} | This resource is inventoried from its executable declaration. No case-scoped check receipt is attached; historical provider observations do not qualify this configuration. | Execution result unavailable |
| watermark-pagination | \{"kind":"collection","name":"records"} | This resource is inventoried from its executable declaration. No case-scoped check receipt is attached; historical provider observations do not qualify this configuration. | Execution result unavailable |

Hosted qualification: **unestablished for this catalog configuration**. Installed connections report their own identity, authority and current status.

## Provider guidance

These recipes return ordinary typed resources or atomic resource groups. The registration in `native.ts` owns their callable factories, named modes and representative cases. Credentials, endpoints and physical resource selection belong to deployment bindings. Application schemas and message interpretation belong to the declaration. Acquisition and recovery guarantees come from native admission, not the mode name.

Each public resource has a case and explicit scoped evidence requirements. These registrations alone establish no executed provider checks or hosted qualification. The catalog reports missing execution evidence as unestablished. Native source inspection remains authoritative for the actual installation.

Protocol helpers such as HTTP request builders and generated operation descriptors are authoring primitives. They do not count as independently installable provider resources. External compute remains owned by its provider.

## Provider references

Provider references and prerequisites are maintained in the connector guidance above. No separate provider-documentation review date is recorded.

## Source and evidence

[Canonical connector source](https://github.com/bijectionhq/component-support/blob/b632604330ce9cbcfe17a5a680ef4fbe80f6f672/packages/connectors/src/connectors/native.md), [native analysis](https://github.com/bijectionhq/component-support/blob/b632604330ce9cbcfe17a5a680ef4fbe80f6f672/packages/connectors/contract-analysis.json) and [check receipts](https://github.com/bijectionhq/component-support/blob/b632604330ce9cbcfe17a5a680ef4fbe80f6f672/packages/connectors/evidence.json).

Connector artifact: `905888ea276a2a28e36981a79e8142b2547ea451c3e63162cb6915ad4a7d1305`.

The resource declaration examples above are compiled and compared with exact catalog declarations. Recorded checks apply only to their source, declaration and runtime identities. Configure a connection and inspect its status to establish deployment-specific readiness.


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