データマート定義詳細取得
    • PDF

    データマート定義詳細取得

    • PDF

    Article summary

    Get
    /api/datamart_definitions/{datamart_definition_id}

    データマート定義の詳細を取得します。

    Security
    API Key
    Header parameter nameAuthorization

    認証キーとなるAPI KEYをAuthorization: Token {{API KEY}}の形式でヘッダーにセットします。
    API KEYがabc123の場合は、Authorization: Token abc123とします。
    API KEYの作成方法は、trocco APIについてを参照ください。

    Path parameters
    datamart_definition_id
    integer (int64) Required

    データマート定義IDを指定します。
    TROCCO画面からIDを確認する場合は、各種IDの確認方法を参照ください。

    Responses
    200

    データマート定義詳細を返します。

    object
    id
    integer (int64)

    データマート定義IDです。

    Example1
    name
    string

    データマート定義名です。

    Exampletest
    description
    string

    メモです。

    Exampledesc
    data_warehouse_type
    string

    データウェアハウスタイプです。

    Examplebigquery
    is_runnable_concurrently
    boolean

    ジョブの並列実行可否です。

    ExampleTrue
    resource_group
    id
    integer (int64)

    リソースグループIDです。

    Example1
    name
    string

    リソースグループ名です。

    Exampleresource group
    description
    string

    メモです。

    Exampledescription
    created_at
    string

    リソースグループの作成日時です。

    Example2023-08-23T03:00:00.000+09:00
    updated_at
    string

    リソースグループの更新日時です。

    Example2023-08-23T03:00:00.000+09:00
    custom_variable_settings
    Array of object

    カスタム変数一覧です。

    object
    name
    string

    カスタム変数の変数名を指定します。
    変数名を$で囲ってください。

    Example$start_time$
    type
    string

    カスタム変数タイプです。
    string: 文字列
    timestamp: 時刻・日付(キューイング時)
    timestamp_runtime: 時刻・日付(実行時)

    Valid values[ "\"string\"", "\"timestamp\"", "\"timestamp_runtime\"" ]
    Exampletimestamp_runtime
    value
    string

    カスタム変数名を展開する値を指定します。
    カスタム変数タイプがstringのときのみ有効です。

    Examplejobs
    quantity
    integer (int64)

    unit 時間の数を指定します。
    カスタム変数タイプがtimestampかtimestamp_runtime のときのみ有効です。

    Example1
    unit
    string

    時間の単位を指定します。
    タイプがtimestampかtimestamp_runtime のときのみ有効です。

    Valid values[ "\"hour\"", "\"date\"", "\"month\"" ]
    Examplehour
    direction
    string

    時間軸の方向です。
    ago: 前
    later: 後
    タイプがtimestampかtimestamp_runtime のときのみ有効です。

    Valid values[ "\"ago\"", "\"later\"" ]
    Exampleago
    format
    string

    日付フォーマットです。
    タイプがtimestampかtimestamp_runtime のときのみ有効です。

    Example%Y-%m-%d %H:%M:%S
    time_zone
    string

    日付フォーマットの日時を解釈するタイムゾーンです。
    タイプがtimestampかtimestamp_runtime のときのみ有効です。

    ExampleEtc/UTC
    datamart_bigquery_option

    BigQueryの設定です。
    データウェアハウスタイプがBigQueryの場合にのみ、この値は返されます。

    bigquery_connection_id
    integer (int64)

    BigQueryの接続IDです。

    query_mode
    string

    クエリ実行モードです。
    insert: データ転送モード
    query: 自由記述モード

    Valid values[ "\"insert\"", "\"query\"" ]
    query
    string

    実行クエリです。

    Exampleselect * from tests
    destination_dataset
    string

    出力先データセットです。
    query_modeがinsertの場合のみ有効です。

    destination_table
    string

    出力先テーブルです。
    query_modeがinsertの場合のみ有効です。

    write_disposition
    string

    書き込みモードです。
    query_modeがinsertの場合のみ有効。
    append: 追記
    truncate: 全件洗い替え

    Valid values[ "\"append\"", "\"truncate\"" ]
    before_load
    string

    転送前に実行するクエリです。
    query_modeがinsertの場合のみ有効です。

    ExampleDELETE FROM tests
    partitioning
    string

    パーティションタイプです。
    query_modeがinsertの場合のみ有効です。
    ingestion_time: 取り込み時間により分割
    time_unit_column: フィールドにより分割

    Valid values[ "\"ingestion_time\"", "\"time_unit_column\"" ]
    partitioning_time
    string

    分割する期間の単位です。
    query_modeがinsertの場合のみ有効です。

    Valid values[ "\"DAY\"", "\"HOUR\"", "\"MONTH\"", "\"YEAR\"" ]
    partitioning_field
    string

    分割するフィールド名です。
    query_modeがinsertの場合のみ有効です。

    clustering_fields
    Array of string

    クラスタ化列です。
    query_modeがinsertの場合のみ有効です。

    Min items0
    Max items4
    string
    location
    string

    データ処理ローケーションです。
    query_modeがqueryの場合のみ有効です。

    datamart_snowflake_setting

    Snowflakeの設定です。
    データウェアハウスタイプがSnowflakeの場合にのみ、この値は返されます。

    snowflake_connection_id
    integer (int64)

    Snowflakeの接続IDです。

    query_mode
    string

    クエリ実行モードです。
    insert: データ転送モード
    query: 自由記述モード

    Valid values[ "\"insert\"", "\"query\"" ]
    query
    string

    実行クエリです。

    Exampleselect * from tests
    warehouse
    string

    実行対象の仮想ウェアハウスです。

    ExampleEXAMPLE_WH
    destination_database
    string

    出力先データベースです。
    query_modeがinsertの場合のみ有効です。

    destination_schema
    string

    出力先スキーマです。
    query_modeがinsertの場合のみ有効です。

    destination_table
    string

    出力先テーブルです。
    query_modeがinsertの場合のみ有効です。

    write_disposition
    string

    書き込みモードです。
    query_modeがinsertの場合のみ有効です。
    append: 追記
    replace: 洗い替え
    truncate: 全件洗い替え

    Valid values[ "\"append\"", "\"replace\"", "\"truncate\"" ]
    created_at
    string

    データマート定義の作成日時です。タイムゾーンはJST 日本時間(GMT+9)です。

    Example2023-08-23T03:00:00.000+09:00
    updated_at
    string

    データマート定義の更新日時です。タイムゾーンはJST 日本時間(GMT+9)です。

    Example2023-08-23T03:00:00.000+09:00
    400

    Bad request.
    不正なリクエストです。

    401

    Not authenticated.
    認証エラーです。API KEYをご確認ください。


    Was this article helpful?