API リファレンス: Data Manager

Warning

このページでは、ForePaaS レガシープラットフォームについて説明しています。このプラットフォームは新規登録を受け付けていません。OVHcloud Data Platform を使用している場合は、Lakehouse Managerを参照してください。

ForePaaS API を通じて Data Manager とやり取りする際には、異なる目的で異なるエンドポイントパターンを使用する必要があります。

以下に、これらのパターンのリファレンスを示します。

ソースを作成する

エンドポイントパターン:

POST /datastores/db?token=xxxxx:

Dropbox ソースの JSON ボディの例:

{     
"dbms": "dropbox",     
"parameters":  { 
  "path": "/folder/path",         
  "token": "xxxxxxxxxx"     
},     
"database_name": "dropbox_source",     
"dwhName": "your_dwh_name",     
"level_name": "source 
}

ソースにテーブルを追加する

エンドポイントパターン:

POST /metas/tables?dwh_name=your_dwh_name&token=xxxxx

Dropbox ソースにテーブルを追加する JSON ボディの例:

{ 
  "table_name": "your_file.csv",     
  "database_name": "dropbox_source" 
} ```

 
You can also add several tables in one shot: 
```json
[{ 
   table_name": "file1.csv",       
  "database_name": "dropbox_source" 
 },
 {  
  "table_name": "file2.csv",       
  "database_name": "dropbox_source" 
}]

メタの抽出

エンドポイントパターン:

PUT /metas/sources/extract/source_name/table/table_name?dwhName=dwh_name&token=xxxxxxx

Dropbox ソースから file1.csv ファイルのメタを抽出する必要がある場合は、/metas/sources/extract/dropbox_source/file1.csv を検索する必要があります。

この呼び出しでは、以下のような設定を受け付けます:

sample: データサンプルからメタを抽出する場合は、これを「true」に設定します。
sample_max_lines: サンプルが「true」に設定されている場合は、サンプルに必要な最大行数を設定するために使用します。
flashzone: ファイル / テーブルデータの概要を DataPlant に表示するには、このオプションを「true」に設定します。

仮想属性を追加する

エンドポイントパターン:

POST /attributes/<your_dwh_name>?token=xxxxxxx

JSON ボディの例:

{
        "attribute_name": "my_attribute",   
	"parameters": {},   
	"is_dimension": false,   
	"is_virtual": true,   
	"is_summable": true,   
	"sql": "SELECT COUNT(id) FROM clients.csv",   
	"is_measure": true 
}

テーブルスキーマを保存する

エンドポイントパターン:

POST /logical/object?dwhName=dwh_name&token=xxxxxx

JSON ボディの例:

[  
   {  
      "attributes":[  
         {  
            "attribute_name":"conso_id",
            "is_dimension":true,
            "sources":[  
               {  
                  "rules":[  

                  ],
                  "attributes":[  
                     "dropbox/consomations.csv/conso_id"
                  ]
               }
            ],
            "is_summable":false,
            "attribute_path":null,
            "fpui":{  
               "operation":"mapping"
            },
            "type":{  
               "main":"num",
               "sub":"smallint"
            },
            "is_measure":false
         },
         {  
            "attribute_name":"ca",
            "database_name":"data_prim",
            "is_dimension":false,
            "sources":[  
               {  
                  "rules":[  

                  ],
                  "attributes":[  
                     "dropbox /consomations.csv/ca"
                  ]
               }
            ],
            "is_summable":false,
            "table_name":"consomations",
            "fpui":{  
               "operation":"mapping"
            },
            "type":{  
               "max":999.99,
               "main":"num",
               "precision":2,
               "min":0.02
            },
            "attribute_path":null,
            "is_measure":true
         }
      ],
      "object_name":"consomations",
      "display_name":"consomations",
      "object_type":"measure",
      "to_materialize":true,
      "measure_date_field":"date",
      "key":[  
         "conso_id"
      ],
      "date_type":false,
      "relations":[  

      ],
      "indexes":[  

      ]
   }
]

テーブルを構築する

以下に、テーブルを構築するために実行する必要があるエンドポイントを示します。

Data Prim の論理構造を構築する:

PUT /logical/build/prim?dwhName=dwh_name&token=xxxxxx

Data Mart の論理構造を構築する:

PUT /logical/build/prim?dwhName=dwh_name&token=xxxxxx

物理構造を構築する:

PUT /datastores/db/physical?token=xxxxx

JSON ボディの例:

{
   "levelsToBuild": "["data_prim"]",   
   "dwhName": "plw1uzhy_jm224kp5" 
}

API リファレンス: Data Manager#

#ソースを作成する

#ソースにテーブルを追加する

#メタの抽出

#仮想属性を追加する

#テーブルスキーマを保存する

#テーブルを構築する

API リファレンス: Data Manager

ソースを作成する

ソースにテーブルを追加する

メタの抽出

仮想属性を追加する

テーブルスキーマを保存する

テーブルを構築する