package_metadata

Creates, updates, deletes, gets or lists a package_metadata resource.

Overview

Name	package_metadata
Type	Resource
Id	fivetran.transformations.package_metadata

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	The unique identifier for the Quickstart transformation package definition within the Fivetran system (example: package_definition_id)
name	string	The Quickstart transformation package name (example: package_definition_name)
configurable_variables	string	The map of configurable variable values keyed by variable name. (opaque JSON object)
connector_types	array	The set of connector types
output_model_names	array	The list of transformation output models
version	string	The Quickstart package definition version (example: version)

list

Name	Datatype	Description
id	string	The unique identifier for the Quickstart transformation package definition within the Fivetran system (example: package_definition_id)
name	string	The Quickstart transformation package name (example: package_definition_name)
configurable_variables	string	The map of configurable variable values keyed by variable name. (opaque JSON object)
connector_types	array	The set of connector types
output_model_names	array	The list of transformation output models
version	string	The Quickstart package definition version (example: version)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	package_definition_id		Returns the metadata details of the Quickstart transformation package if a valid identifier is provided.
list	select		service, name, cursor, limit	Returns a list of available Quickstart transformation package metadata details.

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_definition_id	string	The unique identifier for the Quickstart transformation package definition within the Fivetran system
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.
name	string	Specify the package name to filter Quickstart packages by name
service	string	Specify the service identifier to filter Quickstart packages by connection service

SELECT examples

get

Returns the metadata details of the Quickstart transformation package if a valid identifier is provided.

SELECT
id,
name,
configurable_variables,
connector_types,
output_model_names,
version
FROM fivetran.transformations.package_metadata
WHERE package_definition_id = '{{ package_definition_id }}' -- required
;

list

Returns a list of available Quickstart transformation package metadata details.

SELECT
id,
name,
configurable_variables,
connector_types,
output_model_names,
version
FROM fivetran.transformations.package_metadata
WHERE service = '{{ service }}'
AND name = '{{ name }}'
AND "limit" = '{{ limit }}'
;