h-imaoka / digdag-operator-athena

digdag plugin for operating a query on athena.

digdag-operator-athena

digdag plugin for operating a query on athena.

Overview

• Plugin type: operator

Usage

_export:
  plugin:
    repositories:
      - https://jitpack.io
    dependencies:
      - pro.civitaspo:digdag-operator-athena:0.4.0
  athena:
    auth_method: profile

+step1:
  athena.query>: template.sql

+step2:
  echo>: ${athena.last_query}

+stap3:
  athena.ctas>: template.sql
  table: hoge
  location: s3://mybucket/prefix/

See examples for more cases.

Configuration

Remarks

• type DurationParam is strings matched \s*(?:(?<days>\d+)\s*d)?\s*(?:(?<hours>\d+)\s*h)?\s*(?:(?<minutes>\d+)\s*m)?\s*(?:(?<seconds>\d+)\s*s)?\s*.
  • The strings is used as java.time.Duration.

Common Configuration

System Options

Define the below options on properties (which is indicated by -c, --config).

• athena.allow_auth_method_env: Indicates whether users can use auth_method "env" (boolean, default: false)
• athena.allow_auth_method_instance: Indicates whether users can use auth_method "instance" (boolean, default: false)
• athena.allow_auth_method_profile: Indicates whether users can use auth_method "profile" (boolean, default: false)
• athena.allow_auth_method_properties: Indicates whether users can use auth_method "properties" (boolean, default: false)
• athena.allow_auth_method_web_identity_token: Indicates whether users can use auth_method "web_identity_token" (boolean, default: false)
• athena.assume_role_timeout_duration: Maximum duration which server administer allows when users assume role_arn. (DurationParam, default: 1h)
• athena.default_web_identity_token_file: Path to a web identity token file. (string, optional)
• athena.default_web_identity_role_arn: AWS Role when using a web identity token. (string, optional)

Secrets

• athena.access_key_id: The AWS Access Key ID to use when submitting Athena queries. (optional)
• athena.secret_access_key: The AWS Secret Access Key to use when submitting Athena queries. (optional)
• athena.session_token: The AWS session token to use when submitting Athena queries. This is used only auth_method is "session" (optional)
• athena.role_arn: The AWS Role to assume when submitting Athena queries. (optional)
• athena.role_session_name: The AWS Role Session Name when assuming the role. (default: digdag-athena-${session_uuid})
• athena.http_proxy.host: proxy host (required if use_http_proxy is true)
• athena.http_proxy.port proxy port (optional)
• athena.http_proxy.scheme "https" or "http" (default: "https")
• athena.http_proxy.user proxy user (optional)
• athena.http_proxy.password: http proxy password (optional)

Options

• auth_method: name of mechanism to authenticate requests ("basic", "env", "instance", "profile", "properties", "anonymous", or "session". default: "basic")
  • "basic": uses access_key_id and secret_access_key to authenticate.
  • "env": uses AWS_ACCESS_KEY_ID (or AWS_ACCESS_KEY) and AWS_SECRET_KEY (or AWS_SECRET_ACCESS_KEY) environment variables.
  • "instance": uses EC2 instance profile.
  • "profile": uses credentials written in a file. Format of the file is as following, where [...] is a name of profile.
    • profile_file: path to a profiles file. (string, default: given by AWS_CREDENTIAL_PROFILES_FILE environment varialbe, or ~/.aws/credentials).
    • profile_name: name of a profile. (string, default: "default")
  • "properties": uses aws.accessKeyId and aws.secretKey Java system properties.
  • "anonymous": uses anonymous access. This auth method can access only public files.
  • "session": uses temporary-generated access_key_id, secret_access_key and session_token.
  • "web_identity_token": uses web identity token.
    • web_identity_token_file: path to a web identity token file. (string, default: given by athena.default_web_identity_token_file)
    • web_identity_role_arn: aws role arn when using a web identity token. (string, default: given by athena.default_web_identity_role_arn)
• use_http_proxy: Indicate whether using when accessing AWS via http proxy. (boolean, default: false)
• region: The AWS region to use for Athena service. (string, optional)
• endpoint: The Amazon Athena endpoint address to use. (string, optional)

Configuration for athena.add_partition> operator

Options

• database: The name of the database. (string, required)
• table: The name of the partitioned table. (string, required)
• location: The location of the partition. If not specified, this operator generates like hive automatically. (string, default: auto generated like the below)
  • ${table location}/${partition key1}=${partition value1}/${partition key2}=${partition value2}/...
• partition_kv: key-value pairs for partitioning (string to string map, required)
• save_mode: The mode to save the partition. (string, default = "overwrite", available values are "skip_if_exists", "error_if_exists", "overwrite")
• follow_location: Skip to add a partition and drop the partition if the location does not exist. (boolean, default: true)
• catalog_id: glue data catalog id if you use a catalog different from account/region default catalog. (string, optional)

Output Parameters

Nothing

Configuration for athena.drop_partition> operator

Options

• database: The name of the database. (string, required)
• table: The name of the partitioned table. (string, required)
• partition_kv: key-value pairs for partitioning (string to string map, required)
• with_location: Drop the partition with removing objects on S3 (boolean, default: false)
• ignore_if_not_exist: Ignore if the partition does not exist. (boolean, default: true)
• catalog_id: glue data catalog id if you use a catalog different from account/region default catalog. (string, optional)

Output Parameters

Nothing

Configuration for athena.partition_exists?> operator

Options

• database: The name of the database. (string, required)
• table: The name of the partitioned table. (string, required)
• partition_kv: key-value pairs for the partition (string to string map, required)
• with_location: Check the partition existence with the location (boolean, default: false)
• error_if_not_exist: Raise the exception if the partition or location does not exist. (boolean, default: false)
• catalog_id: glue data catalog id if you use a catalog different from account/region default catalog. (string, optional)

Output Parameters

• athena.last_partition_exists.partition_exists: true if the partition exists, or false (boolean)
• athena.last_partition_exists.location_exists: true if the partition location exists, or false. null if not set with_location option is true. (boolean)

Configuration for athena.apas> operator

apas means Add a partition as select that creates a partition the query result is stored.

Options

• athena.apas>: The select SQL statements or file location (in local or Amazon S3) to be executed for a new table by Create Table As Select. You can use digdag's template engine like ${...} in the SQL query. (string, required)
• database: The name of the database that has the partitioned table. (string, required)
• table: The name of the partitioned table. (string, required)
• workgroup: The name of the workgroup in which the query is being started. (string, optional)
• partition_kv: key-value pairs for partitioning (string to string map, required)
• location: The location of the partition. If not specified, this operator generates like hive automatically. (string, default: auto generated like the below)
  • ${table location}/${partition key1}=${partition value1}/${partition key2}=${partition value2}/...
• format: The data format for the query results, such as "orc", "parquet", "avro", "json", or "textfile". (string, default: auto detection)
• compression: The compression type to use for "orc" or "parquet". (string, default: auto detection)
• field_delimiter: The field delimiter for files in CSV, TSV, and text files. This option is applied only when format is specific to text-based data storage formats. (string, auto detection)
• save_mode: Specify the expected behavior. Available values are "skip_if_exists", "error_if_exists", "overwrite". See the below explanation of the behaviour. (string, default: "overwrite")
  • "skip_if_exists": Skip processing if the partition or the location exists.
  • "error_if_exists": Raise error if the partition or the location exists.
  • "overwrite": Always recreate the partition and the location if exists. This operation is not atomic.
• bucketed_by: An array list of buckets to bucket data. If omitted, Athena does not bucket your data in this query. (array of string, optional)
• bucket_count: The number of buckets for bucketing your data. If omitted, Athena does not bucket your data. (integer, optional)
• additional_properties: Additional properties for CTAS that is used athena.apas> internally. These are used for CTAS WITH clause without escaping. (string to string map, optional)
• ignore_schema_diff: Ignore if the schema of the query result is different from tha table. (boolean, default: false)
• token_prefix: Prefix for ClientRequestToken that a unique case-sensitive string used to ensure the request to create the query is idempotent (executes only once). On this plugin, the token is composed like ${token_prefix}-${session_uuid}-${hash value of query}-${radom string}. (string, default: "digdag-athena-apas")
• timeout: Specify timeout period. (DurationParam, default: "10m")
• catalog_id: glue data catalog id if you use a catalog different from account/region default catalog. (string, optional)

Output Parameters

Nothing

Configuration for athena.query> operator

Options

• athena.query>: The SQL query statements or file location (in local or Amazon S3) to be executed. You can use digdag's template engine like ${...} in the SQL query. (string, required)
• token_prefix: Prefix for ClientRequestToken that a unique case-sensitive string used to ensure the request to create the query is idempotent (executes only once). On this plugin, the token is composed like ${token_prefix}-${session_uuid}-${hash value of query}-${random string}. (string, default: "digdag-athena")
• database: The name of the database. (string, optional)
• workgroup: The name of the workgroup in which the query is being started. (string, optional)
• timeout: Specify timeout period. (DurationParam, default: "10m")
• preview: Call athena.preview> operator after run athena.query>. (boolean, default: false)

Output Parameters

• athena.last_query.id: The unique identifier for each query execution. (string)
• athena.last_query.database: The name of the database. (string)
• athena.last_query.workgroup: The name of the workgroup in which the query is being started. (string)
• athena.last_query.query: The SQL query statements which the query execution ran. (string)
• athena.last_query.output: The location in Amazon S3 where your query results are stored. (string)
• athena.last_query.scan_bytes: The number of bytes in the data that was queried. (long)
• athena.last_query.exec_millis: The number of milliseconds that the query took to execute. (long)
• athena.last_query.state: The state of query execution. SUBMITTED indicates that the query is queued for execution. RUNNING indicates that the query is scanning data and returning results. SUCCEEDED indicates that the query completed without error. FAILED indicates that the query experienced an error and did not complete processing. CANCELLED indicates that user input interrupted query execution. (string)
• athena.last_query.state_change_reason: Further detail about the status of the query. (string)
• athena.last_query.submitted_at: The unix timestamp that the query was submitted. (integer)
• athena.last_query.completed_at: The unix timestamp that the query completed. (integer)

Configuration for athena.preview> operator

Options

• athena.preview>: The identifier for the query execution that is succeeded. (string, required)
• max_rows: The maximum number of rows to preview. 0 ~ 100 is valid. (integer, default: 10)

Output Parameters

• athena.last_preview.id: The identifier for the query execution. (string)
• athena.last_preview.columns: The information that describes the column structure and data types of a table of query results. (map of array)
  • case_sensitive: Indicates whether values in the column are case-sensitive. (boolean)
  • catalog: The catalog to which the query results belong. (string)
  • label: A column label. (string)
  • name: The name of the column. (string)
  • nullable: Indicates the column's nullable status. (one of NOT_NULL, NULLABLE, UNKNOWN)
  • precision: For DECIMAL data types, specifies the total number of digits, up to 38. For performance reasons, we recommend up to 18 digits. (integer)
  • scale: For DECIMAL data types, specifies the total number of digits in the fractional part of the value. Defaults to 0. (integer)
  • database: The database name to which the query results belong. (string)
  • table: The table name for the query results. (string)
  • type: The data type of the column. (string)
• athena.last_preview.rows: The rows in the preview results. (array of array)

Configuration for athena.ctas> operator

Options

• athena.ctas>: The select SQL statements or file location (in local or Amazon S3) to be executed for a new table by Create Table As Select. You can use digdag's template engine like ${...} in the SQL query. (string, required)
• database: The database name for query execution context. (string, optional)
• table: The table name for the new table (string, default: digdag_athena_ctas_${session_uuid.replaceAll("-", "")}_${random})
• workgroup: The name of the workgroup in which the query is being started. (string, optional)
• location: Output location for data created by CTAS (string, default: "s3://aws-athena-query-results-${AWS_ACCOUNT_ID}-<AWS_REGION>/Unsaved/${YEAR}/${MONTH}/${DAY}/${athena_query_id}/")
• format: The data format for the CTAS query results, such as "orc", "parquet", "avro", "json", or "textfile". (string, default: "parquet")
• compression: The compression type to use for "orc" or "parquet". (string, default: "snappy")
• field_delimiter: The field delimiter for files in CSV, TSV, and text files. This option is applied only when format is specific to text-based data storage formats. (string, optional)
• partitioned_by: An array list of columns by which the CTAS table will be partitioned. Verify that the names of partitioned columns are listed last in the list of columns in the SELECT statement. (array of string, optional)
• bucketed_by: An array list of buckets to bucket data. If omitted, Athena does not bucket your data in this query. (array of string, optional)
• bucket_count: The number of buckets for bucketing your data. If omitted, Athena does not bucket your data. (integer, optional)
• additional_properties: Additional properties for CTAS. These are used for CTAS WITH clause without escaping. (string to string map, optional)
• table_mode: Specify the expected behavior of CTAS results. Available values are "default", "empty", "data_only". See the below explanation of the behaviour. (string, default: "default")
  • "default": Do not do any care. This option require the least IAM privileges for digdag, but the behaviour depends on Athena.
  • "empty": Create a new empty table with the same schema as the select query results.
  • "data_only": Create a new table with data by CTAS, but drop this after CTAS execution. The table created by CTAS is an external table, so the data is left even if the table is dropped.
• save_mode: Specify the expected behavior of CTAS. Available values are "none", "error_if_exists", "ignore", "overwrite". See the below explanation of the behaviour. (string, default: "overwrite")
  • "none": Do not do any care. This option require the least IAM privileges for digdag, but the behaviour depends on Athena.
  • "error_if_exists": Raise error if the distination table or location exists.
  • "ignore": Skip CTAS query if the distination table or location exists.
  • "overwrite": Drop the distination table and remove objects before executing CTAS. This operation is not atomic.
• token_prefix: Prefix for ClientRequestToken that a unique case-sensitive string used to ensure the request to create the query is idempotent (executes only once). On this plugin, the token is composed like ${token_prefix}-${session_uuid}-${hash value of query}-${radom string}. (string, default: "digdag-athena-ctas")
• timeout: Specify timeout period. (DurationParam, default: "10m")

Output Parameters

Nothing

Configuration for athena.drop_table> operator

• database: The name of the database. (string, required)
• table: The name of the table. (string, required)
• with_location: Drop the partition with removing objects on S3 (boolean, default: false)
• ignore_if_not_exist: Ignore if the partition does not exist. (boolean, default: true)
• catalog_id: glue data catalog id if you use a catalog different from account/region default catalog. (string, optional)

Output Parameters

Nothing

Configuration for athena.drop_table_multi> operator

• database: The name of the database. (string, required)
• regexp: The regular expression for table names to be dropped. (string, required)
• with_location: Drop the partition with removing objects on S3 (boolean, default: false)
• limit: Max number of tables that can be dropped. (integer, optional)
• catalog_id: glue data catalog id if you use a catalog different from account/region default catalog. (string, optional)

Output Parameters

Nothing

Configuration for athena.table_exists?> operator

Options

• database: The name of the database. (string, required)
• table: The name of the table. (string, required)
• with_location: Check the partition existence with the location (boolean, default: false)
• error_if_not_exist: Raise the exception if the table or location does not exist. (boolean, default: false)
• catalog_id: glue data catalog id if you use a catalog different from account/region default catalog. (string, optional)

Output Parameters

• athena.last_partition_exists.table_exists: true if the table exists, or false (boolean)
• athena.last_partition_exists.location_exists: true if the table location exists, or false. null if not set with_location option is true. (boolean)

Configuration for athena.each_database> operator

• catalog_id: Glue data catalog id if you use a catalog different from account/region default catalog. (string, optional)
• parallel_slice: The slice number of parallelism execution for _do subtasks. (integer, default: 1)
• _do: The definition of subtasks with exported database information. (config, required)
  • exported parameters are below.
    • athena.each_database.export.name: database name (string)
    • athena.each_database.export.created_at: epoch millis of creation time (integer)
    • athena.each_database.export.description: database description (string)
    • athena.each_database.export.parameters: database parameters that are defined in glue data catalog (conifg)

Development

Run an Example

1) build

./gradlew publish

Artifacts are build on local repos: ./build/repo.

2) get your aws profile

aws configure

3) run an example

./example/run.sh

(TODO) Run Tests

./gradlew test

ChangeLog

CHANGELOG.md

License

Apache License 2.0

Author

@civitaspo

Contributor

• @s-wool
• @daichi-hirose