@katerai/sdk 0.6.0 → 0.7.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +23 -0
- package/README.md +23 -16
- package/client.d.mts +10 -13
- package/client.d.mts.map +1 -1
- package/client.d.ts +10 -13
- package/client.d.ts.map +1 -1
- package/client.js +37 -15
- package/client.js.map +1 -1
- package/client.mjs +37 -15
- package/client.mjs.map +1 -1
- package/internal/utils/log.d.mts.map +1 -1
- package/internal/utils/log.d.ts.map +1 -1
- package/internal/utils/log.js +2 -1
- package/internal/utils/log.js.map +1 -1
- package/internal/utils/log.mjs +2 -1
- package/internal/utils/log.mjs.map +1 -1
- package/package.json +2 -2
- package/resources/index.d.mts +0 -2
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +0 -2
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js +1 -5
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +0 -2
- package/resources/index.mjs.map +1 -1
- package/resources/v1/connections.d.mts +216 -1
- package/resources/v1/connections.d.mts.map +1 -1
- package/resources/v1/connections.d.ts +216 -1
- package/resources/v1/connections.d.ts.map +1 -1
- package/resources/v1/connections.js +22 -2
- package/resources/v1/connections.js.map +1 -1
- package/resources/v1/connections.mjs +20 -1
- package/resources/v1/connections.mjs.map +1 -1
- package/resources/v1/index.d.mts +2 -6
- package/resources/v1/index.d.mts.map +1 -1
- package/resources/v1/index.d.ts +2 -6
- package/resources/v1/index.d.ts.map +1 -1
- package/resources/v1/index.js +5 -13
- package/resources/v1/index.js.map +1 -1
- package/resources/v1/index.mjs +2 -6
- package/resources/v1/index.mjs.map +1 -1
- package/resources/v1/tenants.d.mts +125 -1
- package/resources/v1/tenants.d.mts.map +1 -1
- package/resources/v1/tenants.d.ts +125 -1
- package/resources/v1/tenants.d.ts.map +1 -1
- package/resources/v1/tenants.js +46 -2
- package/resources/v1/tenants.js.map +1 -1
- package/resources/v1/tenants.mjs +44 -1
- package/resources/v1/tenants.mjs.map +1 -1
- package/resources/v1/v1.d.mts +6 -22
- package/resources/v1/v1.d.mts.map +1 -1
- package/resources/v1/v1.d.ts +6 -22
- package/resources/v1/v1.d.ts.map +1 -1
- package/resources/v1/v1.js +4 -20
- package/resources/v1/v1.js.map +1 -1
- package/resources/v1/v1.mjs +4 -20
- package/resources/v1/v1.mjs.map +1 -1
- package/src/client.ts +48 -23
- package/src/internal/utils/log.ts +1 -0
- package/src/resources/index.ts +0 -2
- package/src/resources/v1/connections.ts +277 -1
- package/src/resources/v1/index.ts +7 -44
- package/src/resources/v1/tenants.ts +162 -1
- package/src/resources/v1/v1.ts +14 -104
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
- package/resources/healthz.d.mts +0 -16
- package/resources/healthz.d.mts.map +0 -1
- package/resources/healthz.d.ts +0 -16
- package/resources/healthz.d.ts.map +0 -1
- package/resources/healthz.js +0 -15
- package/resources/healthz.js.map +0 -1
- package/resources/healthz.mjs +0 -11
- package/resources/healthz.mjs.map +0 -1
- package/resources/readyz.d.mts +0 -16
- package/resources/readyz.d.mts.map +0 -1
- package/resources/readyz.d.ts +0 -16
- package/resources/readyz.d.ts.map +0 -1
- package/resources/readyz.js +0 -15
- package/resources/readyz.js.map +0 -1
- package/resources/readyz.mjs +0 -11
- package/resources/readyz.mjs.map +0 -1
- package/resources/v1/connections/connections.d.mts +0 -1470
- package/resources/v1/connections/connections.d.mts.map +0 -1
- package/resources/v1/connections/connections.d.ts +0 -1470
- package/resources/v1/connections/connections.d.ts.map +0 -1
- package/resources/v1/connections/connections.js +0 -163
- package/resources/v1/connections/connections.js.map +0 -1
- package/resources/v1/connections/connections.mjs +0 -158
- package/resources/v1/connections/connections.mjs.map +0 -1
- package/resources/v1/connections/databases.d.mts +0 -25
- package/resources/v1/connections/databases.d.mts.map +0 -1
- package/resources/v1/connections/databases.d.ts +0 -25
- package/resources/v1/connections/databases.d.ts.map +0 -1
- package/resources/v1/connections/databases.js +0 -26
- package/resources/v1/connections/databases.js.map +0 -1
- package/resources/v1/connections/databases.mjs +0 -22
- package/resources/v1/connections/databases.mjs.map +0 -1
- package/resources/v1/connections/index.d.mts +0 -5
- package/resources/v1/connections/index.d.mts.map +0 -1
- package/resources/v1/connections/index.d.ts +0 -5
- package/resources/v1/connections/index.d.ts.map +0 -1
- package/resources/v1/connections/index.js +0 -13
- package/resources/v1/connections/index.js.map +0 -1
- package/resources/v1/connections/index.mjs +0 -6
- package/resources/v1/connections/index.mjs.map +0 -1
- package/resources/v1/connections/views.d.mts +0 -77
- package/resources/v1/connections/views.d.mts.map +0 -1
- package/resources/v1/connections/views.d.ts +0 -77
- package/resources/v1/connections/views.d.ts.map +0 -1
- package/resources/v1/connections/views.js +0 -24
- package/resources/v1/connections/views.js.map +0 -1
- package/resources/v1/connections/views.mjs +0 -20
- package/resources/v1/connections/views.mjs.map +0 -1
- package/resources/v1/connections/yaml.d.mts +0 -57
- package/resources/v1/connections/yaml.d.mts.map +0 -1
- package/resources/v1/connections/yaml.d.ts +0 -57
- package/resources/v1/connections/yaml.d.ts.map +0 -1
- package/resources/v1/connections/yaml.js +0 -22
- package/resources/v1/connections/yaml.js.map +0 -1
- package/resources/v1/connections/yaml.mjs +0 -18
- package/resources/v1/connections/yaml.mjs.map +0 -1
- package/resources/v1/github/github.d.mts +0 -99
- package/resources/v1/github/github.d.mts.map +0 -1
- package/resources/v1/github/github.d.ts +0 -99
- package/resources/v1/github/github.d.ts.map +0 -1
- package/resources/v1/github/github.js +0 -49
- package/resources/v1/github/github.js.map +0 -1
- package/resources/v1/github/github.mjs +0 -44
- package/resources/v1/github/github.mjs.map +0 -1
- package/resources/v1/github/index.d.mts +0 -5
- package/resources/v1/github/index.d.mts.map +0 -1
- package/resources/v1/github/index.d.ts +0 -5
- package/resources/v1/github/index.d.ts.map +0 -1
- package/resources/v1/github/index.js +0 -13
- package/resources/v1/github/index.js.map +0 -1
- package/resources/v1/github/index.mjs +0 -6
- package/resources/v1/github/index.mjs.map +0 -1
- package/resources/v1/github/repos.d.mts +0 -54
- package/resources/v1/github/repos.d.mts.map +0 -1
- package/resources/v1/github/repos.d.ts +0 -54
- package/resources/v1/github/repos.d.ts.map +0 -1
- package/resources/v1/github/repos.js +0 -22
- package/resources/v1/github/repos.js.map +0 -1
- package/resources/v1/github/repos.mjs +0 -18
- package/resources/v1/github/repos.mjs.map +0 -1
- package/resources/v1/github/scaffold.d.mts +0 -29
- package/resources/v1/github/scaffold.d.mts.map +0 -1
- package/resources/v1/github/scaffold.d.ts +0 -29
- package/resources/v1/github/scaffold.d.ts.map +0 -1
- package/resources/v1/github/scaffold.js +0 -21
- package/resources/v1/github/scaffold.js.map +0 -1
- package/resources/v1/github/scaffold.mjs +0 -17
- package/resources/v1/github/scaffold.mjs.map +0 -1
- package/resources/v1/github/webhooks.d.mts +0 -28
- package/resources/v1/github/webhooks.d.mts.map +0 -1
- package/resources/v1/github/webhooks.d.ts +0 -28
- package/resources/v1/github/webhooks.d.ts.map +0 -1
- package/resources/v1/github/webhooks.js +0 -27
- package/resources/v1/github/webhooks.js.map +0 -1
- package/resources/v1/github/webhooks.mjs +0 -23
- package/resources/v1/github/webhooks.mjs.map +0 -1
- package/resources/v1/github.d.mts +0 -2
- package/resources/v1/github.d.mts.map +0 -1
- package/resources/v1/github.d.ts +0 -2
- package/resources/v1/github.d.ts.map +0 -1
- package/resources/v1/github.js +0 -6
- package/resources/v1/github.js.map +0 -1
- package/resources/v1/github.mjs +0 -3
- package/resources/v1/github.mjs.map +0 -1
- package/resources/v1/groups/groups.d.mts +0 -162
- package/resources/v1/groups/groups.d.mts.map +0 -1
- package/resources/v1/groups/groups.d.ts +0 -162
- package/resources/v1/groups/groups.d.ts.map +0 -1
- package/resources/v1/groups/groups.js +0 -81
- package/resources/v1/groups/groups.js.map +0 -1
- package/resources/v1/groups/groups.mjs +0 -76
- package/resources/v1/groups/groups.mjs.map +0 -1
- package/resources/v1/groups/index.d.mts +0 -3
- package/resources/v1/groups/index.d.mts.map +0 -1
- package/resources/v1/groups/index.d.ts +0 -3
- package/resources/v1/groups/index.d.ts.map +0 -1
- package/resources/v1/groups/index.js +0 -9
- package/resources/v1/groups/index.js.map +0 -1
- package/resources/v1/groups/index.mjs +0 -4
- package/resources/v1/groups/index.mjs.map +0 -1
- package/resources/v1/groups/tenants.d.mts +0 -55
- package/resources/v1/groups/tenants.d.mts.map +0 -1
- package/resources/v1/groups/tenants.d.ts +0 -55
- package/resources/v1/groups/tenants.d.ts.map +0 -1
- package/resources/v1/groups/tenants.js +0 -39
- package/resources/v1/groups/tenants.js.map +0 -1
- package/resources/v1/groups/tenants.mjs +0 -35
- package/resources/v1/groups/tenants.mjs.map +0 -1
- package/resources/v1/groups.d.mts +0 -2
- package/resources/v1/groups.d.mts.map +0 -1
- package/resources/v1/groups.d.ts +0 -2
- package/resources/v1/groups.d.ts.map +0 -1
- package/resources/v1/groups.js +0 -6
- package/resources/v1/groups.js.map +0 -1
- package/resources/v1/groups.mjs +0 -3
- package/resources/v1/groups.mjs.map +0 -1
- package/resources/v1/me.d.mts +0 -43
- package/resources/v1/me.d.mts.map +0 -1
- package/resources/v1/me.d.ts +0 -43
- package/resources/v1/me.d.ts.map +0 -1
- package/resources/v1/me.js +0 -20
- package/resources/v1/me.js.map +0 -1
- package/resources/v1/me.mjs +0 -16
- package/resources/v1/me.mjs.map +0 -1
- package/resources/v1/org/client.d.mts +0 -53
- package/resources/v1/org/client.d.mts.map +0 -1
- package/resources/v1/org/client.d.ts +0 -53
- package/resources/v1/org/client.d.ts.map +0 -1
- package/resources/v1/org/client.js +0 -25
- package/resources/v1/org/client.js.map +0 -1
- package/resources/v1/org/client.mjs +0 -21
- package/resources/v1/org/client.mjs.map +0 -1
- package/resources/v1/org/index.d.mts +0 -4
- package/resources/v1/org/index.d.mts.map +0 -1
- package/resources/v1/org/index.d.ts +0 -4
- package/resources/v1/org/index.d.ts.map +0 -1
- package/resources/v1/org/index.js +0 -11
- package/resources/v1/org/index.js.map +0 -1
- package/resources/v1/org/index.mjs +0 -5
- package/resources/v1/org/index.mjs.map +0 -1
- package/resources/v1/org/org.d.mts +0 -14
- package/resources/v1/org/org.d.mts.map +0 -1
- package/resources/v1/org/org.d.ts +0 -14
- package/resources/v1/org/org.d.ts.map +0 -1
- package/resources/v1/org/org.js +0 -21
- package/resources/v1/org/org.js.map +0 -1
- package/resources/v1/org/org.mjs +0 -16
- package/resources/v1/org/org.mjs.map +0 -1
- package/resources/v1/org/users.d.mts +0 -87
- package/resources/v1/org/users.d.mts.map +0 -1
- package/resources/v1/org/users.d.ts +0 -87
- package/resources/v1/org/users.d.ts.map +0 -1
- package/resources/v1/org/users.js +0 -60
- package/resources/v1/org/users.js.map +0 -1
- package/resources/v1/org/users.mjs +0 -56
- package/resources/v1/org/users.mjs.map +0 -1
- package/resources/v1/org.d.mts +0 -2
- package/resources/v1/org.d.mts.map +0 -1
- package/resources/v1/org.d.ts +0 -2
- package/resources/v1/org.d.ts.map +0 -1
- package/resources/v1/org.js +0 -6
- package/resources/v1/org.js.map +0 -1
- package/resources/v1/org.mjs +0 -3
- package/resources/v1/org.mjs.map +0 -1
- package/resources/v1/tenants/batch.d.mts +0 -159
- package/resources/v1/tenants/batch.d.mts.map +0 -1
- package/resources/v1/tenants/batch.d.ts +0 -159
- package/resources/v1/tenants/batch.d.ts.map +0 -1
- package/resources/v1/tenants/batch.js +0 -42
- package/resources/v1/tenants/batch.js.map +0 -1
- package/resources/v1/tenants/batch.mjs +0 -38
- package/resources/v1/tenants/batch.mjs.map +0 -1
- package/resources/v1/tenants/groups.d.mts +0 -43
- package/resources/v1/tenants/groups.d.mts.map +0 -1
- package/resources/v1/tenants/groups.d.ts +0 -43
- package/resources/v1/tenants/groups.d.ts.map +0 -1
- package/resources/v1/tenants/groups.js +0 -20
- package/resources/v1/tenants/groups.js.map +0 -1
- package/resources/v1/tenants/groups.mjs +0 -16
- package/resources/v1/tenants/groups.mjs.map +0 -1
- package/resources/v1/tenants/import.d.mts +0 -126
- package/resources/v1/tenants/import.d.mts.map +0 -1
- package/resources/v1/tenants/import.d.ts +0 -126
- package/resources/v1/tenants/import.d.ts.map +0 -1
- package/resources/v1/tenants/import.js +0 -50
- package/resources/v1/tenants/import.js.map +0 -1
- package/resources/v1/tenants/import.mjs +0 -46
- package/resources/v1/tenants/import.mjs.map +0 -1
- package/resources/v1/tenants/index.d.mts +0 -5
- package/resources/v1/tenants/index.d.mts.map +0 -1
- package/resources/v1/tenants/index.d.ts +0 -5
- package/resources/v1/tenants/index.d.ts.map +0 -1
- package/resources/v1/tenants/index.js +0 -13
- package/resources/v1/tenants/index.js.map +0 -1
- package/resources/v1/tenants/index.mjs +0 -6
- package/resources/v1/tenants/index.mjs.map +0 -1
- package/resources/v1/tenants/tenants.d.mts +0 -248
- package/resources/v1/tenants/tenants.d.mts.map +0 -1
- package/resources/v1/tenants/tenants.d.ts +0 -248
- package/resources/v1/tenants/tenants.d.ts.map +0 -1
- package/resources/v1/tenants/tenants.js +0 -113
- package/resources/v1/tenants/tenants.js.map +0 -1
- package/resources/v1/tenants/tenants.mjs +0 -108
- package/resources/v1/tenants/tenants.mjs.map +0 -1
- package/src/resources/healthz.ts +0 -20
- package/src/resources/readyz.ts +0 -20
- package/src/resources/v1/connections/connections.ts +0 -1905
- package/src/resources/v1/connections/databases.ts +0 -42
- package/src/resources/v1/connections/index.ts +0 -33
- package/src/resources/v1/connections/views.ts +0 -112
- package/src/resources/v1/connections/yaml.ts +0 -81
- package/src/resources/v1/github/github.ts +0 -165
- package/src/resources/v1/github/index.ts +0 -20
- package/src/resources/v1/github/repos.ts +0 -85
- package/src/resources/v1/github/scaffold.ts +0 -44
- package/src/resources/v1/github/webhooks.ts +0 -60
- package/src/resources/v1/github.ts +0 -3
- package/src/resources/v1/groups/groups.ts +0 -218
- package/src/resources/v1/groups/index.ts +0 -10
- package/src/resources/v1/groups/tenants.ts +0 -78
- package/src/resources/v1/groups.ts +0 -3
- package/src/resources/v1/me.ts +0 -62
- package/src/resources/v1/org/client.ts +0 -81
- package/src/resources/v1/org/index.ts +0 -11
- package/src/resources/v1/org/org.ts +0 -32
- package/src/resources/v1/org/users.ts +0 -127
- package/src/resources/v1/org.ts +0 -3
- package/src/resources/v1/tenants/batch.ts +0 -200
- package/src/resources/v1/tenants/groups.ts +0 -52
- package/src/resources/v1/tenants/import.ts +0 -158
- package/src/resources/v1/tenants/index.ts +0 -29
- package/src/resources/v1/tenants/tenants.ts +0 -344
|
@@ -1,1470 +0,0 @@
|
|
|
1
|
-
import { APIResource } from "../../../core/resource.js";
|
|
2
|
-
import * as DatabasesAPI from "./databases.js";
|
|
3
|
-
import { DatabaseDeleteSchemaParams, Databases } from "./databases.js";
|
|
4
|
-
import * as ViewsAPI from "./views.js";
|
|
5
|
-
import { ViewListParams, ViewListResponse, ViewRetrieveParams, ViewRetrieveResponse, Views } from "./views.js";
|
|
6
|
-
import * as YamlAPI from "./yaml.js";
|
|
7
|
-
import { Yaml, YamlCommitParams, YamlCommitResponse, YamlRetrieveResponse } from "./yaml.js";
|
|
8
|
-
import { APIPromise } from "../../../core/api-promise.js";
|
|
9
|
-
import { RequestOptions } from "../../../internal/request-options.js";
|
|
10
|
-
export declare class Connections extends APIResource {
|
|
11
|
-
databases: DatabasesAPI.Databases;
|
|
12
|
-
views: ViewsAPI.Views;
|
|
13
|
-
yaml: YamlAPI.Yaml;
|
|
14
|
-
/**
|
|
15
|
-
* Create a new warehouse connection with PR approval flow.
|
|
16
|
-
*/
|
|
17
|
-
create(body: ConnectionCreateParams, options?: RequestOptions): APIPromise<Connection>;
|
|
18
|
-
/**
|
|
19
|
-
* Get a single warehouse connection by ID.
|
|
20
|
-
*
|
|
21
|
-
* Returns connection from the database (source of truth) with full hierarchy. For
|
|
22
|
-
* YAML output compatible with repository files (using kater_id), use the GET
|
|
23
|
-
* /connections/{id}/schema endpoint instead.
|
|
24
|
-
*
|
|
25
|
-
* RLS: Filtered to current client (DualClientRLSDB).
|
|
26
|
-
*
|
|
27
|
-
* Raises: NotFoundError: If connection doesn't exist (404)
|
|
28
|
-
*/
|
|
29
|
-
retrieve(connectionID: string, options?: RequestOptions): APIPromise<Connection>;
|
|
30
|
-
/**
|
|
31
|
-
* Update a warehouse connection's metadata.
|
|
32
|
-
*
|
|
33
|
-
* Updates name, label, and/or description fields.
|
|
34
|
-
*
|
|
35
|
-
* RLS: Filtered to current client (ClientRLSDB).
|
|
36
|
-
*
|
|
37
|
-
* Raises: ConnectionNotFoundError: If connection doesn't exist (404)
|
|
38
|
-
*/
|
|
39
|
-
update(connectionID: string, body: ConnectionUpdateParams, options?: RequestOptions): APIPromise<Connection>;
|
|
40
|
-
/**
|
|
41
|
-
* List warehouse connections for the client.
|
|
42
|
-
*
|
|
43
|
-
* Filter connections by approval status using the `status` query parameter:
|
|
44
|
-
*
|
|
45
|
-
* - `approved` (default): Only approved connections (is_pending_approval=false)
|
|
46
|
-
* - `pending`: Only connections awaiting PR approval (is_pending_approval=true)
|
|
47
|
-
* - `all`: All connections regardless of approval status
|
|
48
|
-
*
|
|
49
|
-
* Pending connections include their approval PR URLs when available. Returns empty
|
|
50
|
-
* list if GitHub is not configured.
|
|
51
|
-
*
|
|
52
|
-
* RLS: Filtered to current client (DualClientRLSDB).
|
|
53
|
-
*/
|
|
54
|
-
list(query?: ConnectionListParams | null | undefined, options?: RequestOptions): APIPromise<ConnectionListResponse>;
|
|
55
|
-
/**
|
|
56
|
-
* Delete a warehouse connection.
|
|
57
|
-
*
|
|
58
|
-
* Soft-deletes the connection record and cascades to all associated databases and
|
|
59
|
-
* schemas, setting deleted_at and deleted_by fields.
|
|
60
|
-
*
|
|
61
|
-
* RLS: Filtered to current client (ClientRLSDB).
|
|
62
|
-
*
|
|
63
|
-
* Raises: ConnectionNotFoundError: If connection doesn't exist (404)
|
|
64
|
-
*/
|
|
65
|
-
delete(connectionID: string, options?: RequestOptions): APIPromise<void>;
|
|
66
|
-
/**
|
|
67
|
-
* Merge the PR for a pending connection to finalize it.
|
|
68
|
-
*/
|
|
69
|
-
approve(connectionID: string, options?: RequestOptions): APIPromise<Connection>;
|
|
70
|
-
/**
|
|
71
|
-
* Merge the PR for a completed schema sync.
|
|
72
|
-
*/
|
|
73
|
-
approveSync(syncID: string, params: ConnectionApproveSyncParams, options?: RequestOptions): APIPromise<ConnectionApproveSyncResponse>;
|
|
74
|
-
/**
|
|
75
|
-
* List all schema sync records for a connection.
|
|
76
|
-
*/
|
|
77
|
-
listSyncs(connectionID: string, query?: ConnectionListSyncsParams | null | undefined, options?: RequestOptions): APIPromise<ConnectionListSyncsResponse>;
|
|
78
|
-
/**
|
|
79
|
-
* Get decrypted warehouse credentials for a connection.
|
|
80
|
-
*
|
|
81
|
-
* Returns the decrypted credentials for a connection. This is sensitive data and
|
|
82
|
-
* should only be used when actually needed for warehouse operations.
|
|
83
|
-
*
|
|
84
|
-
* RLS: Filtered to current client (DualClientRLSDB).
|
|
85
|
-
*
|
|
86
|
-
* Raises: NotFoundError: If connection doesn't exist (404)
|
|
87
|
-
*/
|
|
88
|
-
retrieveCredential(connectionID: string, options?: RequestOptions): APIPromise<ConnectionRetrieveCredentialResponse>;
|
|
89
|
-
/**
|
|
90
|
-
* Get connection as a ConnectionSchema object.
|
|
91
|
-
*
|
|
92
|
-
* Returns the connection in the YAML-compatible schema format with full
|
|
93
|
-
* database/schema hierarchy.
|
|
94
|
-
*
|
|
95
|
-
* RLS: Automatically filtered by client_id from auth context.
|
|
96
|
-
*
|
|
97
|
-
* Raises: ConnectionNotFoundError: If connection not found or deleted.
|
|
98
|
-
*/
|
|
99
|
-
retrieveSchema(connectionID: string, options?: RequestOptions): APIPromise<ConnectionRetrieveSchemaResponse>;
|
|
100
|
-
/**
|
|
101
|
-
* Get the current status of a schema sync workflow.
|
|
102
|
-
*/
|
|
103
|
-
retrieveSyncStatus(syncID: string, params: ConnectionRetrieveSyncStatusParams, options?: RequestOptions): APIPromise<ConnectionRetrieveSyncStatusResponse>;
|
|
104
|
-
/**
|
|
105
|
-
* Server-Sent Events stream for real-time sync progress updates.
|
|
106
|
-
*/
|
|
107
|
-
streamSyncProgress(syncID: string, params: ConnectionStreamSyncProgressParams, options?: RequestOptions): APIPromise<unknown>;
|
|
108
|
-
/**
|
|
109
|
-
* Start a schema sync workflow. Returns 202 Accepted with sync_id.
|
|
110
|
-
*/
|
|
111
|
-
sync(connectionID: string, options?: RequestOptions): APIPromise<ConnectionSyncResponse>;
|
|
112
|
-
/**
|
|
113
|
-
* Test and update warehouse credentials without modifying connection config.
|
|
114
|
-
*/
|
|
115
|
-
updateCredentials(connectionID: string, body: ConnectionUpdateCredentialsParams, options?: RequestOptions): APIPromise<ConnectionUpdateCredentialsResponse>;
|
|
116
|
-
}
|
|
117
|
-
/**
|
|
118
|
-
* Response model for a single connection.
|
|
119
|
-
*
|
|
120
|
-
* All data comes from the database (source of truth). For YAML-compatible output
|
|
121
|
-
* with 'kater_id', use the /schema endpoint instead.
|
|
122
|
-
*/
|
|
123
|
-
export interface Connection {
|
|
124
|
-
/**
|
|
125
|
-
* Connection ID
|
|
126
|
-
*/
|
|
127
|
-
id: string;
|
|
128
|
-
/**
|
|
129
|
-
* Creation timestamp
|
|
130
|
-
*/
|
|
131
|
-
created_at: string;
|
|
132
|
-
/**
|
|
133
|
-
* Credential ID
|
|
134
|
-
*/
|
|
135
|
-
credential_id: string;
|
|
136
|
-
/**
|
|
137
|
-
* Databases in this connection
|
|
138
|
-
*/
|
|
139
|
-
databases: Array<Connection.Database>;
|
|
140
|
-
/**
|
|
141
|
-
* Connection name
|
|
142
|
-
*/
|
|
143
|
-
name: string;
|
|
144
|
-
/**
|
|
145
|
-
* Last update timestamp
|
|
146
|
-
*/
|
|
147
|
-
updated_at: string;
|
|
148
|
-
/**
|
|
149
|
-
* Warehouse-specific configuration
|
|
150
|
-
*/
|
|
151
|
-
warehouse_metadata: Connection.SnowflakeMetadata | Connection.PostgresqlMetadata | Connection.DatabricksMetadata | Connection.ClickhouseMetadata | Connection.MssqlMetadata;
|
|
152
|
-
/**
|
|
153
|
-
* Warehouse type (snowflake, postgresql, etc.)
|
|
154
|
-
*/
|
|
155
|
-
warehouse_type: string;
|
|
156
|
-
/**
|
|
157
|
-
* GitHub PR URL for approving the connection (None if already approved)
|
|
158
|
-
*/
|
|
159
|
-
approval_pr_url?: string | null;
|
|
160
|
-
/**
|
|
161
|
-
* Connection description
|
|
162
|
-
*/
|
|
163
|
-
description?: string | null;
|
|
164
|
-
/**
|
|
165
|
-
* True if this connection is awaiting PR approval
|
|
166
|
-
*/
|
|
167
|
-
is_pending_approval?: boolean;
|
|
168
|
-
/**
|
|
169
|
-
* Human-readable label
|
|
170
|
-
*/
|
|
171
|
-
label?: string | null;
|
|
172
|
-
/**
|
|
173
|
-
* Query timeout in seconds
|
|
174
|
-
*/
|
|
175
|
-
query_timeout?: number | null;
|
|
176
|
-
/**
|
|
177
|
-
* Timezone conversion mode (do_not_convert, convert_to_utc)
|
|
178
|
-
*/
|
|
179
|
-
query_timezone_conversion?: string | null;
|
|
180
|
-
}
|
|
181
|
-
export declare namespace Connection {
|
|
182
|
-
/**
|
|
183
|
-
* Database info from ConnectionSchema.
|
|
184
|
-
*/
|
|
185
|
-
interface Database {
|
|
186
|
-
/**
|
|
187
|
-
* Database ID
|
|
188
|
-
*/
|
|
189
|
-
id: string;
|
|
190
|
-
/**
|
|
191
|
-
* Actual name of the database in the warehouse
|
|
192
|
-
*/
|
|
193
|
-
database_object_name: string;
|
|
194
|
-
/**
|
|
195
|
-
* Database name
|
|
196
|
-
*/
|
|
197
|
-
name: string;
|
|
198
|
-
/**
|
|
199
|
-
* Schemas in this database
|
|
200
|
-
*/
|
|
201
|
-
schemas: Array<Database.Schema>;
|
|
202
|
-
/**
|
|
203
|
-
* Database description
|
|
204
|
-
*/
|
|
205
|
-
description?: string | null;
|
|
206
|
-
/**
|
|
207
|
-
* Human-readable label
|
|
208
|
-
*/
|
|
209
|
-
label?: string | null;
|
|
210
|
-
/**
|
|
211
|
-
* Timezone for the database
|
|
212
|
-
*/
|
|
213
|
-
timezone?: string | null;
|
|
214
|
-
}
|
|
215
|
-
namespace Database {
|
|
216
|
-
/**
|
|
217
|
-
* Schema info from ConnectionSchema.
|
|
218
|
-
*/
|
|
219
|
-
interface Schema {
|
|
220
|
-
/**
|
|
221
|
-
* Schema ID
|
|
222
|
-
*/
|
|
223
|
-
id: string;
|
|
224
|
-
/**
|
|
225
|
-
* Actual name of the schema in the warehouse
|
|
226
|
-
*/
|
|
227
|
-
database_object_name: string;
|
|
228
|
-
/**
|
|
229
|
-
* Schema name
|
|
230
|
-
*/
|
|
231
|
-
name: string;
|
|
232
|
-
/**
|
|
233
|
-
* Schema description
|
|
234
|
-
*/
|
|
235
|
-
description?: string | null;
|
|
236
|
-
/**
|
|
237
|
-
* Human-readable label
|
|
238
|
-
*/
|
|
239
|
-
label?: string | null;
|
|
240
|
-
}
|
|
241
|
-
}
|
|
242
|
-
interface SnowflakeMetadata {
|
|
243
|
-
/**
|
|
244
|
-
* Authentication method
|
|
245
|
-
*/
|
|
246
|
-
auth_method: 'username_password' | 'key_pair';
|
|
247
|
-
/**
|
|
248
|
-
* Snowflake role
|
|
249
|
-
*/
|
|
250
|
-
role: string;
|
|
251
|
-
/**
|
|
252
|
-
* Snowflake account identifier
|
|
253
|
-
*/
|
|
254
|
-
snowflake_account_id: string;
|
|
255
|
-
/**
|
|
256
|
-
* Snowflake compute warehouse name
|
|
257
|
-
*/
|
|
258
|
-
warehouse: string;
|
|
259
|
-
warehouse_type: 'snowflake';
|
|
260
|
-
}
|
|
261
|
-
interface PostgresqlMetadata {
|
|
262
|
-
/**
|
|
263
|
-
* Database host address
|
|
264
|
-
*/
|
|
265
|
-
host: string;
|
|
266
|
-
/**
|
|
267
|
-
* Database port (default: 5432)
|
|
268
|
-
*/
|
|
269
|
-
port: number;
|
|
270
|
-
warehouse_type: 'postgresql';
|
|
271
|
-
}
|
|
272
|
-
interface DatabricksMetadata {
|
|
273
|
-
/**
|
|
274
|
-
* Databricks SQL warehouse HTTP path
|
|
275
|
-
*/
|
|
276
|
-
http_path: string;
|
|
277
|
-
/**
|
|
278
|
-
* Databricks server hostname
|
|
279
|
-
*/
|
|
280
|
-
server_hostname: string;
|
|
281
|
-
warehouse_type: 'databricks';
|
|
282
|
-
}
|
|
283
|
-
interface ClickhouseMetadata {
|
|
284
|
-
/**
|
|
285
|
-
* ClickHouse host address
|
|
286
|
-
*/
|
|
287
|
-
host: string;
|
|
288
|
-
/**
|
|
289
|
-
* ClickHouse port (default: 8443)
|
|
290
|
-
*/
|
|
291
|
-
port: number;
|
|
292
|
-
warehouse_type: 'clickhouse';
|
|
293
|
-
}
|
|
294
|
-
interface MssqlMetadata {
|
|
295
|
-
/**
|
|
296
|
-
* SQL Server host address
|
|
297
|
-
*/
|
|
298
|
-
host: string;
|
|
299
|
-
/**
|
|
300
|
-
* SQL Server port (default: 1433)
|
|
301
|
-
*/
|
|
302
|
-
port: number;
|
|
303
|
-
warehouse_type: 'mssql';
|
|
304
|
-
}
|
|
305
|
-
}
|
|
306
|
-
/**
|
|
307
|
-
* Database configuration for connection creation request.
|
|
308
|
-
*/
|
|
309
|
-
export interface DatabaseConfig {
|
|
310
|
-
/**
|
|
311
|
-
* Database name (also used as the warehouse object name)
|
|
312
|
-
*/
|
|
313
|
-
name: string;
|
|
314
|
-
/**
|
|
315
|
-
* Description of the database
|
|
316
|
-
*/
|
|
317
|
-
description?: string | null;
|
|
318
|
-
/**
|
|
319
|
-
* Human-readable label for the database (defaults to name if not set)
|
|
320
|
-
*/
|
|
321
|
-
label?: string | null;
|
|
322
|
-
/**
|
|
323
|
-
* Schema configurations to include (empty = discover all schemas)
|
|
324
|
-
*/
|
|
325
|
-
schemas?: Array<DatabaseConfig.Schema>;
|
|
326
|
-
/**
|
|
327
|
-
* Timezone for the database (e.g., 'UTC', 'America/New_York')
|
|
328
|
-
*/
|
|
329
|
-
timezone?: string | null;
|
|
330
|
-
}
|
|
331
|
-
export declare namespace DatabaseConfig {
|
|
332
|
-
/**
|
|
333
|
-
* Schema configuration for connection creation request.
|
|
334
|
-
*/
|
|
335
|
-
interface Schema {
|
|
336
|
-
/**
|
|
337
|
-
* Schema name (also used as the warehouse object name)
|
|
338
|
-
*/
|
|
339
|
-
name: string;
|
|
340
|
-
/**
|
|
341
|
-
* Description of the schema
|
|
342
|
-
*/
|
|
343
|
-
description?: string | null;
|
|
344
|
-
/**
|
|
345
|
-
* Human-readable label for the schema (defaults to name if not set)
|
|
346
|
-
*/
|
|
347
|
-
label?: string | null;
|
|
348
|
-
}
|
|
349
|
-
}
|
|
350
|
-
export type ConnectionListResponse = Array<Connection>;
|
|
351
|
-
/**
|
|
352
|
-
* Response for sync status endpoint.
|
|
353
|
-
*
|
|
354
|
-
* Contains full sync state including progress and results.
|
|
355
|
-
*/
|
|
356
|
-
export interface ConnectionApproveSyncResponse {
|
|
357
|
-
/**
|
|
358
|
-
* Connection ID
|
|
359
|
-
*/
|
|
360
|
-
connection_id: string;
|
|
361
|
-
/**
|
|
362
|
-
* Sync creation timestamp
|
|
363
|
-
*/
|
|
364
|
-
created_at: string;
|
|
365
|
-
/**
|
|
366
|
-
* Workflow status: queued, running, succeeded, failed, canceled
|
|
367
|
-
*/
|
|
368
|
-
run_status: string;
|
|
369
|
-
/**
|
|
370
|
-
* Schema sync record ID
|
|
371
|
-
*/
|
|
372
|
-
sync_id: string;
|
|
373
|
-
/**
|
|
374
|
-
* Workflow completion timestamp
|
|
375
|
-
*/
|
|
376
|
-
completed_at?: string | null;
|
|
377
|
-
/**
|
|
378
|
-
* Current workflow step
|
|
379
|
-
*/
|
|
380
|
-
current_step?: string | null;
|
|
381
|
-
/**
|
|
382
|
-
* Error message if failed
|
|
383
|
-
*/
|
|
384
|
-
error_message?: string | null;
|
|
385
|
-
/**
|
|
386
|
-
* Sync event history
|
|
387
|
-
*/
|
|
388
|
-
events?: Array<ConnectionApproveSyncResponse.Event>;
|
|
389
|
-
/**
|
|
390
|
-
* Hatchet workflow run ID
|
|
391
|
-
*/
|
|
392
|
-
hatchet_run_id?: string | null;
|
|
393
|
-
/**
|
|
394
|
-
* GitHub PR number
|
|
395
|
-
*/
|
|
396
|
-
pr_number?: number | null;
|
|
397
|
-
/**
|
|
398
|
-
* PR status: open, merged, closed
|
|
399
|
-
*/
|
|
400
|
-
pr_status?: string | null;
|
|
401
|
-
/**
|
|
402
|
-
* GitHub PR URL
|
|
403
|
-
*/
|
|
404
|
-
pr_url?: string | null;
|
|
405
|
-
/**
|
|
406
|
-
* Workflow start timestamp
|
|
407
|
-
*/
|
|
408
|
-
started_at?: string | null;
|
|
409
|
-
/**
|
|
410
|
-
* Number of views deleted
|
|
411
|
-
*/
|
|
412
|
-
views_deleted?: number | null;
|
|
413
|
-
/**
|
|
414
|
-
* Number of new views added
|
|
415
|
-
*/
|
|
416
|
-
views_inserted?: number | null;
|
|
417
|
-
/**
|
|
418
|
-
* Number of views renamed (subset of updated)
|
|
419
|
-
*/
|
|
420
|
-
views_renamed?: number | null;
|
|
421
|
-
/**
|
|
422
|
-
* Number of views updated (dimension changes or renames)
|
|
423
|
-
*/
|
|
424
|
-
views_updated?: number | null;
|
|
425
|
-
}
|
|
426
|
-
export declare namespace ConnectionApproveSyncResponse {
|
|
427
|
-
/**
|
|
428
|
-
* Response model for a single sync event.
|
|
429
|
-
*/
|
|
430
|
-
interface Event {
|
|
431
|
-
/**
|
|
432
|
-
* Event ID
|
|
433
|
-
*/
|
|
434
|
-
id: string;
|
|
435
|
-
/**
|
|
436
|
-
* Event timestamp
|
|
437
|
-
*/
|
|
438
|
-
created_at: string;
|
|
439
|
-
/**
|
|
440
|
-
* Event type: step_started, step_completed, progress, warning, error
|
|
441
|
-
*/
|
|
442
|
-
event_type: string;
|
|
443
|
-
/**
|
|
444
|
-
* Human-readable event message
|
|
445
|
-
*/
|
|
446
|
-
message: string;
|
|
447
|
-
/**
|
|
448
|
-
* Additional event data
|
|
449
|
-
*/
|
|
450
|
-
metadata?: {
|
|
451
|
-
[key: string]: unknown;
|
|
452
|
-
};
|
|
453
|
-
/**
|
|
454
|
-
* Step name if applicable
|
|
455
|
-
*/
|
|
456
|
-
step_name?: string | null;
|
|
457
|
-
}
|
|
458
|
-
}
|
|
459
|
-
export type ConnectionListSyncsResponse = Array<ConnectionListSyncsResponse.ConnectionListSyncsResponseItem>;
|
|
460
|
-
export declare namespace ConnectionListSyncsResponse {
|
|
461
|
-
/**
|
|
462
|
-
* Response for sync status endpoint.
|
|
463
|
-
*
|
|
464
|
-
* Contains full sync state including progress and results.
|
|
465
|
-
*/
|
|
466
|
-
interface ConnectionListSyncsResponseItem {
|
|
467
|
-
/**
|
|
468
|
-
* Connection ID
|
|
469
|
-
*/
|
|
470
|
-
connection_id: string;
|
|
471
|
-
/**
|
|
472
|
-
* Sync creation timestamp
|
|
473
|
-
*/
|
|
474
|
-
created_at: string;
|
|
475
|
-
/**
|
|
476
|
-
* Workflow status: queued, running, succeeded, failed, canceled
|
|
477
|
-
*/
|
|
478
|
-
run_status: string;
|
|
479
|
-
/**
|
|
480
|
-
* Schema sync record ID
|
|
481
|
-
*/
|
|
482
|
-
sync_id: string;
|
|
483
|
-
/**
|
|
484
|
-
* Workflow completion timestamp
|
|
485
|
-
*/
|
|
486
|
-
completed_at?: string | null;
|
|
487
|
-
/**
|
|
488
|
-
* Current workflow step
|
|
489
|
-
*/
|
|
490
|
-
current_step?: string | null;
|
|
491
|
-
/**
|
|
492
|
-
* Error message if failed
|
|
493
|
-
*/
|
|
494
|
-
error_message?: string | null;
|
|
495
|
-
/**
|
|
496
|
-
* Sync event history
|
|
497
|
-
*/
|
|
498
|
-
events?: Array<ConnectionListSyncsResponseItem.Event>;
|
|
499
|
-
/**
|
|
500
|
-
* Hatchet workflow run ID
|
|
501
|
-
*/
|
|
502
|
-
hatchet_run_id?: string | null;
|
|
503
|
-
/**
|
|
504
|
-
* GitHub PR number
|
|
505
|
-
*/
|
|
506
|
-
pr_number?: number | null;
|
|
507
|
-
/**
|
|
508
|
-
* PR status: open, merged, closed
|
|
509
|
-
*/
|
|
510
|
-
pr_status?: string | null;
|
|
511
|
-
/**
|
|
512
|
-
* GitHub PR URL
|
|
513
|
-
*/
|
|
514
|
-
pr_url?: string | null;
|
|
515
|
-
/**
|
|
516
|
-
* Workflow start timestamp
|
|
517
|
-
*/
|
|
518
|
-
started_at?: string | null;
|
|
519
|
-
/**
|
|
520
|
-
* Number of views deleted
|
|
521
|
-
*/
|
|
522
|
-
views_deleted?: number | null;
|
|
523
|
-
/**
|
|
524
|
-
* Number of new views added
|
|
525
|
-
*/
|
|
526
|
-
views_inserted?: number | null;
|
|
527
|
-
/**
|
|
528
|
-
* Number of views renamed (subset of updated)
|
|
529
|
-
*/
|
|
530
|
-
views_renamed?: number | null;
|
|
531
|
-
/**
|
|
532
|
-
* Number of views updated (dimension changes or renames)
|
|
533
|
-
*/
|
|
534
|
-
views_updated?: number | null;
|
|
535
|
-
}
|
|
536
|
-
namespace ConnectionListSyncsResponseItem {
|
|
537
|
-
/**
|
|
538
|
-
* Response model for a single sync event.
|
|
539
|
-
*/
|
|
540
|
-
interface Event {
|
|
541
|
-
/**
|
|
542
|
-
* Event ID
|
|
543
|
-
*/
|
|
544
|
-
id: string;
|
|
545
|
-
/**
|
|
546
|
-
* Event timestamp
|
|
547
|
-
*/
|
|
548
|
-
created_at: string;
|
|
549
|
-
/**
|
|
550
|
-
* Event type: step_started, step_completed, progress, warning, error
|
|
551
|
-
*/
|
|
552
|
-
event_type: string;
|
|
553
|
-
/**
|
|
554
|
-
* Human-readable event message
|
|
555
|
-
*/
|
|
556
|
-
message: string;
|
|
557
|
-
/**
|
|
558
|
-
* Additional event data
|
|
559
|
-
*/
|
|
560
|
-
metadata?: {
|
|
561
|
-
[key: string]: unknown;
|
|
562
|
-
};
|
|
563
|
-
/**
|
|
564
|
-
* Step name if applicable
|
|
565
|
-
*/
|
|
566
|
-
step_name?: string | null;
|
|
567
|
-
}
|
|
568
|
-
}
|
|
569
|
-
}
|
|
570
|
-
/**
|
|
571
|
-
* PostgreSQL credential response.
|
|
572
|
-
*/
|
|
573
|
-
export type ConnectionRetrieveCredentialResponse = ConnectionRetrieveCredentialResponse.PostgresCredentialResponse | ConnectionRetrieveCredentialResponse.SnowflakeCredentialResponse | ConnectionRetrieveCredentialResponse.DatabricksCredentialResponse | ConnectionRetrieveCredentialResponse.ClickHouseCredentialResponse | ConnectionRetrieveCredentialResponse.MssqlCredentialResponse;
|
|
574
|
-
export declare namespace ConnectionRetrieveCredentialResponse {
|
|
575
|
-
/**
|
|
576
|
-
* PostgreSQL credential response.
|
|
577
|
-
*/
|
|
578
|
-
interface PostgresCredentialResponse {
|
|
579
|
-
/**
|
|
580
|
-
* Database name
|
|
581
|
-
*/
|
|
582
|
-
database: string;
|
|
583
|
-
/**
|
|
584
|
-
* Database host
|
|
585
|
-
*/
|
|
586
|
-
host: string;
|
|
587
|
-
/**
|
|
588
|
-
* Decrypted password
|
|
589
|
-
*/
|
|
590
|
-
password: string;
|
|
591
|
-
/**
|
|
592
|
-
* Database port
|
|
593
|
-
*/
|
|
594
|
-
port: number;
|
|
595
|
-
/**
|
|
596
|
-
* Database username
|
|
597
|
-
*/
|
|
598
|
-
username: string;
|
|
599
|
-
/**
|
|
600
|
-
* Warehouse type
|
|
601
|
-
*/
|
|
602
|
-
warehouse_type: 'postgresql';
|
|
603
|
-
}
|
|
604
|
-
/**
|
|
605
|
-
* Snowflake credential response.
|
|
606
|
-
*/
|
|
607
|
-
interface SnowflakeCredentialResponse {
|
|
608
|
-
/**
|
|
609
|
-
* Snowflake account identifier
|
|
610
|
-
*/
|
|
611
|
-
account: string;
|
|
612
|
-
/**
|
|
613
|
-
* Authentication credentials
|
|
614
|
-
*/
|
|
615
|
-
auth: SnowflakeCredentialResponse.SnowflakePasswordAuthResponse | SnowflakeCredentialResponse.SnowflakePrivateKeyAuthResponse;
|
|
616
|
-
/**
|
|
617
|
-
* Snowflake role
|
|
618
|
-
*/
|
|
619
|
-
role: string;
|
|
620
|
-
/**
|
|
621
|
-
* Snowflake username
|
|
622
|
-
*/
|
|
623
|
-
username: string;
|
|
624
|
-
/**
|
|
625
|
-
* Compute warehouse name
|
|
626
|
-
*/
|
|
627
|
-
warehouse: string;
|
|
628
|
-
/**
|
|
629
|
-
* Warehouse type
|
|
630
|
-
*/
|
|
631
|
-
warehouse_type: 'snowflake';
|
|
632
|
-
}
|
|
633
|
-
namespace SnowflakeCredentialResponse {
|
|
634
|
-
/**
|
|
635
|
-
* Snowflake password authentication response.
|
|
636
|
-
*/
|
|
637
|
-
interface SnowflakePasswordAuthResponse {
|
|
638
|
-
/**
|
|
639
|
-
* Authentication type
|
|
640
|
-
*/
|
|
641
|
-
auth_type: 'password';
|
|
642
|
-
/**
|
|
643
|
-
* Decrypted password
|
|
644
|
-
*/
|
|
645
|
-
password: string;
|
|
646
|
-
}
|
|
647
|
-
/**
|
|
648
|
-
* Snowflake private key authentication response.
|
|
649
|
-
*/
|
|
650
|
-
interface SnowflakePrivateKeyAuthResponse {
|
|
651
|
-
/**
|
|
652
|
-
* Authentication type
|
|
653
|
-
*/
|
|
654
|
-
auth_type: 'private_key';
|
|
655
|
-
/**
|
|
656
|
-
* PEM-encoded private key
|
|
657
|
-
*/
|
|
658
|
-
private_key: string;
|
|
659
|
-
/**
|
|
660
|
-
* Passphrase if key is encrypted
|
|
661
|
-
*/
|
|
662
|
-
private_key_passphrase?: string | null;
|
|
663
|
-
}
|
|
664
|
-
}
|
|
665
|
-
/**
|
|
666
|
-
* Databricks credential response.
|
|
667
|
-
*/
|
|
668
|
-
interface DatabricksCredentialResponse {
|
|
669
|
-
/**
|
|
670
|
-
* Databricks personal access token
|
|
671
|
-
*/
|
|
672
|
-
access_token: string;
|
|
673
|
-
/**
|
|
674
|
-
* SQL warehouse HTTP path
|
|
675
|
-
*/
|
|
676
|
-
http_path: string;
|
|
677
|
-
/**
|
|
678
|
-
* Databricks server hostname
|
|
679
|
-
*/
|
|
680
|
-
server_hostname: string;
|
|
681
|
-
/**
|
|
682
|
-
* Warehouse type
|
|
683
|
-
*/
|
|
684
|
-
warehouse_type: 'databricks';
|
|
685
|
-
}
|
|
686
|
-
/**
|
|
687
|
-
* ClickHouse credential response.
|
|
688
|
-
*/
|
|
689
|
-
interface ClickHouseCredentialResponse {
|
|
690
|
-
/**
|
|
691
|
-
* ClickHouse host
|
|
692
|
-
*/
|
|
693
|
-
host: string;
|
|
694
|
-
/**
|
|
695
|
-
* Decrypted password
|
|
696
|
-
*/
|
|
697
|
-
password: string;
|
|
698
|
-
/**
|
|
699
|
-
* ClickHouse port
|
|
700
|
-
*/
|
|
701
|
-
port: number;
|
|
702
|
-
/**
|
|
703
|
-
* ClickHouse username
|
|
704
|
-
*/
|
|
705
|
-
username: string;
|
|
706
|
-
/**
|
|
707
|
-
* Warehouse type
|
|
708
|
-
*/
|
|
709
|
-
warehouse_type: 'clickhouse';
|
|
710
|
-
/**
|
|
711
|
-
* Database name
|
|
712
|
-
*/
|
|
713
|
-
database?: string | null;
|
|
714
|
-
}
|
|
715
|
-
/**
|
|
716
|
-
* Microsoft SQL Server credential response.
|
|
717
|
-
*/
|
|
718
|
-
interface MssqlCredentialResponse {
|
|
719
|
-
/**
|
|
720
|
-
* SQL Server host
|
|
721
|
-
*/
|
|
722
|
-
host: string;
|
|
723
|
-
/**
|
|
724
|
-
* Decrypted password
|
|
725
|
-
*/
|
|
726
|
-
password: string;
|
|
727
|
-
/**
|
|
728
|
-
* SQL Server port
|
|
729
|
-
*/
|
|
730
|
-
port: number;
|
|
731
|
-
/**
|
|
732
|
-
* SQL Server username
|
|
733
|
-
*/
|
|
734
|
-
username: string;
|
|
735
|
-
/**
|
|
736
|
-
* Warehouse type
|
|
737
|
-
*/
|
|
738
|
-
warehouse_type: 'mssql';
|
|
739
|
-
/**
|
|
740
|
-
* Database name
|
|
741
|
-
*/
|
|
742
|
-
database?: string | null;
|
|
743
|
-
}
|
|
744
|
-
}
|
|
745
|
-
/**
|
|
746
|
-
* Schema for Kater connection configuration files
|
|
747
|
-
*/
|
|
748
|
-
export interface ConnectionRetrieveSchemaResponse {
|
|
749
|
-
/**
|
|
750
|
-
* Unique identifier for the connection
|
|
751
|
-
*/
|
|
752
|
-
kater_id: string;
|
|
753
|
-
/**
|
|
754
|
-
* Name of the connection
|
|
755
|
-
*/
|
|
756
|
-
name: string;
|
|
757
|
-
/**
|
|
758
|
-
* Warehouse-specific configuration (non-sensitive)
|
|
759
|
-
*/
|
|
760
|
-
warehouse_metadata: ConnectionRetrieveSchemaResponse.SnowflakeMetadata | ConnectionRetrieveSchemaResponse.PostgresqlMetadata | ConnectionRetrieveSchemaResponse.DatabricksMetadata | ConnectionRetrieveSchemaResponse.ClickhouseMetadata | ConnectionRetrieveSchemaResponse.MssqlMetadata;
|
|
761
|
-
/**
|
|
762
|
-
* Additional context for AI processing
|
|
763
|
-
*/
|
|
764
|
-
ai_context?: string | null;
|
|
765
|
-
/**
|
|
766
|
-
* Custom properties
|
|
767
|
-
*/
|
|
768
|
-
custom_properties?: {
|
|
769
|
-
[key: string]: unknown;
|
|
770
|
-
} | null;
|
|
771
|
-
/**
|
|
772
|
-
* List of databases in this connection
|
|
773
|
-
*/
|
|
774
|
-
databases?: Array<ConnectionRetrieveSchemaResponse.Database> | null;
|
|
775
|
-
/**
|
|
776
|
-
* Description of the connection
|
|
777
|
-
*/
|
|
778
|
-
description?: string | null;
|
|
779
|
-
/**
|
|
780
|
-
* Human-readable label for the connection
|
|
781
|
-
*/
|
|
782
|
-
label?: string | null;
|
|
783
|
-
/**
|
|
784
|
-
* Query timeout in seconds
|
|
785
|
-
*/
|
|
786
|
-
query_timeout?: number;
|
|
787
|
-
/**
|
|
788
|
-
* Timezone conversion mode for queries
|
|
789
|
-
*/
|
|
790
|
-
query_timezone_conversion?: 'do_not_convert' | 'convert_to_utc';
|
|
791
|
-
}
|
|
792
|
-
export declare namespace ConnectionRetrieveSchemaResponse {
|
|
793
|
-
interface SnowflakeMetadata {
|
|
794
|
-
/**
|
|
795
|
-
* Authentication method
|
|
796
|
-
*/
|
|
797
|
-
auth_method: 'username_password' | 'key_pair';
|
|
798
|
-
/**
|
|
799
|
-
* Snowflake role
|
|
800
|
-
*/
|
|
801
|
-
role: string;
|
|
802
|
-
/**
|
|
803
|
-
* Snowflake account identifier
|
|
804
|
-
*/
|
|
805
|
-
snowflake_account_id: string;
|
|
806
|
-
/**
|
|
807
|
-
* Snowflake compute warehouse name
|
|
808
|
-
*/
|
|
809
|
-
warehouse: string;
|
|
810
|
-
warehouse_type: 'snowflake';
|
|
811
|
-
}
|
|
812
|
-
interface PostgresqlMetadata {
|
|
813
|
-
/**
|
|
814
|
-
* Database host address
|
|
815
|
-
*/
|
|
816
|
-
host: string;
|
|
817
|
-
/**
|
|
818
|
-
* Database port (default: 5432)
|
|
819
|
-
*/
|
|
820
|
-
port: number;
|
|
821
|
-
warehouse_type: 'postgresql';
|
|
822
|
-
}
|
|
823
|
-
interface DatabricksMetadata {
|
|
824
|
-
/**
|
|
825
|
-
* Databricks SQL warehouse HTTP path
|
|
826
|
-
*/
|
|
827
|
-
http_path: string;
|
|
828
|
-
/**
|
|
829
|
-
* Databricks server hostname
|
|
830
|
-
*/
|
|
831
|
-
server_hostname: string;
|
|
832
|
-
warehouse_type: 'databricks';
|
|
833
|
-
}
|
|
834
|
-
interface ClickhouseMetadata {
|
|
835
|
-
/**
|
|
836
|
-
* ClickHouse host address
|
|
837
|
-
*/
|
|
838
|
-
host: string;
|
|
839
|
-
/**
|
|
840
|
-
* ClickHouse port (default: 8443)
|
|
841
|
-
*/
|
|
842
|
-
port: number;
|
|
843
|
-
warehouse_type: 'clickhouse';
|
|
844
|
-
}
|
|
845
|
-
interface MssqlMetadata {
|
|
846
|
-
/**
|
|
847
|
-
* SQL Server host address
|
|
848
|
-
*/
|
|
849
|
-
host: string;
|
|
850
|
-
/**
|
|
851
|
-
* SQL Server port (default: 1433)
|
|
852
|
-
*/
|
|
853
|
-
port: number;
|
|
854
|
-
warehouse_type: 'mssql';
|
|
855
|
-
}
|
|
856
|
-
interface Database {
|
|
857
|
-
/**
|
|
858
|
-
* The actual name of the database object in the warehouse
|
|
859
|
-
*/
|
|
860
|
-
database_object_name: string;
|
|
861
|
-
/**
|
|
862
|
-
* Unique identifier for the database
|
|
863
|
-
*/
|
|
864
|
-
kater_id: string;
|
|
865
|
-
/**
|
|
866
|
-
* Name of the database
|
|
867
|
-
*/
|
|
868
|
-
name: string;
|
|
869
|
-
/**
|
|
870
|
-
* Additional context for AI processing
|
|
871
|
-
*/
|
|
872
|
-
ai_context?: string | null;
|
|
873
|
-
/**
|
|
874
|
-
* Custom properties
|
|
875
|
-
*/
|
|
876
|
-
custom_properties?: {
|
|
877
|
-
[key: string]: unknown;
|
|
878
|
-
} | null;
|
|
879
|
-
/**
|
|
880
|
-
* Description of the database
|
|
881
|
-
*/
|
|
882
|
-
description?: string | null;
|
|
883
|
-
/**
|
|
884
|
-
* Human-readable label for the database
|
|
885
|
-
*/
|
|
886
|
-
label?: string | null;
|
|
887
|
-
/**
|
|
888
|
-
* List of schemas in this database
|
|
889
|
-
*/
|
|
890
|
-
schemas?: Array<Database.Schema> | null;
|
|
891
|
-
/**
|
|
892
|
-
* Timezone for the database
|
|
893
|
-
*/
|
|
894
|
-
timezone?: string | null;
|
|
895
|
-
}
|
|
896
|
-
namespace Database {
|
|
897
|
-
interface Schema {
|
|
898
|
-
/**
|
|
899
|
-
* The actual name of the schema object in the warehouse
|
|
900
|
-
*/
|
|
901
|
-
database_object_name: string;
|
|
902
|
-
/**
|
|
903
|
-
* Unique identifier for the schema
|
|
904
|
-
*/
|
|
905
|
-
kater_id: string;
|
|
906
|
-
/**
|
|
907
|
-
* Name of the schema
|
|
908
|
-
*/
|
|
909
|
-
name: string;
|
|
910
|
-
/**
|
|
911
|
-
* Additional context for AI processing
|
|
912
|
-
*/
|
|
913
|
-
ai_context?: string | null;
|
|
914
|
-
/**
|
|
915
|
-
* Custom properties
|
|
916
|
-
*/
|
|
917
|
-
custom_properties?: {
|
|
918
|
-
[key: string]: unknown;
|
|
919
|
-
} | null;
|
|
920
|
-
/**
|
|
921
|
-
* Description of the schema
|
|
922
|
-
*/
|
|
923
|
-
description?: string | null;
|
|
924
|
-
/**
|
|
925
|
-
* Human-readable label for the schema
|
|
926
|
-
*/
|
|
927
|
-
label?: string | null;
|
|
928
|
-
}
|
|
929
|
-
}
|
|
930
|
-
}
|
|
931
|
-
/**
|
|
932
|
-
* Response for sync status endpoint.
|
|
933
|
-
*
|
|
934
|
-
* Contains full sync state including progress and results.
|
|
935
|
-
*/
|
|
936
|
-
export interface ConnectionRetrieveSyncStatusResponse {
|
|
937
|
-
/**
|
|
938
|
-
* Connection ID
|
|
939
|
-
*/
|
|
940
|
-
connection_id: string;
|
|
941
|
-
/**
|
|
942
|
-
* Sync creation timestamp
|
|
943
|
-
*/
|
|
944
|
-
created_at: string;
|
|
945
|
-
/**
|
|
946
|
-
* Workflow status: queued, running, succeeded, failed, canceled
|
|
947
|
-
*/
|
|
948
|
-
run_status: string;
|
|
949
|
-
/**
|
|
950
|
-
* Schema sync record ID
|
|
951
|
-
*/
|
|
952
|
-
sync_id: string;
|
|
953
|
-
/**
|
|
954
|
-
* Workflow completion timestamp
|
|
955
|
-
*/
|
|
956
|
-
completed_at?: string | null;
|
|
957
|
-
/**
|
|
958
|
-
* Current workflow step
|
|
959
|
-
*/
|
|
960
|
-
current_step?: string | null;
|
|
961
|
-
/**
|
|
962
|
-
* Error message if failed
|
|
963
|
-
*/
|
|
964
|
-
error_message?: string | null;
|
|
965
|
-
/**
|
|
966
|
-
* Sync event history
|
|
967
|
-
*/
|
|
968
|
-
events?: Array<ConnectionRetrieveSyncStatusResponse.Event>;
|
|
969
|
-
/**
|
|
970
|
-
* Hatchet workflow run ID
|
|
971
|
-
*/
|
|
972
|
-
hatchet_run_id?: string | null;
|
|
973
|
-
/**
|
|
974
|
-
* GitHub PR number
|
|
975
|
-
*/
|
|
976
|
-
pr_number?: number | null;
|
|
977
|
-
/**
|
|
978
|
-
* PR status: open, merged, closed
|
|
979
|
-
*/
|
|
980
|
-
pr_status?: string | null;
|
|
981
|
-
/**
|
|
982
|
-
* GitHub PR URL
|
|
983
|
-
*/
|
|
984
|
-
pr_url?: string | null;
|
|
985
|
-
/**
|
|
986
|
-
* Workflow start timestamp
|
|
987
|
-
*/
|
|
988
|
-
started_at?: string | null;
|
|
989
|
-
/**
|
|
990
|
-
* Number of views deleted
|
|
991
|
-
*/
|
|
992
|
-
views_deleted?: number | null;
|
|
993
|
-
/**
|
|
994
|
-
* Number of new views added
|
|
995
|
-
*/
|
|
996
|
-
views_inserted?: number | null;
|
|
997
|
-
/**
|
|
998
|
-
* Number of views renamed (subset of updated)
|
|
999
|
-
*/
|
|
1000
|
-
views_renamed?: number | null;
|
|
1001
|
-
/**
|
|
1002
|
-
* Number of views updated (dimension changes or renames)
|
|
1003
|
-
*/
|
|
1004
|
-
views_updated?: number | null;
|
|
1005
|
-
}
|
|
1006
|
-
export declare namespace ConnectionRetrieveSyncStatusResponse {
|
|
1007
|
-
/**
|
|
1008
|
-
* Response model for a single sync event.
|
|
1009
|
-
*/
|
|
1010
|
-
interface Event {
|
|
1011
|
-
/**
|
|
1012
|
-
* Event ID
|
|
1013
|
-
*/
|
|
1014
|
-
id: string;
|
|
1015
|
-
/**
|
|
1016
|
-
* Event timestamp
|
|
1017
|
-
*/
|
|
1018
|
-
created_at: string;
|
|
1019
|
-
/**
|
|
1020
|
-
* Event type: step_started, step_completed, progress, warning, error
|
|
1021
|
-
*/
|
|
1022
|
-
event_type: string;
|
|
1023
|
-
/**
|
|
1024
|
-
* Human-readable event message
|
|
1025
|
-
*/
|
|
1026
|
-
message: string;
|
|
1027
|
-
/**
|
|
1028
|
-
* Additional event data
|
|
1029
|
-
*/
|
|
1030
|
-
metadata?: {
|
|
1031
|
-
[key: string]: unknown;
|
|
1032
|
-
};
|
|
1033
|
-
/**
|
|
1034
|
-
* Step name if applicable
|
|
1035
|
-
*/
|
|
1036
|
-
step_name?: string | null;
|
|
1037
|
-
}
|
|
1038
|
-
}
|
|
1039
|
-
export type ConnectionStreamSyncProgressResponse = unknown;
|
|
1040
|
-
/**
|
|
1041
|
-
* Response for starting a schema sync.
|
|
1042
|
-
*
|
|
1043
|
-
* Returned with 202 Accepted when sync workflow is successfully queued.
|
|
1044
|
-
*/
|
|
1045
|
-
export interface ConnectionSyncResponse {
|
|
1046
|
-
/**
|
|
1047
|
-
* Schema sync record ID
|
|
1048
|
-
*/
|
|
1049
|
-
sync_id: string;
|
|
1050
|
-
/**
|
|
1051
|
-
* Hatchet workflow run ID
|
|
1052
|
-
*/
|
|
1053
|
-
hatchet_run_id?: string | null;
|
|
1054
|
-
/**
|
|
1055
|
-
* Current sync status
|
|
1056
|
-
*/
|
|
1057
|
-
status?: string;
|
|
1058
|
-
}
|
|
1059
|
-
/**
|
|
1060
|
-
* Response for credential update.
|
|
1061
|
-
*/
|
|
1062
|
-
export interface ConnectionUpdateCredentialsResponse {
|
|
1063
|
-
/**
|
|
1064
|
-
* Connection ID
|
|
1065
|
-
*/
|
|
1066
|
-
connection_id: string;
|
|
1067
|
-
/**
|
|
1068
|
-
* Whether the credential update was successful
|
|
1069
|
-
*/
|
|
1070
|
-
success: boolean;
|
|
1071
|
-
}
|
|
1072
|
-
export type ConnectionCreateParams = ConnectionCreateParams.PostgresConnectionConfig | ConnectionCreateParams.SnowflakeConnectionConfig | ConnectionCreateParams.DatabricksConnectionConfig | ConnectionCreateParams.ClickHouseConnectionConfig | ConnectionCreateParams.MssqlConnectionConfig;
|
|
1073
|
-
export declare namespace ConnectionCreateParams {
|
|
1074
|
-
interface PostgresConnectionConfig {
|
|
1075
|
-
/**
|
|
1076
|
-
* Databases to include in the connection (at least one required)
|
|
1077
|
-
*/
|
|
1078
|
-
databases: Array<DatabaseConfig>;
|
|
1079
|
-
/**
|
|
1080
|
-
* Database host
|
|
1081
|
-
*/
|
|
1082
|
-
host: string;
|
|
1083
|
-
/**
|
|
1084
|
-
* Name of the connection (snake_case: lowercase letters, numbers, underscores)
|
|
1085
|
-
*/
|
|
1086
|
-
name: string;
|
|
1087
|
-
/**
|
|
1088
|
-
* Database password
|
|
1089
|
-
*/
|
|
1090
|
-
password: string;
|
|
1091
|
-
/**
|
|
1092
|
-
* Database username
|
|
1093
|
-
*/
|
|
1094
|
-
username: string;
|
|
1095
|
-
/**
|
|
1096
|
-
* Warehouse type
|
|
1097
|
-
*/
|
|
1098
|
-
warehouse_type: 'postgresql';
|
|
1099
|
-
/**
|
|
1100
|
-
* Description of the connection
|
|
1101
|
-
*/
|
|
1102
|
-
description?: string | null;
|
|
1103
|
-
/**
|
|
1104
|
-
* Human-readable label for the connection (defaults to name if not set)
|
|
1105
|
-
*/
|
|
1106
|
-
label?: string | null;
|
|
1107
|
-
/**
|
|
1108
|
-
* Database port
|
|
1109
|
-
*/
|
|
1110
|
-
port?: number;
|
|
1111
|
-
/**
|
|
1112
|
-
* Query timeout in seconds (1-3600)
|
|
1113
|
-
*/
|
|
1114
|
-
query_timeout?: number | null;
|
|
1115
|
-
/**
|
|
1116
|
-
* Timezone conversion mode: 'do_not_convert' or 'convert_to_utc'
|
|
1117
|
-
*/
|
|
1118
|
-
query_timezone_conversion?: string | null;
|
|
1119
|
-
}
|
|
1120
|
-
interface SnowflakeConnectionConfig {
|
|
1121
|
-
/**
|
|
1122
|
-
* Snowflake account identifier (e.g., 'xy12345.us-east-1')
|
|
1123
|
-
*/
|
|
1124
|
-
account: string;
|
|
1125
|
-
/**
|
|
1126
|
-
* Authentication configuration
|
|
1127
|
-
*/
|
|
1128
|
-
auth: SnowflakeConnectionConfig.SnowflakePasswordAuth | SnowflakeConnectionConfig.SnowflakePrivateKeyAuth;
|
|
1129
|
-
/**
|
|
1130
|
-
* Databases to include in the connection (at least one required)
|
|
1131
|
-
*/
|
|
1132
|
-
databases: Array<DatabaseConfig>;
|
|
1133
|
-
/**
|
|
1134
|
-
* Name of the connection (snake_case: lowercase letters, numbers, underscores)
|
|
1135
|
-
*/
|
|
1136
|
-
name: string;
|
|
1137
|
-
/**
|
|
1138
|
-
* Snowflake role
|
|
1139
|
-
*/
|
|
1140
|
-
role: string;
|
|
1141
|
-
/**
|
|
1142
|
-
* Snowflake username
|
|
1143
|
-
*/
|
|
1144
|
-
username: string;
|
|
1145
|
-
/**
|
|
1146
|
-
* Compute warehouse name
|
|
1147
|
-
*/
|
|
1148
|
-
warehouse: string;
|
|
1149
|
-
/**
|
|
1150
|
-
* Warehouse type
|
|
1151
|
-
*/
|
|
1152
|
-
warehouse_type: 'snowflake';
|
|
1153
|
-
/**
|
|
1154
|
-
* Description of the connection
|
|
1155
|
-
*/
|
|
1156
|
-
description?: string | null;
|
|
1157
|
-
/**
|
|
1158
|
-
* Human-readable label for the connection (defaults to name if not set)
|
|
1159
|
-
*/
|
|
1160
|
-
label?: string | null;
|
|
1161
|
-
/**
|
|
1162
|
-
* Query timeout in seconds (1-3600)
|
|
1163
|
-
*/
|
|
1164
|
-
query_timeout?: number | null;
|
|
1165
|
-
/**
|
|
1166
|
-
* Timezone conversion mode: 'do_not_convert' or 'convert_to_utc'
|
|
1167
|
-
*/
|
|
1168
|
-
query_timezone_conversion?: string | null;
|
|
1169
|
-
}
|
|
1170
|
-
namespace SnowflakeConnectionConfig {
|
|
1171
|
-
/**
|
|
1172
|
-
* Snowflake password authentication.
|
|
1173
|
-
*/
|
|
1174
|
-
interface SnowflakePasswordAuth {
|
|
1175
|
-
/**
|
|
1176
|
-
* Authentication type
|
|
1177
|
-
*/
|
|
1178
|
-
auth_type: 'password';
|
|
1179
|
-
/**
|
|
1180
|
-
* Snowflake password
|
|
1181
|
-
*/
|
|
1182
|
-
password: string;
|
|
1183
|
-
}
|
|
1184
|
-
/**
|
|
1185
|
-
* Snowflake private key authentication.
|
|
1186
|
-
*/
|
|
1187
|
-
interface SnowflakePrivateKeyAuth {
|
|
1188
|
-
/**
|
|
1189
|
-
* Authentication type
|
|
1190
|
-
*/
|
|
1191
|
-
auth_type: 'private_key';
|
|
1192
|
-
/**
|
|
1193
|
-
* PEM-encoded private key
|
|
1194
|
-
*/
|
|
1195
|
-
private_key: string;
|
|
1196
|
-
/**
|
|
1197
|
-
* Passphrase if key is encrypted
|
|
1198
|
-
*/
|
|
1199
|
-
private_key_passphrase?: string | null;
|
|
1200
|
-
}
|
|
1201
|
-
}
|
|
1202
|
-
interface DatabricksConnectionConfig {
|
|
1203
|
-
/**
|
|
1204
|
-
* Databricks personal access token
|
|
1205
|
-
*/
|
|
1206
|
-
access_token: string;
|
|
1207
|
-
/**
|
|
1208
|
-
* Databases to include in the connection (at least one required)
|
|
1209
|
-
*/
|
|
1210
|
-
databases: Array<DatabaseConfig>;
|
|
1211
|
-
/**
|
|
1212
|
-
* SQL warehouse HTTP path (e.g., '/sql/1.0/warehouses/xxx')
|
|
1213
|
-
*/
|
|
1214
|
-
http_path: string;
|
|
1215
|
-
/**
|
|
1216
|
-
* Name of the connection (snake_case: lowercase letters, numbers, underscores)
|
|
1217
|
-
*/
|
|
1218
|
-
name: string;
|
|
1219
|
-
/**
|
|
1220
|
-
* Databricks server hostname (e.g., 'dbc-xxx.cloud.databricks.com')
|
|
1221
|
-
*/
|
|
1222
|
-
server_hostname: string;
|
|
1223
|
-
/**
|
|
1224
|
-
* Warehouse type
|
|
1225
|
-
*/
|
|
1226
|
-
warehouse_type: 'databricks';
|
|
1227
|
-
/**
|
|
1228
|
-
* Description of the connection
|
|
1229
|
-
*/
|
|
1230
|
-
description?: string | null;
|
|
1231
|
-
/**
|
|
1232
|
-
* Human-readable label for the connection (defaults to name if not set)
|
|
1233
|
-
*/
|
|
1234
|
-
label?: string | null;
|
|
1235
|
-
/**
|
|
1236
|
-
* Query timeout in seconds (1-3600)
|
|
1237
|
-
*/
|
|
1238
|
-
query_timeout?: number | null;
|
|
1239
|
-
/**
|
|
1240
|
-
* Timezone conversion mode: 'do_not_convert' or 'convert_to_utc'
|
|
1241
|
-
*/
|
|
1242
|
-
query_timezone_conversion?: string | null;
|
|
1243
|
-
}
|
|
1244
|
-
interface ClickHouseConnectionConfig {
|
|
1245
|
-
/**
|
|
1246
|
-
* Databases to include in the connection (at least one required)
|
|
1247
|
-
*/
|
|
1248
|
-
databases: Array<DatabaseConfig>;
|
|
1249
|
-
/**
|
|
1250
|
-
* ClickHouse host
|
|
1251
|
-
*/
|
|
1252
|
-
host: string;
|
|
1253
|
-
/**
|
|
1254
|
-
* Name of the connection (snake_case: lowercase letters, numbers, underscores)
|
|
1255
|
-
*/
|
|
1256
|
-
name: string;
|
|
1257
|
-
/**
|
|
1258
|
-
* ClickHouse password
|
|
1259
|
-
*/
|
|
1260
|
-
password: string;
|
|
1261
|
-
/**
|
|
1262
|
-
* ClickHouse username
|
|
1263
|
-
*/
|
|
1264
|
-
username: string;
|
|
1265
|
-
/**
|
|
1266
|
-
* Warehouse type
|
|
1267
|
-
*/
|
|
1268
|
-
warehouse_type: 'clickhouse';
|
|
1269
|
-
/**
|
|
1270
|
-
* Description of the connection
|
|
1271
|
-
*/
|
|
1272
|
-
description?: string | null;
|
|
1273
|
-
/**
|
|
1274
|
-
* Human-readable label for the connection (defaults to name if not set)
|
|
1275
|
-
*/
|
|
1276
|
-
label?: string | null;
|
|
1277
|
-
/**
|
|
1278
|
-
* ClickHouse port
|
|
1279
|
-
*/
|
|
1280
|
-
port?: number;
|
|
1281
|
-
/**
|
|
1282
|
-
* Query timeout in seconds (1-3600)
|
|
1283
|
-
*/
|
|
1284
|
-
query_timeout?: number | null;
|
|
1285
|
-
/**
|
|
1286
|
-
* Timezone conversion mode: 'do_not_convert' or 'convert_to_utc'
|
|
1287
|
-
*/
|
|
1288
|
-
query_timezone_conversion?: string | null;
|
|
1289
|
-
}
|
|
1290
|
-
interface MssqlConnectionConfig {
|
|
1291
|
-
/**
|
|
1292
|
-
* Databases to include in the connection (at least one required)
|
|
1293
|
-
*/
|
|
1294
|
-
databases: Array<DatabaseConfig>;
|
|
1295
|
-
/**
|
|
1296
|
-
* SQL Server host
|
|
1297
|
-
*/
|
|
1298
|
-
host: string;
|
|
1299
|
-
/**
|
|
1300
|
-
* Name of the connection (snake_case: lowercase letters, numbers, underscores)
|
|
1301
|
-
*/
|
|
1302
|
-
name: string;
|
|
1303
|
-
/**
|
|
1304
|
-
* SQL Server password
|
|
1305
|
-
*/
|
|
1306
|
-
password: string;
|
|
1307
|
-
/**
|
|
1308
|
-
* SQL Server username
|
|
1309
|
-
*/
|
|
1310
|
-
username: string;
|
|
1311
|
-
/**
|
|
1312
|
-
* Warehouse type
|
|
1313
|
-
*/
|
|
1314
|
-
warehouse_type: 'mssql';
|
|
1315
|
-
/**
|
|
1316
|
-
* Description of the connection
|
|
1317
|
-
*/
|
|
1318
|
-
description?: string | null;
|
|
1319
|
-
/**
|
|
1320
|
-
* Human-readable label for the connection (defaults to name if not set)
|
|
1321
|
-
*/
|
|
1322
|
-
label?: string | null;
|
|
1323
|
-
/**
|
|
1324
|
-
* SQL Server port
|
|
1325
|
-
*/
|
|
1326
|
-
port?: number;
|
|
1327
|
-
/**
|
|
1328
|
-
* Query timeout in seconds (1-3600)
|
|
1329
|
-
*/
|
|
1330
|
-
query_timeout?: number | null;
|
|
1331
|
-
/**
|
|
1332
|
-
* Timezone conversion mode: 'do_not_convert' or 'convert_to_utc'
|
|
1333
|
-
*/
|
|
1334
|
-
query_timezone_conversion?: string | null;
|
|
1335
|
-
}
|
|
1336
|
-
}
|
|
1337
|
-
export interface ConnectionUpdateParams {
|
|
1338
|
-
/**
|
|
1339
|
-
* Connection description
|
|
1340
|
-
*/
|
|
1341
|
-
description?: string | null;
|
|
1342
|
-
/**
|
|
1343
|
-
* Human-readable display label
|
|
1344
|
-
*/
|
|
1345
|
-
label?: string | null;
|
|
1346
|
-
/**
|
|
1347
|
-
* Connection name (snake_case identifier)
|
|
1348
|
-
*/
|
|
1349
|
-
name?: string | null;
|
|
1350
|
-
}
|
|
1351
|
-
export interface ConnectionListParams {
|
|
1352
|
-
status?: 'approved' | 'pending' | 'all';
|
|
1353
|
-
}
|
|
1354
|
-
export interface ConnectionApproveSyncParams {
|
|
1355
|
-
connection_id: string;
|
|
1356
|
-
}
|
|
1357
|
-
export interface ConnectionListSyncsParams {
|
|
1358
|
-
limit?: number;
|
|
1359
|
-
offset?: number;
|
|
1360
|
-
}
|
|
1361
|
-
export interface ConnectionRetrieveSyncStatusParams {
|
|
1362
|
-
connection_id: string;
|
|
1363
|
-
}
|
|
1364
|
-
export interface ConnectionStreamSyncProgressParams {
|
|
1365
|
-
connection_id: string;
|
|
1366
|
-
}
|
|
1367
|
-
export type ConnectionUpdateCredentialsParams = ConnectionUpdateCredentialsParams.PostgreSqlCredentialUpdate | ConnectionUpdateCredentialsParams.SnowflakeCredentialUpdate | ConnectionUpdateCredentialsParams.DatabricksCredentialUpdate | ConnectionUpdateCredentialsParams.ClickHouseCredentialUpdate | ConnectionUpdateCredentialsParams.MssqlCredentialUpdate;
|
|
1368
|
-
export declare namespace ConnectionUpdateCredentialsParams {
|
|
1369
|
-
interface PostgreSqlCredentialUpdate {
|
|
1370
|
-
/**
|
|
1371
|
-
* Database password
|
|
1372
|
-
*/
|
|
1373
|
-
password: string;
|
|
1374
|
-
/**
|
|
1375
|
-
* Database username
|
|
1376
|
-
*/
|
|
1377
|
-
username: string;
|
|
1378
|
-
/**
|
|
1379
|
-
* Warehouse type
|
|
1380
|
-
*/
|
|
1381
|
-
warehouse_type: 'postgresql';
|
|
1382
|
-
}
|
|
1383
|
-
interface SnowflakeCredentialUpdate {
|
|
1384
|
-
/**
|
|
1385
|
-
* Authentication credentials
|
|
1386
|
-
*/
|
|
1387
|
-
auth: SnowflakeCredentialUpdate.SnowflakePasswordCredentialAuth | SnowflakeCredentialUpdate.SnowflakePrivateKeyCredentialAuth;
|
|
1388
|
-
/**
|
|
1389
|
-
* Snowflake username
|
|
1390
|
-
*/
|
|
1391
|
-
username: string;
|
|
1392
|
-
/**
|
|
1393
|
-
* Warehouse type
|
|
1394
|
-
*/
|
|
1395
|
-
warehouse_type: 'snowflake';
|
|
1396
|
-
}
|
|
1397
|
-
namespace SnowflakeCredentialUpdate {
|
|
1398
|
-
/**
|
|
1399
|
-
* Snowflake password auth for credential update.
|
|
1400
|
-
*/
|
|
1401
|
-
interface SnowflakePasswordCredentialAuth {
|
|
1402
|
-
/**
|
|
1403
|
-
* Authentication type
|
|
1404
|
-
*/
|
|
1405
|
-
auth_type: 'password';
|
|
1406
|
-
/**
|
|
1407
|
-
* Snowflake password
|
|
1408
|
-
*/
|
|
1409
|
-
password: string;
|
|
1410
|
-
}
|
|
1411
|
-
/**
|
|
1412
|
-
* Snowflake private key auth for credential update.
|
|
1413
|
-
*/
|
|
1414
|
-
interface SnowflakePrivateKeyCredentialAuth {
|
|
1415
|
-
/**
|
|
1416
|
-
* Authentication type
|
|
1417
|
-
*/
|
|
1418
|
-
auth_type: 'private_key';
|
|
1419
|
-
/**
|
|
1420
|
-
* PEM-encoded private key
|
|
1421
|
-
*/
|
|
1422
|
-
private_key: string;
|
|
1423
|
-
}
|
|
1424
|
-
}
|
|
1425
|
-
interface DatabricksCredentialUpdate {
|
|
1426
|
-
/**
|
|
1427
|
-
* Databricks personal access token
|
|
1428
|
-
*/
|
|
1429
|
-
access_token: string;
|
|
1430
|
-
/**
|
|
1431
|
-
* Warehouse type
|
|
1432
|
-
*/
|
|
1433
|
-
warehouse_type: 'databricks';
|
|
1434
|
-
}
|
|
1435
|
-
interface ClickHouseCredentialUpdate {
|
|
1436
|
-
/**
|
|
1437
|
-
* ClickHouse password
|
|
1438
|
-
*/
|
|
1439
|
-
password: string;
|
|
1440
|
-
/**
|
|
1441
|
-
* ClickHouse username
|
|
1442
|
-
*/
|
|
1443
|
-
username: string;
|
|
1444
|
-
/**
|
|
1445
|
-
* Warehouse type
|
|
1446
|
-
*/
|
|
1447
|
-
warehouse_type: 'clickhouse';
|
|
1448
|
-
}
|
|
1449
|
-
interface MssqlCredentialUpdate {
|
|
1450
|
-
/**
|
|
1451
|
-
* SQL Server password
|
|
1452
|
-
*/
|
|
1453
|
-
password: string;
|
|
1454
|
-
/**
|
|
1455
|
-
* SQL Server username
|
|
1456
|
-
*/
|
|
1457
|
-
username: string;
|
|
1458
|
-
/**
|
|
1459
|
-
* Warehouse type
|
|
1460
|
-
*/
|
|
1461
|
-
warehouse_type: 'mssql';
|
|
1462
|
-
}
|
|
1463
|
-
}
|
|
1464
|
-
export declare namespace Connections {
|
|
1465
|
-
export { type Connection as Connection, type DatabaseConfig as DatabaseConfig, type ConnectionListResponse as ConnectionListResponse, type ConnectionApproveSyncResponse as ConnectionApproveSyncResponse, type ConnectionListSyncsResponse as ConnectionListSyncsResponse, type ConnectionRetrieveCredentialResponse as ConnectionRetrieveCredentialResponse, type ConnectionRetrieveSchemaResponse as ConnectionRetrieveSchemaResponse, type ConnectionRetrieveSyncStatusResponse as ConnectionRetrieveSyncStatusResponse, type ConnectionStreamSyncProgressResponse as ConnectionStreamSyncProgressResponse, type ConnectionSyncResponse as ConnectionSyncResponse, type ConnectionUpdateCredentialsResponse as ConnectionUpdateCredentialsResponse, type ConnectionCreateParams as ConnectionCreateParams, type ConnectionUpdateParams as ConnectionUpdateParams, type ConnectionListParams as ConnectionListParams, type ConnectionApproveSyncParams as ConnectionApproveSyncParams, type ConnectionListSyncsParams as ConnectionListSyncsParams, type ConnectionRetrieveSyncStatusParams as ConnectionRetrieveSyncStatusParams, type ConnectionStreamSyncProgressParams as ConnectionStreamSyncProgressParams, type ConnectionUpdateCredentialsParams as ConnectionUpdateCredentialsParams, };
|
|
1466
|
-
export { Databases as Databases, type DatabaseDeleteSchemaParams as DatabaseDeleteSchemaParams };
|
|
1467
|
-
export { Views as Views, type ViewRetrieveResponse as ViewRetrieveResponse, type ViewListResponse as ViewListResponse, type ViewRetrieveParams as ViewRetrieveParams, type ViewListParams as ViewListParams, };
|
|
1468
|
-
export { Yaml as Yaml, type YamlRetrieveResponse as YamlRetrieveResponse, type YamlCommitResponse as YamlCommitResponse, type YamlCommitParams as YamlCommitParams, };
|
|
1469
|
-
}
|
|
1470
|
-
//# sourceMappingURL=connections.d.ts.map
|