単一物理テーブルサービスユニットは、ビジネスデータソース内の物理テーブルのメタデータを設定します。このサービスユニットを使用して、テーブル内のデータにアクセスする API を開発できます。
前提条件
サービスユニットグループが作成済みであること。詳細については、「サービスユニットグループの作成」をご参照ください。
データソースタイプが HBase 0.9.4/1.1.x/1.2.1/2.x、Elasticsearch、または MongoDB の場合は、メタデータを作成する必要があります。詳細については、「メタデータの作成」をご参照ください。
制限事項
データソース内の単一の物理テーブルに対してメタデータを設定できます。サポートされているデータソースのリストについては、「Data Service がサポートするデータソース」をご参照ください。
一部のデータソースは行レベルの権限をサポートしています。サポートされているデータソースのリストについては、「Data Service がサポートするデータソース」をご参照ください。
権限
プロジェクト管理者と開発者の両方がサービスユニットを作成できます。
ステップ 1: サービスユニットタイプの選択
Dataphin のホームページで、上部のナビゲーションバーから [サービス] > [API 開発] を選択します。
左上の隅でプロジェクトを選択します。左側のナビゲーションウィンドウで、[サービスユニット] をクリックします。[サービスユニット] ページで、[+ サービスユニットの作成] をクリックします。
[サービスユニットの作成] ダイアログボックスで、[単一物理テーブルサービスユニット] を選択します。
ステップ 2: サービスユニットパラメーターの設定
[サービスユニットの作成] ページで、サービスユニットの基本情報とフィールドを設定します。
基本情報の設定
パラメーター
説明
サービスユニット名
サービスユニットの名前。名前は、次の要件を満たす必要があります。
英字、数字、アンダースコア (_) のみ使用できます。
先頭は英字である必要があります。
長さは 4～64 文字である必要があります。
サービスユニットグループ
既存のサービスユニットグループを選択します。
モード
モードは、サービスユニットが開発データソースからデータを読み取るか、本番データソースからデータを読み取るかを定義するために使用されます。モードには [Basic] と [Dev-Prod] があります。
[Basic]：サービスユニットは本番データソースからのみデータを読み取ることができます。
[Dev-Prod]：サービスユニットは開発データソースと本番データソースの両方からデータを読み取ることができます。
データソースページで、ご利用のデータソースが開発データソースか本番データソースかを確認できます。
物理テーブル
データソースタイプとデータソースで物理テーブルをフィルターできます。また、[データソースの追加] をクリックして、サービスユニットの作成に使用する新しいビジネスデータソースを追加することもできます。サポートされているデータソースのリストについては、「Data Service がサポートするデータソース」をご参照ください。
サービスユニットの説明
サービスユニットの簡単な説明を入力します。説明は最大 128 文字です。
最大返却行数
デフォルトでは、最大返却行数は 1,000 です。この値は最大 10,000 まで増やすことができます。
このパラメーターは、API クエリによって返される行数を制限し、Dataphin が過剰なメモリを使用するのを防ぎます。より多くのデータを取得するには、API を呼び出す際に、SDK の
PageSizeパラメーターを変更できます。類似の基本情報を持つサービスユニットがすでに存在する場合、Dataphin はその名前を表示します。このサービスユニットの詳細は、サービスユニットリストで確認できます。新しいサービスユニットの作成を続行するには、[作成を続行] をクリックして [サービスユニットフィールドの設定] ページに移動します。
サービスユニットフィールドの設定
パラメーター
説明
サービスユニットフィールドタイプ
サポートされているタイプには、
Double、Float、String、Date、Boolean、Int、Long、Short、Byte、BigDecimal、Binaryがあります。ビジネスデータテーブルのフィールドタイプに対応するパラメータータイプを選択します。ビジネスデータテーブルのフィールドタイプがリストにない場合は、
Stringを選択することを推奨します。サービスユニットフィールド
ソーステーブルから特定のフィールドを選択して、サービスユニットフィールドとして使用できます。ソーステーブルに新しいフィールドが追加された場合は、サービスユニットの編集時にそれらを選択できます。
データソースのフィールドをサービスユニットのフィールド名にマッピングします。ビジネスニーズに基づいてフィールド名をカスタマイズできます。名前は、次の要件を満たす必要があります。
英字、数字、アンダースコア (_) のみ使用できます。
先頭は英字である必要があります。
長さは 4～64 文字である必要があります。
サービスユニットを編集する際に、ソーステーブルから削除されたフィールドを削除できます。これにより、このサービスユニットから作成された API がフィールドの欠落により失敗するのを防ぎます。
サービスユニットフィールドの説明
サービスユニットフィールドの簡単な説明を入力します。
フィールドを設定した後、下部にある [データプレビュー] をクリックして、対応するビジネスデータを表示します。最大 1,000 行が返されます。
選択された物理テーブルに基づいて、システムは関連する行レベルの権限情報 (権限名、説明、コントロールフィールド、データソース環境、関連テーブル、関連フィールドなど) を自動的に解析します。また、次の操作を実行することもできます。
行レベルの権限の [有効化] または [無効化]：権限のアクティブ状態とサービスユニット詳細での可視性をコントロールします。
[行レベルの権限の作成]：行レベルの権限を作成する権限が必要です。このボタンをクリックすると、[管理センター] > [権限管理] の行レベルの権限作成ページにリダイレクトされ、そこで 行レベルの権限を作成できます。
説明行レベルの権限機能には、有料のアドオンサービスが必要です。
適用される権限によって、API 呼び出しの結果が異なる場合があります。
モードが [Basic] の場合、本番環境の物理テーブルに対する行レベルの権限が表示されます。モードが [Dev-Prod] の場合、開発環境と本番環境の両方のテーブルに対する権限が表示されます。
公開済みのサービスユニットで行レベルの権限が有効になっている場合、そのユニットから作成された API は対応する権限コントロールの対象となります。
[管理センター] > [権限管理] で公開済みサービスユニットに関連付けられた行レベルの権限を作成または削除した場合、その変更はそのユニットに基づくすべての API に自動的に反映されます。API を再公開する必要はありません。
選択された物理テーブルは、そのフィールドが API で使用されているか、サービスユニットに追加されているかに関わらず、関連付けられた行レベルの権限コントロールの対象となります。
[送信] をクリックして、単一物理テーブルサービスユニットを作成します。
次のステップ
サービスユニット ページで、目的のサービスユニットを見つけ、[アクション] 列の
アイコンをクリックし、[公開] を選択します。 この操作により、サービスユニットが本番環境に公開されます。 その後、このサービスユニットに基づいて API を作成できます。 詳細については、「API の作成」をご参照ください。サービスユニットが作成された後、[サービスユニット] ページで管理できます。利用可能な操作には、編集、公開、削除などがあります。詳細については、「サービスユニットの管理」をご参照ください。