From 44da46a964514a1cce9d794715c1b00316f6121f Mon Sep 17 00:00:00 2001 From: Toru Takahashi Date: Mon, 26 Aug 2024 23:31:37 +0900 Subject: [PATCH] Deprecate td_partial_delete operator --- .../src/operators/td_partial_delete.md | 71 ----------------- .../src/operators/td_partial_delete.rst | 79 +++++++++++++++++++ digdag-docs/src/operators/treasure_data.rst | 2 +- 3 files changed, 80 insertions(+), 72 deletions(-) delete mode 100644 digdag-docs/src/operators/td_partial_delete.md create mode 100644 digdag-docs/src/operators/td_partial_delete.rst diff --git a/digdag-docs/src/operators/td_partial_delete.md b/digdag-docs/src/operators/td_partial_delete.md deleted file mode 100644 index db711385be..0000000000 --- a/digdag-docs/src/operators/td_partial_delete.md +++ /dev/null @@ -1,71 +0,0 @@ -# td_partial_delete>: Delete range of Treasure Data table - -**td_partial_delete>** operator deletes records from a Treasure Data table. - -Please be aware that records imported using streaming import can't be deleted for several hours using td_partial_delete. Records imported by INSERT INTO, Data Connector, and bulk imports can be deleted immediately. - -Time range needs to be hourly. Setting non-zero values to minutes or seconds will be rejected. - - +step1: - td_partial_delete>: my_table - database: mydb - from: 2016-01-01T00:00:00+08:00 - to: 2016-02-01T00:00:00+08:00 - -## Secrets - -When you set those parameters, use [digdag secrets command](https://docs.digdag.io/command_reference.html#secrets). - -* **td.apikey**: API_KEY - The Treasure Data API key to use when running Treasure Data queries. - -## Parameters - -* **td_partial_delete>**: NAME - - Name of the table. - - Examples: - - ``` - td_partial_delete>: my_table - ``` - -* **database**: NAME - - Name of the database. - - Examples: - - ``` - database: my_database - ``` - -* **from**: yyyy-MM-ddTHH:mm:ss[Z] - - Delete records from this time (inclusive). Actual time range is :command:`[from, to)`. Value should be a UNIX timestamp integer (seconds) or string in ISO-8601 (yyyy-MM-ddTHH:mm:ss[Z]) format. - - Examples: - - ``` - from: 2016-01-01T00:00:00+08:00 - ``` - -* **to**: yyyy-MM-ddTHH:mm:ss[Z] - - Delete records to this time (exclusive). Actual time range is :command:`[from, to)`. Value should be a UNIX timestamp integer (seconds) or string in ISO-8601 (yyyy-MM-ddTHH:mm:ss[Z]) format. - - Examples: - - ``` - to: 2016-02-01T00:00:00+08:00 - ``` - -* **endpoint**: ADDRESS - - API endpoint (default: api.treasuredata.com). - -* **use_ssl**: BOOLEAN - - Enable SSL (https) to access to the endpoint (default: true). - diff --git a/digdag-docs/src/operators/td_partial_delete.rst b/digdag-docs/src/operators/td_partial_delete.rst new file mode 100644 index 0000000000..ab61d18e55 --- /dev/null +++ b/digdag-docs/src/operators/td_partial_delete.rst @@ -0,0 +1,79 @@ +td_partial_delete>: Delete range of Treasure Data table +====================================================== + +**td_partial_delete>** operator deletes records from a Treasure Data table. + +.. warning:: + + This operator is deprecated. Use DELETE function in Trino/Presto by td operator instead. + +Please be aware that records imported using streaming import can't be deleted for several hours using td_partial_delete. Records imported by INSERT INTO, Data Connector, and bulk imports can be deleted immediately. + +Time range needs to be hourly. Setting non-zero values to minutes or seconds will be rejected. + +.. code-block:: yaml + + +step1: + td_partial_delete>: my_table + database: mydb + from: 2016-01-01T00:00:00+08:00 + to: 2016-02-01T00:00:00+08:00 + +Secrets +------- + +When you set those parameters, use `digdag secrets command `. + +- **td.apikey**: API_KEY + The Treasure Data API key to use when running Treasure Data queries. + +Parameters +---------- + +- **td_partial_delete>**: NAME + + Name of the table. + + Examples: + + .. code-block:: yaml + + td_partial_delete>: my_table + +- **database**: NAME + + Name of the database. + + Examples: + + .. code-block:: yaml + + database: my_database + +- **from**: yyyy-MM-ddTHH:mm:ss[Z] + + Delete records from this time (inclusive). Actual time range is ``[from, to)``. Value should be a UNIX timestamp integer (seconds) or string in ISO-8601 (yyyy-MM-ddTHH:mm:ss[Z]) format. + + Examples: + + .. code-block:: yaml + + from: 2016-01-01T00:00:00+08:00 + +- **to**: yyyy-MM-ddTHH:mm:ss[Z] + + Delete records to this time (exclusive). Actual time range is ``[from, to)``. Value should be a UNIX timestamp integer (seconds) or string in ISO-8601 (yyyy-MM-ddTHH:mm:ss[Z]) format. + + Examples: + + .. code-block:: yaml + + to: 2016-02-01T00:00:00+08:00 + +- **endpoint**: ADDRESS + + API endpoint (default: api.treasuredata.com) + +- **use_ssl**: BOOLEAN + + Enable SSL (https) to access to the endpoint (default: true) diff --git a/digdag-docs/src/operators/treasure_data.rst b/digdag-docs/src/operators/treasure_data.rst index dd50c470db..c811246aa9 100644 --- a/digdag-docs/src/operators/treasure_data.rst +++ b/digdag-docs/src/operators/treasure_data.rst @@ -11,7 +11,7 @@ Treasure Data operators td_for_each.md td_wait.md td_wait_table.md - td_partial_delete.md + td_partial_delete.rst td_table_export.md td_result_export.md