packages
Creates, updates, deletes, gets or lists a packages resource.
Overview
| Name | packages |
| Type | Resource |
| Id | fivetran.connector_sdk.packages |
Fields
The following fields are returned by SELECT queries:
- get
- list
| Name | Datatype | Description |
|---|---|---|
id | string | The unique identifier for the Connector SDK package. (example: package_id) |
connection_id | string | The connection identifier associated with this package. Each package can only be associated with one connection at a time. Returns null if the package is not yet associated with any connection. (example: connection_id) |
created_at | string (date-time) | The timestamp when the package was created. (example: 2024-01-14T19:30:00Z) |
created_by | string | The unique identifier of the user who created the package. (example: user_id) |
file_sha256_hash | string | The SHA-256 hash of the uploaded package file. Used for integrity verification and change detection. (example: a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2) |
last_updated_by | string | The unique identifier of the user who last updated the package. (example: user_id) |
updated_at | string (date-time) | The timestamp when the package was last updated. (example: 2024-01-14T20:15:00Z) |
| Name | Datatype | Description |
|---|---|---|
id | string | The unique identifier for the Connector SDK package. (example: package_id) |
connection_id | string | The connection identifier associated with this package. Each package can only be associated with one connection at a time. Returns null if the package is not yet associated with any connection. (example: connection_id) |
created_at | string (date-time) | The timestamp when the package was created. (example: 2024-01-14T19:30:00Z) |
created_by | string | The unique identifier of the user who created the package. (example: user_id) |
file_sha256_hash | string | The SHA-256 hash of the uploaded package file. Used for integrity verification and change detection. (example: a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2) |
last_updated_by | string | The unique identifier of the user who last updated the package. (example: user_id) |
updated_at | string (date-time) | The timestamp when the package was last updated. (example: 2024-01-14T20:15:00Z) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | package_id | Returns details for a specific Connector SDK package. | |
list | select | cursor, limit | Returns a list of all Connector SDK packages in your Fivetran account. | |
delete | delete | package_id | Permanently deletes a Connector SDK package from your Fivetran account.<br /><br />> Warning: Packages that are associated with a connection cannot be deleted. You must first delete the connection before deleting the package.<br /> |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
package_id | string | The unique identifier for the Connector SDK package. |
cursor | string | Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination) |
limit | integer (int32) | Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100. |
SELECT examples
- get
- list
Returns details for a specific Connector SDK package.
SELECT
id,
connection_id,
created_at,
created_by,
file_sha256_hash,
last_updated_by,
updated_at
FROM fivetran.connector_sdk.packages
WHERE package_id = '{{ package_id }}' -- required
;
Returns a list of all Connector SDK packages in your Fivetran account.
SELECT
id,
connection_id,
created_at,
created_by,
file_sha256_hash,
last_updated_by,
updated_at
FROM fivetran.connector_sdk.packages
WHERE "limit" = '{{ limit }}'
;
DELETE examples
- delete
Permanently deletes a Connector SDK package from your Fivetran account.<br /><br />> Warning: Packages that are associated with a connection cannot be deleted. You must first delete the connection before deleting the package.<br />
DELETE FROM fivetran.connector_sdk.packages
WHERE package_id = '{{ package_id }}' --required
;