このページでは、CData Cloud でのAirtable への接続の確立 のガイド、利用可能なリソースに関する情報、および使用可能な接続プロパティのリファレンスについて説明します。

Airtable への接続

接続の確立 は、CData Cloud にデータベースを作成するためのAirtable への認証方法と必要な接続プロパティの設定方法について示します。

CData Cloud サービスからデータにアクセス

利用可能な標準サービスを経由してAirtable からデータにアクセスする方法と、CData Cloud の管理については、CData Cloud ドキュメント で詳しく説明します。

Database タブで対応するアイコンを選択して、Airtable に接続します。必須プロパティはSettings にリストされています。Advanced タブには、通常は必要ない接続プロパティが表示されます。

Airtable への接続

Cloud は、Airtable にテーブルとビューを要求します。以下を設定して接続します。

• BaseId（オプション）：オプションで、このプロパティまたはBaseName のいずれかを指定して、表示されるテーブルおよびビューを特定のベースに制限できます。これをベースID に設定します。
  • この値を見つけるにはthe Airtable API Reference に移動してベースを選択します。選択したベースについてのAirtable ドキュメントのIntroduction セクションで、The ID of this base is <Id> で指定された値を控えておきます。
• BaseName（オプション）：オプションで、このプロパティまたはBaseId のいずれかを指定して、表示されるテーブルおよびビューを特定のベースに制限できます。これを、Airtable のBase の名前に対応する、使用するスキーマの名前に設定します。

Airtable への認証

個人用アクセストークンまたはOAuth PKCE のいずれかを使用して、Airtable に認証できます。

個人用アクセストークン

まだ個人用アクセストークンを生成していない場合は、はじめに生成します。

1. ユーザーアカウントにログインします。
2. token creation page に移動します。
3. Create new token をクリックします。
4. Scopes で、Add a scope をクリックして以下の各スコープを追加します。
   • data.records:read
   • data.records:write
   • schema.bases:read
5. Access で、トークンにアクセス権を付与するすべてのワークスペースとベースを追加します。
6. Create token をクリックしてトークンを生成します。生成されたトークンは一度しか表示されないので、コピーして保存します。

• AuthScheme：PersonalAccessToken に設定。
• OAuthAccessToken：先ほど生成した個人用アクセストークンの値に設定。

OAuth PKCE

AuthScheme をOAuthPKCE に設定します。

SSL 設定のカスタマイズ

デフォルトでは、Cloud はサーバーとのTLS のネゴシエーションを試みます。サーバー証明書は、デフォルトのシステム信頼済み証明書ストアで検証されます。SSLServerCert 接続プロパティを使用して、証明書の検証方法をオーバーライドできます。

別の証明書を指定するには、SSLServerCert 接続プロパティを参照してください。

Firewall またはProxy 経由の接続

HTTP プロキシ

HTTP プロキシへの認証には、以下のように設定します。

• ProxyServer：HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。
• ProxyPort：プロキシサーバーが起動しているTCP ポート。
• ProxyAuthScheme：プロキシサーバーに対して認証する際にCloud が使用する認証方法。
• ProxyUser：プロキシサーバーに登録されているユーザーアカウントのユーザー名。
• ProxyPassword：ProxyUser に紐付けられたパスワード。

その他のプロキシ

次のプロパティを設定します。

• プロキシベースのファイヤーウォールを使用するには、FirewallType、FirewallServer、およびFirewallPort を設定します。
• 接続をトンネルするには、FirewallType をTUNNEL に設定します。
• 認証するには、FirewallUser とFirewallPassword を設定します。
• SOCKS プロキシへの認証には、さらにFirewallType をSOCKS5 に設定します。

概要

このセクションでは、利用可能なAPI オブジェクトを示し、Airtable API へのSQL の実行について詳しく説明します。

主要機能

• Cloud は、Airtable ベースをリレーショナルデータベースとしてモデル化し、SQL を記述してAirtable データをクエリできるようにします。
• ストアドプロシージャを使用するとAirtable の操作を実行できます。
• これらのオブジェクトへのライブ接続により、Cloud を使用するとAirtable アカウントへのあらゆる変更が即座に反映されます。

The information schema contains information on Airtable users, groups collaborators and more.

ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。

クエリは、ビューに対して通常のテーブルと同様に実行することができます。

CData Cloud - Airtable ビュー

Query available bases.

View-Specific Information

SELECT Examples

SELECT * FROM [INFORMATION_SCHEMA].[Bases]

Columns

Query group collaborators for airtable bases and workspaces.

View-Specific Information

SELECT Examples

    SELECT * FROM [INFORMATION_SCHEMA].[GroupCollaborators]
    SELECT * FROM [INFORMATION_SCHEMA].[GroupCollaborators] WHERE BaseId = 'appWJ6DP3C7Guh9fS'

Columns

Query group members.

Columns

Query user groups.

Columns

Query individual collaborators for airtable bases and workspaces.

View-Specific Information

SELECT Examples

    SELECT * FROM [INFORMATION_SCHEMA].[IndividualCollaborators]
    SELECT * FROM [INFORMATION_SCHEMA].[IndividualCollaborators] WHERE BaseId = 'appWJ6DP3C7Guh9fS'

Columns

Query available tables in airtable bases.

View-Specific Information

SELECT Examples

    SELECT * FROM [INFORMATION_SCHEMA].[Tables]
    SELECT * FROM [INFORMATION_SCHEMA].[Tables] WHERE BaseId = 'appWJ6DP3C7Guh9fS'

Columns

Query users.

View-Specific Information

SELECT Examples

SELECT * FROM [INFORMATION_SCHEMA].[Users]

Columns

ストアドプロシージャはファンクションライクなインターフェースで、Airtable の単純なSELECT/INSERT/UPDATE/DELETE 処理にとどまらずCloud の機能を拡張します。

ストアドプロシージャは、パラメータのリストを受け取り、目的の機能を実行し、プロシージャが成功したか失敗したかを示すとともにAirtable から関連するレスポンスデータを返します。

CData Cloud - Airtable ストアドプロシージャ

ドライバーは各Airtable ベースを個別のスキーマとして公開します。これはサンプルベースです。

Cloud はAirtable のデータを、標準のSQL ステートメントを使用してクエリできるリレーショナルデータベースのテーブルのリストとしてモデル化します。

CData Cloud - Airtable テーブル

Sample of a random table in a random base.

Columns

ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。

クエリは、ビューに対して通常のテーブルと同様に実行することができます。

CData Cloud - Airtable ビュー

Child view of the SampleTable table. This is autogenerated view in order to expose values of attachments type columns for SampleTable table.

Columns

Child view of the SampleTable table. This is autogenerated view in order to expose values of collaborators type columns for SampleTable table.

Columns

ストアドプロシージャはファンクションライクなインターフェースで、Airtable の単純なSELECT/INSERT/UPDATE/DELETE 処理にとどまらずCloud の機能を拡張します。

ストアドプロシージャは、パラメータのリストを受け取り、目的の機能を実行し、プロシージャが成功したか失敗したかを示すとともにAirtable から関連するレスポンスデータを返します。

CData Cloud - Airtable ストアドプロシージャ

Syncs raw CSV data into a Sync API table.

Input

Result Set Columns

このセクションで説明されているシステムテーブルをクエリして、スキーマ情報、データソース機能に関する情報、およびバッチ操作の統計にアクセスできます。

スキーマテーブル

以下のテーブルは、Airtable のデータベースメタデータを返します。

• sys_catalogs：利用可能なデータベースをリスト。
• sys_schemas：利用可能なスキーマをリスト。
• sys_tables：利用可能なテーブルおよびビューをリスト。
• sys_tablecolumns：利用可能なテーブルおよびビューのカラムについて説明。
• sys_procedures：利用可能なストアドプロシージャについて説明。
• sys_procedureparameters：ストアドプロシージャパラメータについて説明。
• sys_keycolumns：主キーおよび外部キーについて説明。
• sys_indexes：利用可能なインデックスについて説明。

データソーステーブル

以下のテーブルは、データソースへの接続方法およびクエリ方法についての情報を返します。

• sys_connection_props：利用可能な接続プロパティについての情報を返す。
• sys_sqlinfo：Cloud がデータソースにオフロードできるSELECT クエリについて説明。

クエリ情報テーブル

次のテーブルは、データ変更クエリのクエリ統計を返します。

• sys_identity：バッチ処理または単一の更新に関する情報を返す。

利用可能なデータベースをリストします。

次のクエリは、接続文字列で決定されるすべてのデータベースを取得します。

SELECT * FROM sys_catalogs

Columns

利用可能なスキーマをリストします。

次のクエリは、すべての利用可能なスキーマを取得します。

          SELECT * FROM sys_schemas
          

Columns

利用可能なテーブルをリストします。

次のクエリは、利用可能なテーブルおよびビューを取得します。

          SELECT * FROM sys_tables
          

Columns

利用可能なテーブルおよびビューのカラムについて説明します。

次のクエリは、SampleTable_1 テーブルのカラムとデータ型を返します。

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='SampleTable_1' 

Columns

利用可能なストアドプロシージャをリストします。

次のクエリは、利用可能なストアドプロシージャを取得します。

          SELECT * FROM sys_procedures
          

Columns

ストアドプロシージャパラメータについて説明します。

次のクエリは、CreateSchema ストアドプロシージャのすべての入力パラメータについての情報を返します。

SELECT * FROM sys_procedureparameters WHERE ProcedureName='CreateSchema' AND Direction=1 OR Direction=2

Columns

主キーおよび外部キーについて説明します。

次のクエリは、SampleTable_1 テーブルの主キーを取得します。

         SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='SampleTable_1' 
          

Columns

外部キーについて説明します。

次のクエリは、他のテーブルを参照するすべての外部キーを取得します。

         SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
          

カラム

主キーについて説明します。

次のクエリは、すべてのテーブルとビューから主キーを取得します。

         SELECT * FROM sys_primarykeys
          

Columns

利用可能なインデックスについて説明します。インデックスをフィルタリングすることで、より高速なクエリ応答時間でセレクティブクエリを記述できます。

次のクエリは、主キーでないすべてのインデックスを取得します。

          SELECT * FROM sys_indexes WHERE IsPrimary='false'
          

Columns

利用可能な接続プロパティと、接続文字列に設定されている接続プロパティに関する情報を返します。

次のクエリは、接続文字列に設定されている、あるいはデフォルト値で設定されているすべての接続プロパティを取得します。

SELECT * FROM sys_connection_props WHERE Value <> ''

Columns

Cloud がデータソースにオフロードできるSELECT クエリ処理について説明します。

SQL 構文の詳細については、SQL 準拠 を参照してください。

データソースのSELECT 機能

以下はSQL 機能のサンプルデータセットです。 SELECT 機能のいくつかの側面がサポートされている場合には、カンマ区切りのリストで返されます。サポートされていない場合、カラムにはNO が入ります。

次のクエリは、WHERE 句で使用できる演算子を取得します。

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'

Columns

試行された変更に関する情報を返します。

次のクエリは、バッチ処理で変更された行のId を取得します。

         SELECT * FROM sys_identity
          

Columns

利用可能なシステム情報を説明します。

次のクエリは、すべてのカラムを取得します。

SELECT * FROM sys_information

Columns

Authentication

OAuth

SSL

Logging

Schema

Miscellaneous

このセクションでは、本プロバイダーの接続文字列で設定可能なAuthentication プロパティの全リストを提供します。

The type of authentication to use when connecting to Airtable.

Possible Values

データ型

string

デフォルト値

"OAuthPKCE"

解説

• PersonalAccessToken: Set this to use Personal Access Token authentication.
• OAuthPKCE: Set this to use OAuth PKCE authentication.

Id of the base. This property is not required when the Metadata API is enabled, but specifying it restricts the metadata that will be retrieved.

データ型

string

デフォルト値

""

解説

Id of the base. This property is not required when the Metadata API is enabled, but specifying it restricts the metadata that will be retrieved.

The schema to use - which corresponds to the name of the Base in Airtable. This property is only used when the Metadata API is enabled.

データ型

string

デフォルト値

""

解説

The schema to use - which corresponds to the name of the Base in Airtable. This property is only used when the Metadata API is enabled.

このセクションでは、本プロバイダーの接続文字列で設定可能なOAuth プロパティの全リストを提供します。

カスタムOAuth アプリケーションの作成時に割り当てられたクライアントId を指定します。（コンシューマーキーとも呼ばれます。）このID は、カスタムアプリケーションをOAuth 認可サーバーに登録します。

データ型

string

デフォルト値

""

解説

OAuthClientId は、ユーザーがOAuth 経由で認証を行う前に設定する必要があるいくつかの接続パラメータの1つです。詳細は接続の確立を参照してください。

カスタムOAuth アプリケーションの作成時に割り当てられたクライアントシークレットを指定します。（ コンシューマーシークレット とも呼ばれます。）このシークレットは、カスタムアプリケーションをOAuth 認可サーバーに登録します。

データ型

string

デフォルト値

""

解説

OAuthClientSecret は、ユーザーがOAuth 経由で認証を行う前に設定する必要があるいくつかの接続パラメータの1つです。詳細は接続の確立を参照してください。

OAuth ネットワークへの認証後に受け取ったトークンで、ユーザーにアクセス権を付与します。 アクセストークンはユーザーのログインID とパスワードの代わりに使用され、サーバーに保持されます。

データ型

string

デフォルト値

""

解説

OAuth アクセストークンにはサーバーに依存する時間制限があり、ユーザーのアクセスを制限します。これは、OAuthExpiresIn プロパティを使用して設定します。ただし、ユーザーが操作を続けている限り、リクエスト間で再発行することでアクセスを維持することができます。

InitiateOAuth がREFRESH に設定されている場合、OAuthExpiresIn とOAuthTokenTimestamp の両方を設定することを推奨します。 Cloud は、これらのプロパティを使用してトークンの有効期限を判断し、最も効率的にリフレッシュできるようにします。

OAuthExpiresIn およびOAuthTokenTimestamp が指定されていない場合、Cloud はトークンを直ちにリフレッシュします。

このセクションでは、本プロバイダーの接続文字列で設定可能なSSL プロパティの全リストを提供します。

TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。

データ型

string

デフォルト値

""

解説

TLS/SSL 接続を使用する場合は、このプロパティを使用して、サーバーが受け入れるTLS/SSL 証明書を指定できます。コンピュータによって信頼されていない他の証明書はすべて拒否されます。

このプロパティは、次のフォームを取ります：

これを指定しない場合は、マシンが信用するすべての証明書が受け入れられます。

すべての証明書の受け入れを示すには、'*'を使用します。セキュリティ上の理由から、これはお勧めできません。

このセクションでは、本プロバイダーの接続文字列で設定可能なLogging プロパティの全リストを提供します。

ログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。

データ型

string

デフォルト値

"1"

解説

このプロパティは、Cloud がログファイルに含める詳細レベルを定義します。 Verbosity レベルを高くするとログに記録される情報の詳細が増えますが、ログファイルが大きくなり取り込まれるデータが増えるためパフォーマンスが低下する可能性があります。

デフォルトのVerbosity レベルは1で、通常の運用にはこれが推奨されます。 より高いVerbosity レベルは主にデバッグを目的としています。 各レベルの詳細については、ログ を参照してください。

LogModules プロパティと組み合わせることで、Verbosity は特定の情報カテゴリに対するログの詳細度を調整できます。

このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。

レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。

データ型

string

デフォルト値

""

解説

利用可能なデータベーススキーマをすべてリストすると余分な時間がかかり、パフォーマンスが低下します。 接続文字列にスキーマのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。

このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。

An optional override for the column value output format of elements that are arrays of primitive values.

Possible Values

データ型

string

デフォルト値

"AGGREGATE"

解説

This property decides how the column value of elements that are arrays of primitive values is displayed in the output. If set to AGGREGATE, the value will be the aggregate form of the array. If set to DELIMITED, the value will be a delimited string of the values.

Boolean determining if schema, table, view and column names should be replaced by their corresponding internal ID.

データ型

bool

デフォルト値

false

解説

Boolean determining if schema, table, view and column names should be replaced by their corresponding internal ID. If this property and the Metadata API is also enabled, the description for tables, views and columns will include their corresponding display name.

Specifies the value format.

Possible Values

データ型

string

デフォルト値

"FormattedValue"

解説

• FormattedValue: Return values based on their data types.
• DisplayText: Return the text values as displayed in the UI. Columns that allow formatting will be pushed as type string.

集計やGROUP BY を使用しないクエリで返される最大行数を指定します。

データ型

int

デフォルト値

-1

解説

このプロパティは、集計やGROUP BY 句を含まないクエリに対してCloud が返す行数の上限を設定します。 この制限により、クエリがデフォルトで過度に大きな結果セットを返さないようにします。

クエリにLIMIT 句が含まれている場合、クエリで指定された値がMaxRows 設定よりも優先されます。 MaxRows が"-1" に設定されている場合、LIMIT 句が明示的にクエリに含まれていない限り、行の制限は行われません。

このプロパティは、非常に大きなデータセットを返す可能性のあるクエリを実行する際に、パフォーマンスを最適化し過剰なリソース消費を防ぐのに役立ちます。

Airtable から返される、1ページあたりの結果の最大数を指定します。この設定は、ほとんどのユースケースに最適化されている、データソースによって設定されたデフォルトのページサイズをオーバーライドします。

データ型

int

デフォルト値

100

解説

クエリする特定のオブジェクトやサービスエンドポイントの結果を最適化するために、デフォルトのページサイズを調整したい場合があります。 ページサイズを大きくするとパフォーマンスが向上するかもしれませんが、ページあたりのメモリ消費量が増える可能性もあることに注意してください。

The character which will be used as delimiter for bulding column names based on paths.

データ型

string

デフォルト値

"."

解説

If your columns already contain '.' character in their name, it is necessary to specify another character that is not used in column names, since it may risk breaking INSERT/UPDATE statements.

テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。

データ型

string

デフォルト値

""

解説

このプロパティを使用すると、Cloud がテーブルカラムとして公開する擬似カラムを定義できます。

個々の擬似カラムを指定するには、以下の形式を使用します。"Table1=Column1;Table1=Column2;Table2=Column3"

すべてのテーブルのすべての擬似カラムを含めるには、次のようにします："*=*"

provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。

データ型

int

デフォルト値

60

解説

このプロパティは、Cloud が操作をキャンセルする前に操作の完了を待機する最大時間を秒単位で制御します。 操作の完了前にタイムアウト時間が経過すると、Cloud は操作をキャンセルして例外をスローします。

タイムアウトは、クエリや操作全体ではなくサーバーとの個々の通信に適用されます。 例えば、各ページング呼び出しがタイムアウト制限内に完了する場合、クエリは60秒を超えて実行を続けることができます。

このプロパティを0に設定するとタイムアウトが無効になり、操作が成功するか、サーバー側のタイムアウト、ネットワークの中断、またはサーバーのリソース制限などの他の条件で失敗するまで無期限に実行されます。 このプロパティは慎重に使用してください。長時間実行される操作がパフォーマンスを低下させたり、応答しなくなる可能性があるためです。

テーブルとカラムに簡略名を使用するかどうかを決定するboolean。

データ型

bool

デフォルト値

false

解説

Airtable テーブルおよびカラムでは、 通常のデータベースでは使うことが認められていない特殊記号・文字を名前に使うことができます。UseSimpleNames を使用すると、Cloud を従来のデータベースツールでより簡単に使用できるようになります。

UseSimpleNames をtrue に設定し、返されるテーブル名およびカラム名をシンプルにします。表示されるテーブル名 およびカラム名においてアルファベット文字およびアンダースコアのみを有効とするネーミングスキームを強制します。 英数字以外の文字はすべて、アンダースコアに変換されます。

Indicates what separator to use when pushing values of an array as a single string

データ型

string

デフォルト値

","

解説

The column value for elements that are an array of primitive values is by default a comma-separated string of the values when ArrayOutputFormat is set to DELIMITED. Changing this property changes the separator to the desired character.