単一物理テーブルサービスユニットを使用すると、ビジネスデータソース内の単一物理テーブルのメタデータ構成が可能になります。 このサービスユニットに基づいて、物理テーブルデータにアクセスするための API を開発できます。 このトピックでは、単一物理テーブルサービスユニットを作成する方法について説明します。
前提条件
サービスユニットグループが正常に作成されていること。 詳細については、「サービスプロジェクトグループを作成する」をご参照ください。
データソースタイプが HBase 0.9.4/1.1.x/1.2.1/2.x、ElasticSearch、または MongoDB の場合は、メタデータの作成を完了する必要があります。 詳細については、「メタデータを作成する」をご参照ください。
行レベルの権限機能を購入する必要があります。
制限事項
データソースを介して単一物理テーブルでメタデータ構成を実行できます。 サポートされているデータソースについては、「DataService Studio でサポートされているデータソース」をご参照ください。
一部のデータソースは行レベルの権限をサポートしています。 サポートされているデータソースについては、「DataService Studio でサポートされているデータソース」をご参照ください。
権限ポリシー
プロジェクト管理者と開発者ユーザーはどちらもサービスユニットを作成できます。
手順 1：サービスユニットの種類を選択する
Dataphin ホームページで、トップメニューバーから [サービス] > [API 開発] を選択します。
左上隅でプロジェクトを選択し、左側のナビゲーションウィンドウで [サービスユニット] をクリックします。 [サービスユニット] ページで、[+ 新しいサービスユニット] をクリックします。
[新しいサービスユニット] ダイアログボックスで、[単一物理テーブルサービスユニット] を選択します。
手順 2：単一物理テーブルサービスユニットのパラメーターを構成する
[新しいサービスユニット] ページで、サービスユニットの基本情報とユニットフィールドを構成します。
サービスユニットの基本情報の構成
パラメーター
説明
[サービスユニット名]
サービスユニットの名前。 名前は次の要件を満たしている必要があります。
文字、数字、およびアンダースコア (_) のみ使用できます。
文字で始まります。
長さは 4 ～ 64 文字です。
[サービスユニットグループ]
すでに作成されているサービスユニットグループを選択します。
[モード]
モードは、サービスユニットが読み取るデータが開発データソースから取得されるか、本番データソースから取得されるかを定義するために使用されます。 モードには、[基本] モードと [開発 - 本番] モードがあります。
[基本]: 基本モードを選択すると、サービスユニットがデータを読み取るときに本番データソースのみを選択できます。
[開発 - 本番]: 開発 - 本番モードを選択すると、サービスユニットがデータを読み取るときに開発データソースと本番データソースの両方を選択できます。
データソースページで、データソースが本番データソースか開発データソースかを確認できます。
[物理データテーブル]
データソースタイプとデータソースに基づいて物理テーブルをフィルタリングできます。 また、[データソースを追加] をクリックして新しいビジネスデータソースを導入し、新しいビジネスデータソースに基づいてサービスユニットを作成することもできます。 サポートされているデータソースについては、「DataService Studio でサポートされているデータソース」をご参照ください。
[サービスユニットの説明]
サービスユニットの簡単な説明を入力します。 128 文字以内です。
[最大返却数]
Dataphin のデフォルトの最大返却数は 1000 です。 最大制限は 10000 です。
これは、API を介してデータをクエリするときに返されるレコード数を定義するために使用され、単一のクエリで過剰なデータが Dataphin システムのメモリ オーバーフローを引き起こすのを防ぎます。 さらに多くのデータをクエリする必要がある場合は、「API を呼び出す」の SDK で PageSize パラメーター値を変更して、API をクエリするときにさらに多くのデータを返すことができます。
同様のサービスユニットがすでに存在する場合、Dataphin は自動的にその名前を表示します。 サービスユニットの詳細情報は、サービスユニットリストで確認できます。 新しいサービスユニットの作成を続行するには、[作成を続行] をクリックして [サービスユニットフィールドの構成] ページに進みます。
サービスユニットフィールドを構成します。
パラメーター
説明
[サービスユニットフィールドの種類]
サポートされているフィールドの種類は、Double、Float、String、Date、Boolean、Int、Long、Short、Byte、BigDecimal、Binary です。 ビジネスデータテーブルのフィールドの種類に基づいて、対応するパラメーターの種類を選択する必要があります。
ビジネスデータテーブルのフィールドの種類が選択可能なパラメーターの種類の範囲内にない場合は、String を選択することをお勧めします。
[サービスユニットフィールド]
一部のソーステーブルフィールドをサービスユニットフィールドとしてカスタム選択できます。 ソーステーブルの新しいフィールドも編集中に追加および選択できます。
データソースのフィールドとサービスユニットのフィールド名のマッピングを構成します。 ビジネス状況に応じてフィールド名をカスタマイズできます。 命名規則は次のとおりです。
文字、数字、およびアンダースコア (_) のみ使用できます。
文字で始まります。
長さは 4 ～ 64 文字です。
単一物理テーブルサービスユニットを編集するときに、システムがソーステーブルフィールドが削除されたと判断した場合、サービスユニットフィールドの削除がサポートされます。 構成を送信した後、サービスユニットを参照する新しい API を作成するときに、フィールドは存在しなくなり、ソーステーブルフィールドがないために API の呼び出しが失敗することを回避できます。
[サービスユニットフィールドの説明]
サービスユニットフィールドの簡単な説明を入力します。
サービスユニットフィールドを構成した後、下部にある [データプレビュー] をクリックして、フィールドに対応するビジネスデータを表示します。 最大 1000 レコードを返すことができます。
選択した物理データテーブルに基づいて、システムは物理データテーブルに関連付けられた行レベルの権限情報を自動的に解析します。これには、行レベルの権限名、説明、制御フィールド、データソース環境、関連付けられたテーブル、および関連付けられたフィールドが含まれます。 また、次の操作を実行することもできます。
行レベルの権限を [有効にする] または [無効にする]: 行レベルの権限の有効ステータスと、サービスユニットを表示するときに 行レベルの権限リスト情報が表示されるかどうかを制御します。
行レベルの権限の作成: オペレーターには、行レベルの権限を作成する権限が必要です。 クリックして [管理ハブ] > [権限管理] の行レベルの権限作成ページに移動し、新しい 行レベルの権限 を作成します。
説明この API の呼び出しによって返されるデータ範囲は、行レベルの権限によって制御されます。行レベルの権限に不整合がある場合、データの戻り結果に違いが生じます。
モードが [基本] の場合、本番環境に関連付けられた物理データテーブルの行レベル権限が表示されます。モードが開発-本番の場合、開発環境と本番環境の両方に関連付けられた物理データテーブルの行レベル権限が表示されます。
サービスユニットで行レベルの権限が有効になっていて、公開されている場合、このサービスユニットで作成された API は、呼び出されたときに対応する行レベルの権限によって制御されます。
行レベルの権限が有効になっていて公開されているサービスユニットで API を作成する場合、[管理ハブ] > [権限管理] でサービスユニットに関連付けられた行レベルの権限を作成または削除すると、API を再公開する必要なく、システムによって行レベルの権限が自動的に有効または無効になります。
追加された物理テーブルは、物理テーブルのフィールドが API によって使用されているか、サービスユニットに追加されているかに関係なく、物理テーブルに関連付けられた行レベルの権限によって制御されます。
[送信] をクリックして、単一物理テーブルサービスユニットの作成を完了します。
次の手順
サービスユニットページで、[アクション] 列の
アイコンをクリックし、[公開] を選択して、単一物理テーブルサービスユニットを本番環境に送信します。 その後、この単一物理テーブルサービスユニットに基づいて API を作成できます。 詳細については、「API を作成する」をご参照ください。物理テーブルサービスユニットが作成された後、サービスユニットページで編集、公開、または削除できます。 詳細については、「サービスユニットを管理する」をご参照ください。