バージョン: 3.16

ScalarDB Analytics データソースリファレンス

注記

このページは英語版のページが機械翻訳されたものです。英語版との間に矛盾または不一致がある場合は、英語版を正としてください。

このリファレンスガイドでは、ScalarDB Analytics のデータソース設定形式、プロバイダー固有の設定、およびデータ型マッピングに関する詳細情報を提供します。

警告

ScalarDB Analytics を使用するには、ライセンスキー (試用ライセンスまたは商用ライセンス) が必要です。ライセンスキーをお持ちでない場合は、お問い合わせください。

データソース登録ファイル形式

データソースは、データソース登録ファイルを使用してCLIでカタログに登録されます。これらのファイルは以下の構造を持ちます。CLIコマンドの詳細については、CLIコマンドリファレンスを参照してください。

{
  "catalog": "<catalog-name>", // データソースを登録するカタログ
  "name": "<data-source-name>", // このデータソースの一意の名前
  "type": "<database-type>", // データベースタイプ: postgres, mysql, scalardb, sqlserver, oracle, dynamodb
  "provider": {
    // タイプ固有の接続設定
    // 設定はデータベースタイプによって異なります
  }
}

provider セクションには、type フィールドに基づいたデータソース固有の接続設定が含まれます。

タイプ別のプロバイダー設定

以下のセクションでは、サポートされている各データベースタイプのプロバイダー設定を示します：

設定

ScalarDB の設定は以下の通りです。

`configPath`

フィールド: configPath
説明: ScalarDB 設定ファイルへのパス。

例

{
  "catalog": "production",
  "name": "scalardb_source",
  "type": "scalardb",
  "provider": {
    "configPath": "/path/to/scalardb.properties"
  }
}

設定

PostgreSQL の設定は以下の通りです。

`host`

フィールド: host
説明: PostgreSQL サーバーのホスト名。

`port`

フィールド: port
説明: ポート番号。

`username`

フィールド: username
説明: データベースユーザー。

`password`

フィールド: password
説明: データベースパスワード。

`database`

フィールド: database
説明: 接続するデータベース名。

例

{
  "catalog": "production",
  "name": "postgres_customers",
  "type": "postgres",
  "provider": {
    "host": "postgres.example.com",
    "port": 5432,
    "username": "analytics_user",
    "password": "secure_password",
    "database": "customers"
  }
}

設定

MySQL の設定は以下の通りです。

`host`

フィールド: host
説明: MySQL サーバーのホスト名。

`port`

フィールド: port
説明: ポート番号。

`username`

フィールド: username
説明: データベースユーザー。

`password`

フィールド: password
説明: データベースパスワード。

`database`

フィールド: database
説明: インポートする特定のデータベース。省略した場合、すべてのデータベースがインポートされます。
デフォルト値: なし（すべてのデータベースをインポート）

例

{
  "catalog": "production",
  "name": "mysql_orders",
  "type": "mysql",
  "provider": {
    "host": "mysql.example.com",
    "port": 3306,
    "username": "analytics_user",
    "password": "secure_password",
    "database": "orders" // オプション - 省略した場合、すべてのデータベースがインポートされます
  }
}

設定

Oracle の設定は以下の通りです。

`host`

フィールド: host
説明: Oracle サーバーのホスト名。

`port`

フィールド: port
説明: ポート番号。

`username`

フィールド: username
説明: データベースユーザー。

`password`

フィールド: password
説明: データベースパスワード。

`serviceName`

フィールド: serviceName
説明: Oracle サービス名。

例

{
  "catalog": "production",
  "name": "oracle_warehouse",
  "type": "oracle",
  "provider": {
    "host": "oracle.example.com",
    "port": 1521,
    "username": "analytics_user",
    "password": "secure_password",
    "serviceName": "ORCL"
  }
}

設定

SQL Server の設定は以下の通りです。

`host`

フィールド: host
説明: SQL Server のホスト名。

`port`

フィールド: port
説明: ポート番号。

`username`

フィールド: username
説明: データベースユーザー。

`password`

フィールド: password
説明: データベースパスワード。

`database`

フィールド: database
説明: 接続する特定のデータベース。
デフォルト値: なし（デフォルトデータベースに接続）

`secure`

フィールド: secure
説明: 暗号化を有効化。
デフォルト値: false

例

{
  "catalog": "production",
  "name": "sqlserver_analytics",
  "type": "sqlserver",
  "provider": {
    "host": "sqlserver.example.com",
    "port": 1433,
    "username": "sa",
    "password": "secure_password",
    "database": "analytics", // オプション - 指定した場合、このデータベースのみがインポートされます
    "secure": true // オプション - 暗号化を有効化
  }
}

設定

DynamoDB の設定は以下の通りです。

AWS 認証情報

DynamoDB の認証は標準的な AWS SDK の認証情報プロバイダーチェーンを使用します。認証情報は以下の方法で設定できます：

環境変数（AWS_ACCESS_KEY_ID、AWS_SECRET_ACCESS_KEY）
AWS 認証情報ファイル（~/.aws/credentials）
IAM ロール（EC2、ECS、Lambda 上で実行する場合）
AWS SSO または AWS SDK がサポートするその他の認証情報プロバイダー

詳細については、AWS SDK の認証情報プロバイダーに関するドキュメントを参照してください。

`region`

フィールド: region
説明: AWS リージョン（例: us-east-1）。region または endpoint のいずれかを指定する必要があります（両方は指定できません）。

`endpoint`

フィールド: endpoint
説明: カスタムエンドポイント URL。region または endpoint のいずれかを指定する必要があります（両方は指定できません）。

`schema`

フィールド: schema
説明: 完全なスキーマ定義。DynamoDB はスキーマレスなので、完全なスキーマ定義を提供する必要があります。

スキーマ構造

schema フィールドには以下の構造が必要です：

`.schema.namespaces[]`

フィールド: .schema.namespaces[]
説明: 名前空間定義の配列。

`.schema.namespaces[].names[]`

フィールド: .schema.namespaces[].names[]
説明: 名前空間名の配列（文字列）。

`.schema.namespaces[].tables[]`

フィールド: .schema.namespaces[].tables[]
説明: テーブル定義の配列。

`.schema.namespaces[].tables[].name`

フィールド: .schema.namespaces[].tables[].name
説明: テーブル名。

`.schema.namespaces[].tables[].columns[]`

フィールド: .schema.namespaces[].tables[].columns[]
説明: カラム定義の配列。

`.schema.namespaces[].tables[].columns[].name`

フィールド: .schema.namespaces[].tables[].columns[].name
説明: カラム名。

`.schema.namespaces[].tables[].columns[].type`

フィールド: .schema.namespaces[].tables[].columns[].type
説明: データ型。

`.schema.namespaces[].tables[].columns[].nullable`

フィールド: .schema.namespaces[].tables[].columns[].nullable
説明: カラムがnull値を含むことができるかどうか。
デフォルト値: true

例

{
  "catalog": "production",
  "name": "dynamodb_events",
  "type": "dynamodb",
  "provider": {
    "region": "us-east-1",
    "schema": {
      "namespaces": [
        {
          "names": ["production"],
          "tables": [
            {
              "name": "user_events",
              "columns": [
                { "name": "user_id", "type": "TEXT", "nullable": false },
                {
                  "name": "event_time",
                  "type": "TIMESTAMP",
                  "nullable": false
                },
                { "name": "event_type", "type": "TEXT" },
                { "name": "event_data", "type": "TEXT" }
              ]
            }
          ]
        }
      ]
    }
  }
}

カタログ情報リファレンス

このセクションでは、データソース別のカタログ構造マッピングとデータ型マッピングについて説明します。

データソース別のカタログ構造マッピング

データソースを ScalarDB Analytics に登録する際、データソースのカタログ構造、すなわち名前空間、テーブル、列が解決され、ユニバーサルデータカタログに登録されます。データソースのカタログ構造を解決するために、データソース側の特定のオブジェクトがユニバーサルデータカタログオブジェクトにマッピングされます。

カタログレベルのマッピング

カタログレベルのマッピングは、データソースから名前空間名、テーブル名、および列名をユニバーサルデータカタログへのマッピングです。各データソースでのカタログレベルのマッピングを確認するには、データソースを選択してください。

ScalarDB のカタログ構造は ScalarDB Analytics によって自動的に解決されます。カタログレベルのオブジェクトは以下のようにマッピングされます：

ScalarDB 名前空間は名前空間にマッピングされます。したがって、ScalarDB データソースの名前空間は常に単一レベルで、名前空間名のみで構成されます。
ScalarDB テーブルはテーブルにマッピングされます。
ScalarDB 列は列にマッピングされます。

PostgreSQL のカタログ構造は ScalarDB Analytics によって自動的に解決されます。カタログレベルのオブジェクトは以下のようにマッピングされます：

PostgreSQL スキーマは名前空間にマッピングされます。したがって、PostgreSQL データソースの名前空間は常に単一レベルで、スキーマ名のみで構成されます。
- ユーザー定義スキーマのみが名前空間にマッピングされます。以下のシステムスキーマは無視されます：
  - information_schema
  - pg_catalog
PostgreSQL テーブルはテーブルにマッピングされます。
PostgreSQL 列は列にマッピングされます。

MySQL のカタログ構造は ScalarDB Analytics によって自動的に解決されます。カタログレベルのオブジェクトは以下のようにマッピングされます：

MySQL データベースは名前空間にマッピングされます。したがって、MySQL データソースの名前空間は常に単一レベルで、データベース名のみで構成されます。
- ユーザー定義データベースのみが名前空間にマッピングされます。以下のシステムデータベースは無視されます：
  - mysql
  - sys
  - information_schema
  - performance_schema
MySQL テーブルはテーブルにマッピングされます。
MySQL 列は列にマッピングされます。

Oracle のカタログ構造は ScalarDB Analytics によって自動的に解決されます。カタログレベルのオブジェクトは以下のようにマッピングされます：

Oracle スキーマは名前空間にマッピングされます。したがって、Oracle データソースの名前空間は常に単一レベルで、スキーマ名のみで構成されます。
- ユーザー定義スキーマのみが名前空間にマッピングされます。以下のシステムスキーマは無視されます：
  - ANONYMOUS
  - APPQOSSYS
  - AUDSYS
  - CTXSYS
  - DBSNMP
  - DGPDB_INT
  - DBSFWUSER
  - DVF
  - DVSYS
  - GGSYS
  - GSMADMIN_INTERNAL
  - GSMCATUSER
  - GSMROOTUSER
  - GSMUSER
  - LBACSYS
  - MDSYS
  - OJVMSYS
  - ORDDATA
  - ORDPLUGINS
  - ORDSYS
  - OUTLN
  - REMOTE_SCHEDULER_AGENT
  - SI_INFORMTN_SCHEMA
  - SYS
  - SYS$UMF
  - SYSBACKUP
  - SYSDG
  - SYSKM
  - SYSRAC
  - SYSTEM
  - WMSYS
  - XDB
  - DIP
  - MDDATA
  - ORACLE_OCM
  - XS$NULL

SQL Server のカタログ構造は ScalarDB Analytics によって自動的に解決されます。カタログレベルのオブジェクトは以下のようにマッピングされます：

SQL Server データベースとスキーマは共に名前空間にマッピングされます。したがって、SQL Server データソースの名前空間は常に2レベルで、データベース名とスキーマ名で構成されます。
- ユーザー定義データベースのみが名前空間にマッピングされます。以下のシステムデータベースは無視されます：
  - sys
  - guest
  - INFORMATION_SCHEMA
  - db_accessadmin
  - db_backupoperator
  - db_datareader
  - db_datawriter
  - db_ddladmin
  - db_denydatareader
  - db_denydatawriter
  - db_owner
  - db_securityadmin
- ユーザー定義スキーマのみが名前空間にマッピングされます。以下のシステムスキーマは無視されます：
  - master
  - model
  - msdb
  - tempdb
SQL Server テーブルはテーブルにマッピングされます。
SQL Server 列は列にマッピングされます。

DynamoDB はスキーマレスであるため、DynamoDB データソースを登録する際に以下のような形式の JSON を使用してカタログ構造を明示的に指定する必要があります：

{
    "namespaces": [
        {
            "name": "<NAMESPACE_NAME>",
            "tables": [
                {
                    "name": "<TABLE_NAME>",
                    "columns": [
                        {
                            "name": "<COLUMN_NAME>",
                            "type": "<COLUMN_TYPE>"
                        },
                        ...
                    ]
                },
                ...
            ]
        },
        ...
    ]
}

指定した JSON では、任意の名前空間名を使用できますが、テーブル名は DynamoDB のテーブル名と一致する必要があり、列名と型は DynamoDB のフィールド名と型と一致する必要があります。

データ型マッピング

以下のセクションでは、各データソースのネイティブ型が ScalarDB Analytics 型にどのようにマッピングされるかを示します：

警告

以下のマッピングテーブルに含まれていないデータ型の列は、データソース登録時に無視されます。これらの列は ScalarDB Analytics カタログに表示されず、クエリすることもできません。無視された列の情報は ScalarDB Analytics サーバーログに記録されます。

ScalarDB データ型	ScalarDB Analytics データ型
`BOOLEAN`	`BOOLEAN`
`INT`	`INT`
`BIGINT`	`BIGINT`
`FLOAT`	`FLOAT`
`DOUBLE`	`DOUBLE`
`TEXT`	`TEXT`
`BLOB`	`BLOB`
`DATE`	`DATE`
`TIME`	`TIME`
`TIMESTAMP`	`TIMESTAMP`
`TIMESTAMPTZ`	`TIMESTAMPTZ`

PostgreSQL データ型	ScalarDB Analytics データ型
`integer`	`INT`
`bigint`	`BIGINT`
`real`	`FLOAT`
`double precision`	`DOUBLE`
`smallserial`	`SMALLINT`
`serial`	`INT`
`bigserial`	`BIGINT`
`char`	`TEXT`
`varchar`	`TEXT`
`text`	`TEXT`
`bpchar`	`TEXT`
`boolean`	`BOOLEAN`
`bytea`	`BLOB`
`date`	`DATE`
`time`	`TIME`
`time with time zone`	`TIME`
`time without time zone`	`TIME`
`timestamp`	`TIMESTAMP`
`timestamp with time zone`	`TIMESTAMPTZ`
`timestamp without time zone`	`TIMESTAMP`

MySQL データ型	ScalarDB Analytics データ型
`bit`	`BOOLEAN`
`bit(1)`	`BOOLEAN`
`bit(x)` if x >= 2	`BLOB`
`tinyint`	`SMALLINT`
`tinyint(1)`	`BOOLEAN`
`boolean`	`BOOLEAN`
`smallint`	`SMALLINT`
`smallint unsigned`	`INT`
`mediumint`	`INT`
`mediumint unsigned`	`INT`
`int`	`INT`
`int unsigned`	`BIGINT`
`bigint`	`BIGINT`
`float`	`FLOAT`
`double`	`DOUBLE`
`real`	`DOUBLE`
`char`	`TEXT`
`varchar`	`TEXT`
`text`	`TEXT`
`binary`	`BLOB`
`varbinary`	`BLOB`
`blob`	`BLOB`
`date`	`DATE`
`time`	`TIME`
`datetime`	`TIMESTAMP`
`timestamp`	`TIMESTAMPTZ`

Oracle データ型	ScalarDB Analytics データ型
`NUMBER` if scale = 0	`BIGINT`
`NUMBER` if scale > 0	`DOUBLE`
`FLOAT` if precision ≤ 53	`DOUBLE`
`BINARY_FLOAT`	`FLOAT`
`BINARY_DOUBLE`	`DOUBLE`
`CHAR`	`TEXT`
`NCHAR`	`TEXT`
`VARCHAR2`	`TEXT`
`NVARCHAR2`	`TEXT`
`CLOB`	`TEXT`
`NCLOB`	`TEXT`
`BLOB`	`BLOB`
`BOOLEAN`	`BOOLEAN`
`DATE`	`DATE`
`TIMESTAMP`	`TIMESTAMPTZ`
`TIMESTAMP WITH TIME ZONE`	`TIMESTAMPTZ`
`TIMESTAMP WITH LOCAL TIME ZONE`	`TIMESTAMP`
`RAW`	`BLOB`

SQL Server データ型	ScalarDB Analytics データ型
`bit`	`BOOLEAN`
`tinyint`	`SMALLINT`
`smallint`	`SMALLINT`
`int`	`INT`
`bigint`	`BIGINT`
`real`	`FLOAT`
`float`	`DOUBLE`
`float(n)` if n ≤ 24	`FLOAT`
`float(n)` if n ≥ 25	`DOUBLE`
`binary`	`BLOB`
`varbinary`	`BLOB`
`char`	`TEXT`
`varchar`	`TEXT`
`nchar`	`TEXT`
`nvarchar`	`TEXT`
`ntext`	`TEXT`
`text`	`TEXT`
`date`	`DATE`
`time`	`TIME`
`datetime`	`TIMESTAMP`
`datetime2`	`TIMESTAMP`
`smalldatetime`	`TIMESTAMP`
`datetimeoffset`	`TIMESTAMPTZ`

DynamoDB データ型	ScalarDB Analytics データ型
`String`	`TEXT`
`Number`	`DOUBLE`
`Binary`	`BLOB`
`Boolean`	`BOOLEAN`
`Null`	`NULL`
`String Set`	`TEXT`
`Number Set`	`TEXT`
`Binary Set`	`TEXT`
`List`	`TEXT`
`Map`	`TEXT`

注記

DynamoDB の複合データ型（String Set、Number Set、Binary Set、List、Map）は互換性のために TEXT にマッピングされます。実際の値は ScalarDB Analytics クエリで JSON 文字列としてシリアル化されます。

データソース登録ファイル形式​

タイプ別のプロバイダー設定​

設定

configPath

例

設定

host

port

username

password

database

例

設定

host

port

username

password

database

例

設定

host

port

username

password

serviceName

例

設定

host

port

username

password

database

secure

例

設定

region

endpoint

schema

スキーマ構造

.schema.namespaces[]

.schema.namespaces[].names[]

.schema.namespaces[].tables[]

.schema.namespaces[].tables[].name

.schema.namespaces[].tables[].columns[]

.schema.namespaces[].tables[].columns[].name

.schema.namespaces[].tables[].columns[].type

.schema.namespaces[].tables[].columns[].nullable

例

カタログ情報リファレンス​

データソース別のカタログ構造マッピング​

カタログレベルのマッピング​

データ型マッピング​

データソース登録ファイル形式

タイプ別のプロバイダー設定

`configPath`

`host`

`port`

`username`

`password`

`database`

`host`

`port`

`username`

`password`

`database`

`host`

`port`

`username`

`password`

`serviceName`

`host`

`port`

`username`

`password`

`database`

`secure`

`region`

`endpoint`

`schema`

`.schema.namespaces[]`

`.schema.namespaces[].names[]`

`.schema.namespaces[].tables[]`

`.schema.namespaces[].tables[].name`

`.schema.namespaces[].tables[].columns[]`

`.schema.namespaces[].tables[].columns[].name`

`.schema.namespaces[].tables[].columns[].type`

`.schema.namespaces[].tables[].columns[].nullable`

カタログ情報リファレンス

データソース別のカタログ構造マッピング

カタログレベルのマッピング

データ型マッピング