はじめに

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

Sansan への接続

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

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

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

接続の確立

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

Sansan への接続

CData Cloud を使用してSansan に接続する場合は、APIKey が必要です。

Sansan へのアクセスの設定

APIKey を取得するには、以下の手順に従ってください。

Sansan 管理画面 [https://ap.sansan.com/v/home/] にログインして、［外部サービス連携］メニューの［API］に移動します。
［部署を選択してください］のプルダウンから、対象の部署を選択します。
［ユーザーを選択してください］のプルダウンから、対象のユーザーを選択します。
［発行］ボタンをクリックして、API キーを生成します。

Sansan アカウントの認証

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

APIKey：API キーを設定。Sansan 管理画面から取得したAPI Key です。

SSL の設定

SSL 設定のカスタマイズ

デフォルトでは、Cloud はサーバーの証明書をシステムの信頼できる証明書ストアと照合してSSL / TLS のネゴシエーションを試みます。

別の証明書を指定するには、利用可能なフォーマットについてSSLServerCert プロパティを参照してください。

ファイアウォールとプロキシ

Firewall またはProxy 経由の接続

HTTP プロキシ

Windows のシステムプロキシ経由の接続では、接続プロパティを追加で設定する必要はありません。他のプロキシに接続するには、ProxyAutoDetect をfalse に設定します。

さらにHTTP プロキシへの認証には、ProxyServer とProxyPort に加えてProxyAuthScheme、ProxyUser、およびProxyPassword を設定します。

その他のプロキシ

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

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

データモデル

CData Cloud は、Sansan オブジェクトをリレーショナルテーブルおよびビューとしてモデル化します。 Sansan オブジェクトは他のオブジェクトとリレーションを持ちます。テーブルでは、これらのリレーションは外部キーを使用して表されます。次のセクションでは、利用可能なAPI オブジェクトを示し、Sansan API へのSQL の実行について詳しく説明します。

ほとんどのデータベースオブジェクトのスキーマは、シンプルなテキストベースのコンフィギュレーションファイルで定義されます。

テーブル

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

CData Cloud - Sansan テーブル


Name	Description
Bizcards	Create and query all the Bizcards that the user has scanned or those that the organization has

Bizcards

Create and query all the Bizcards that the user has scanned or those that the organization has

テーブル固有の情報

Select

Cloud は Sansan API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。その他のフィルタはクライアント側でドライバー内部で処理されます。例えば、次のクエリはサーバー側で処理されます。

SELECT * FROM Bizcards WHERE UpdatedTime > '2018-03-14'

SELECT * FROM Bizcards WHERE UpdatedTime = '2018-03-14 18:35:06.0'

SELECT * FROM Bizcards WHERE UpdatedTime > '2018-03-14' AND UpdatedTime < '2019-03-14'

SELECT * FROM Bizcards WHERE Email = '[email protected]'

SELECT * FROM Bizcards ORDER BY UpdatedTime Desc

SELECT * FROM Bizcards ORDER BY RegisteredTime

SELECT * FROM Bizcards WHERE CONTAINS(CompanyName, 'kei') AND CONTAINS(Tel, '7390') AND CONTAINS(Mobile, '7415')

SELECT * FROM Bizcards WHERE SearchTerm = 'kei'

クエリ内で指定することでRange 接続プロパティをオーバーライドできます。例：

SELECT * FROM Bizcards WHERE Range = 'me'

Insert

INSERT INTO Bizcards ('OwnerId', 'FirstName', 'LastName', 'SharingPermissionsEmail') VALUES ('afd425d', 'John', 'Doe', true)

Columns


Name	Type	ReadOnly	Description
BizcardId [KEY]	String	True	The Id of the Bizcard
CompanyId	String	True	The Id of the Company
PersonId	String	True	The Id of the person
ExchangeDate	Date	False	The date when Bizcards were exchanged
RegisteredTime	Datetime	True	The datetime when the Bizcard was registered
UpdatedTime	Datetime	True	The datetime when the Bizcard was last updated
OwnerId	String	False	The Id of the owner
OwnerName	String	True	The name of the owner
OwnerEmail	String	True	The email of the owner
LastName	String	False	The last name found on Bizcard
FirstName	String	False	The first name found on Bizcard
LastNameReading	String	False
FirstNameReading	String	False
DepartmentName	String	False	The name of the department found on Bizcard
Title	String	False	The title found on Bizcard
Email	String	False	The email found on Bizcard
Mobile	String	False	The mobile number found on Bizcard
CompanyName	String	False	The company name found on Bizcard
CountryCode	String	False	The country code found on Bizcard
PostalCode	String	False	The postal code found on Bizcard
Address	String	True	The address found on Bizcard
Prefecture	String	False	The prefecture found on Bizcard
City	String	False	The city found on Bizcard
Street	String	False	The street found on Bizcard
Building	String	False	The building found on Bizcard
Tel	String	False	The telephone number found on Bizcard
SecondTel	String	False	The second telephone number found on Bizcard
Fax	String	False	The fax number found on Bizcard
Url	String	False	The url found on Bizcard
Memo	String	False	The memo found on Bizcard
EntryStatus	String	True	The status of the Bizcard {processing, completed, unreadable}
IsUserCreated	Boolean	True	Determines if the bizcard has been created by the user or not
HasUnrecognizedChar	Boolean	True	Determines if the bizcard has unrecognized char or not
TagId	String	False	The tag ID to be linked to the business card. This column is supported for Insert only.
SharingPermissionsCompanyInformation	Boolean	False	Company information public/private setting. This column is supported for Insert only.
SharingPermissionsName	Boolean	False	Name public/private setting. This column is supported for Insert only.
SharingPermissionsExchangeDate	Boolean	False	Exchange date public/private setting. This column is supported for Insert only.
SharingPermissionsContact	Boolean	False	Contact public/private setting. This column is supported for Insert only.
SharingPermissionsMobile	Boolean	False	Mobile public/private setting. This column is supported for Insert only.
SharingPermissionsEmail	Boolean	False	Email public/private setting. This column is supported for Insert only.
SharingPermissionsMemo	Boolean	False	Memo public/private setting. This column is supported for Insert only.
SharingPermissionsOthers	Boolean	False	Others public/private setting. This column is supported for Insert only.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。


Name	Type	Description
Range	String	Used to override the range connection property
SearchTerm	String	Search FirstName or LastName starting by criteria

ビュー

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

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

CData Cloud - Sansan ビュー


Name	Description
AcquireDepartment	This will acquire departments registered in Sansan
AcquireUser	This will acquire users registered in Sansan
BizcardTags	Join Table for Tags and Bizcards
Contacts	Get a Set of contacts. The contacts are ordered by update time.
ExternalAttendees	Usage information for the operation ExternalAttendees.rsd.
InternalAttendees	Usage information for the operation InternalAttendees.rsd.
Tags	Returns all tags created by user or organization tags

AcquireDepartment

This will acquire departments registered in Sansan

Columns


Name	Type	Description
TempId	String	This is the temporary identifier used when adding departments
DepartmentId	String	This is the department identifier
DepartmentName	String	This is the departments name
DepartmentNamePhonetic	String	If the departments name is not written alphabetically, you can enter the phonetic alphabetic reading of the name here
ParentDepartmentId	String	This is the identifier for a parent department
Order	Integer	This is the display order of the department
DeleteFlag	Integer	This is the flag used to delete departments

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。


Name	Type	Description
Delimiter	String	Separator in the CSV format response

AcquireUser

This will acquire users registered in Sansan

Columns


Name	Type	Description
TempId	String	This is the temporary identifier used when adding users
UserUuid	String	This is the identifier to uniquely identify a user in Sansan
DepartmentId	String	This is the identifier for the department that the user belongs to
UserId	String	This is the identifier for display that uniquely identifies a user in Sansan
UserName	String	This is the users name
AlternativeName	String	This can use be used for alternative names or foreign language names
Email	String	This is the users email address
SubEmail	String	This is the users sub-email address
EffectiveDateFrom	String	This is the date when Sansan usage started
Culture	Integer	This is the display language when using Sansan
MailFormat	Integer	This is the format for receiving emails
SamlNameId	String	This is the identifier for SAML authentication
UserType	Integer	This is the user type
CanUpdateData	Integer	This is the permission to update all data
DataDownloadPrivilege	Integer	This is the permission to download business cards and reports
EmailDeliveryPrivilege	Integer	This is the permission to use email delivery
SalesforceIntegrationPrivilege	Integer	This is the permission to link business card data with Salesforce
DealPrivilege	Integer	This is the permission to use Deal management
ApiIntegrationPrivilege	Integer	This is the permission to use API linking
UsageStatisticsPrivilege	Integer	This is the permission to check actual usage of Sansan
OrganizationTreeDownloadPrivilege	Integer	Input 1 to give this permission
DeleteFlag	Integer	This is the flag used to delete users

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。


Name	Type	Description
Delimiter	String	Separator in the CSV format response

BizcardTags

Join Table for Tags and Bizcards

テーブル固有の情報

Select

Cloud は Sansan API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。その他のフィルタはクライアント側でドライバー内部で処理されます。例えば、次のクエリはサーバー側で処理されます。

SELECT * FROM BizcardTags

クエリ内で指定することでRange 接続プロパティをオーバーライドできます。例：

SELECT * FROM BizcardTags WHERE Range = 'me'

Columns


Name	Type	Description
BizcardId [KEY]	String	The Id of the Bizcard
TagID [KEY]	String	The Id of the Tag

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。


Name	Type	Description
Range	String	Used to override the range connection property

Contacts

Get a Set of contacts. The contacts are ordered by update time.

テーブル固有の情報

Select

Cloud は Sansan API を使用して、以下のカラムと演算子で構築されたWHERE 句条件を処理します。その他のフィルタはクライアント側でドライバー内部で処理されます。例えば、次のクエリはサーバー側で処理されます。

SELECT * FROM Contacts WHERE UpdatedTime > '2018-03-14'

SELECT * FROM Contacts WHERE UpdatedTime = '2018-03-14 18:35:06.0'

SELECT * FROM Contacts WHERE UpdatedTime > '2018-03-14' AND UpdatedTime < '2019-03-14'

SELECT * FROM Contacts WHERE Type = 'Meeting'

SELECT * FROM Contacts WHERE Categories = 'category'

SELECT * FROM Contacts ORDER BY UpdatedTime Desc

SELECT * FROM Contacts ORDER BY RegisteredTime

クエリ内で指定することでRange 接続プロパティをオーバーライドできます。例：

SELECT * FROM Contacts WHERE Range = 'me'

Columns


Name	Type	Description
Id [KEY]	String	The identifier of teh contact.
RegisteredTime	Datetime	The datetime when the contact has been created.
UpdatedTime	Datetime	The datetime when the contact has been modified for the last time.
StartDate	Date
StartTime	Datetime
EndDate	Date
EndTime	Datetime
OwnerId	String	The identifier of the owner.
OwnerName	String	The name of the owner.
OwnerEmail	String	The email of the owner.
Type	String	The type of the contact.
Categories	String	The contact categories.
Title	String	The title of the contact.
Location	String	The location of the contact.
Memo	String	The memo of the contact.
ExternalAttendees	String	The external attendees associated with the contact.
InternalAttendees	String	The internal attendees associated with the contact.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。


Name	Type	Description
Range	String	Used to override the range connection property
Rows@Next	String	Identifier for the next page of results. Do not set this value manually.

ExternalAttendees

Usage information for the operation ExternalAttendees.rsd.

テーブル固有の情報

Select

すべてはドライバー内でクライアント側で実行されます。

Columns


Name	Type	Description
ContactId [KEY]	String	The identifier of the contact associated with the attendee.
Id [KEY]	String	The identifier of the attendee.
PersonId	String	The person identifier associated with the attendee.
CompanyName	String	The company where the attendee belongs to.
LastName	String	The last name of the attendee.
FirstName	String	The first name of the attendee.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。


Name	Type	Description
Range	String	Used to override the range connection property
Rows@Next	String	Identifier for the next page of results. Do not set this value manually.

InternalAttendees

Usage information for the operation InternalAttendees.rsd.

テーブル固有の情報

Select

すべてはドライバー内でクライアント側で実行されます。

Columns


Name	Type	Description
ContactId [KEY]	String	The identifier of the contact associated with the attendee.
Id [KEY]	String	The identifier of the attendee.
Name	String	The name of the attendee.
DepartmentName	String	The department where the attendee belongs to.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。


Name	Type	Description
Range	String	Used to override the range connection property
Rows@Next	String	Identifier for the next page of results. Do not set this value manually.

ストアドプロシージャ

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

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

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


Name	Description

システムテーブル

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

スキーマテーブル

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

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：バッチ処理または単一の更新に関する情報を返す。

sys_catalogs

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

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

SELECT * FROM sys_catalogs

Columns


Name	Type	Description
CatalogName	String	データベース名。

sys_schemas

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

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

          SELECT * FROM sys_schemas

Columns


Name	Type	Description
CatalogName	String	データベース名。
SchemaName	String	スキーマ名。

sys_tables

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

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

          SELECT * FROM sys_tables

Columns


Name	Type	Description
CatalogName	String	テーブルまたはビューを含むデータベース。
SchemaName	String	テーブルまたはビューを含むスキーマ。
TableName	String	テーブル名またはビュー名。
TableType	String	テーブルの種類（テーブルまたはビュー）。
Description	String	テーブルまたはビューの説明。
IsUpdateable	Boolean	テーブルが更新可能かどうか。

sys_tablecolumns

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

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

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

Columns


Name	Type	Description
CatalogName	String	テーブルまたはビューを含むデータベースの名前。
SchemaName	String	テーブルまたはビューを含むスキーマ。
TableName	String	カラムを含むテーブルまたはビューの名前。
ColumnName	String	カラム名。
DataTypeName	String	データ型の名前。
DataType	Int32	データ型を示す整数値。この値は、実行時に環境に基づいて決定されます。
Length	Int32	カラムのストレージサイズ。
DisplaySize	Int32	指定されたカラムの通常の最大幅（文字数）。
NumericPrecision	Int32	数値データの最大桁数。文字データおよび日時データの場合は、カラムの長さ（文字数）。
NumericScale	Int32	カラムのスケール（小数点以下の桁数）。
IsNullable	Boolean	カラムがNull を含められるかどうか。
Description	String	カラムの簡単な説明。
Ordinal	Int32	カラムのシーケンスナンバー。
IsAutoIncrement	String	カラムに固定増分値が割り当てられるかどうか。
IsGeneratedColumn	String	生成されたカラムであるかどうか。
IsHidden	Boolean	カラムが非表示かどうか。
IsArray	Boolean	カラムが配列かどうか。
IsReadOnly	Boolean	カラムが読み取り専用かどうか。
IsKey	Boolean	sys_tablecolumns から返されたフィールドがテーブルの主キーであるかどうか。

sys_procedures

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

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

          SELECT * FROM sys_procedures

Columns


Name	Type	Description
CatalogName	String	ストアドプロシージャを含むデータベース。
SchemaName	String	ストアドプロシージャを含むスキーマ。
ProcedureName	String	ストアドプロシージャの名前。
Description	String	ストアドプロシージャの説明。
ProcedureType	String	PROCEDURE やFUNCTION などのプロシージャのタイプ。

sys_procedureparameters

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

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

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

Columns


Name	Type	Description
CatalogName	String	ストアドプロシージャを含むデータベースの名前。
SchemaName	String	ストアドプロシージャを含むスキーマの名前。
ProcedureName	String	パラメータを含むストアドプロシージャの名前。
ColumnName	String	ストアドプロシージャパラメータの名前。
Direction	Int32	パラメータのタイプに対応する整数値：input (1)。input/output (2)、またはoutput(4)。input/output タイプパラメータは、入力パラメータと出力パラメータの両方になれます。
DataTypeName	String	データ型の名前。
DataType	Int32	データ型を示す整数値。この値は、実行時に環境に基づいて決定されます。
Length	Int32	文字データの場合は、許可される文字数。数値データの場合は、許可される桁数。
NumericPrecision	Int32	数値データの場合は最大精度。文字データおよび日時データの場合は、カラムの長さ（文字数）。
NumericScale	Int32	数値データの小数点以下の桁数。
IsNullable	Boolean	パラメータがNull を含められるかどうか。
IsRequired	Boolean	プロシージャの実行にパラメータが必要かどうか。
IsArray	Boolean	パラメータが配列かどうか。
Description	String	パラメータの説明。
Ordinal	Int32	パラメータのインデックス。

sys_keycolumns

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

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

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

Columns


Name	Type	Description
CatalogName	String	キーを含むデータベースの名前。
SchemaName	String	キーを含むスキーマの名前。
TableName	String	キーを含むテーブルの名前。
ColumnName	String	キーカラムの名前
IsKey	Boolean	カラムがTableName フィールドで参照されるテーブル内の主キーかどうか。
IsForeignKey	Boolean	カラムがTableName フィールドで参照される外部キーかどうか。
PrimaryKeyName	String	主キーの名前。
ForeignKeyName	String	外部キーの名前。
ReferencedCatalogName	String	主キーを含むデータベース。
ReferencedSchemaName	String	主キーを含むスキーマ。
ReferencedTableName	String	主キーを含むテーブル。
ReferencedColumnName	String	主キーのカラム名。

sys_foreignkeys

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

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

         SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'

カラム


名前	タイプ	説明
CatalogName	String	キーを含むデータベースの名前。
SchemaName	String	キーを含むスキーマの名前。
TableName	String	キーを含むテーブルの名前。
ColumnName	String	キーカラムの名前
PrimaryKeyName	String	主キーの名前。
ForeignKeyName	String	外部キーの名前。
ReferencedCatalogName	String	主キーを含むデータベース。
ReferencedSchemaName	String	主キーを含むスキーマ。
ReferencedTableName	String	主キーを含むテーブル。
ReferencedColumnName	String	主キーのカラム名。
ForeignKeyType	String	外部キーがインポート（他のテーブルを指す）キーかエクスポート（他のテーブルから参照される）キーかを指定します。

sys_primarykeys

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

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

         SELECT * FROM sys_primarykeys

Columns


Name	Type	Description
CatalogName	String	キーを含むデータベースの名前。
SchemaName	String	キーを含むスキーマの名前。
TableName	String	キーを含むテーブルの名前。
ColumnName	String	キーカラムの名前。
KeySeq	String	主キーのシーケンス番号。
KeyName	String	主キーの名前。

sys_indexes

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

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

          SELECT * FROM sys_indexes WHERE IsPrimary='false'

Columns


Name	Type	Description
CatalogName	String	インデックスを含むデータベースの名前。
SchemaName	String	インデックスを含むスキーマの名前。
TableName	String	インデックスを含むテーブルの名前。
IndexName	String	インデックス名。
ColumnName	String	インデックスに関連付けられたカラムの名前。
IsUnique	Boolean	インデックスが固有の場合はTrue。そうでない場合はFalse。
IsPrimary	Boolean	インデックスが主キーの場合はTrue。そうでない場合はFalse。
Type	Int16	インデックスタイプに対応する整数値：statistic (0)、clustered (1)、hashed (2)、またはother (3)。
SortOrder	String	並べ替え順序：A が昇順、D が降順。
OrdinalPosition	Int16	インデックスのカラムのシーケンスナンバー。

sys_connection_props

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

このテーブルをクエリする際は、config 接続文字列を使用する必要があります。

jdbc:cdata:sansan:config:

この接続文字列を使用すると、有効な接続がなくてもこのテーブルをクエリできます。

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

SELECT * FROM sys_connection_props WHERE Value <> ''

Columns


Name	Type	Description
Name	String	接続プロパティ名。
ShortDescription	String	簡単な説明。
Type	String	接続プロパティのデータ型。
Default	String	明示的に設定されていない場合のデフォルト値。
Values	String	可能な値のカンマ区切りリスト。別な値が指定されていると、検証エラーがスローされます。
Value	String	設定した値またはあらかじめ設定されたデフォルト。
Required	Boolean	プロパティが接続に必要かどうか。
Category	String	接続プロパティのカテゴリ。
IsSessionProperty	String	プロパティが、現在の接続に関する情報を保存するために使用されるセッションプロパティかどうか。
Sensitivity	String	プロパティの機密度。これは、プロパティがロギングおよび認証フォームで難読化されているかどうかを通知します。
PropertyName	String	キャメルケースの短縮形の接続プロパティ名。
Ordinal	Int32	パラメータのインデックス。
CatOrdinal	Int32	パラメータカテゴリのインデックス。
Hierarchy	String	このプロパティと一緒に設定する必要がある、関連のある依存プロパティを表示します。
Visible	Boolean	プロパティが接続UI に表示されるかどうかを通知します。
ETC	String	プロパティに関するその他のさまざまな情報。

sys_sqlinfo

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

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

データソースのSELECT 機能

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


名前	説明	有効な値
AGGREGATE_FUNCTIONS	サポートされている集計関数。	AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNT	COUNT 関数がサポートされているかどうか。	YES, NO
IDENTIFIER_QUOTE_OPEN_CHAR	識別子をエスケープするための開始文字。	[
IDENTIFIER_QUOTE_CLOSE_CHAR	識別子をエスケープするための終了文字。	]
SUPPORTED_OPERATORS	サポートされているSQL 演算子。	=, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR
GROUP_BY	GROUP BY がサポートされているかどうか。サポートされている場合、どのレベルでサポートされているか。	NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE
OJ_CAPABILITIES	サポートされている外部結合の種類。	NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS
OUTER_JOINS	外部結合がサポートされているかどうか。	YES, NO
SUBQUERIES	サブクエリがサポートされているかどうか。サポートされていれば、どのレベルでサポートされているか。	NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED
STRING_FUNCTIONS	サポートされている文字列関数。	LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE
NUMERIC_FUNCTIONS	サポートされている数値関数。	ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE
TIMEDATE_FUNCTIONS	サポートされている日付および時刻関数。	NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT
REPLICATION_SKIP_TABLES	レプリケーション中にスキップされたテーブルを示します。
REPLICATION_TIMECHECK_COLUMNS	レプリケーション中に更新判断のカラムとして使用するかどうかを、（指定された順に）チェックするカラムのリストを含む文字列の配列。
IDENTIFIER_PATTERN	識別子としてどの文字列が有効かを示す文字列値。
SUPPORT_TRANSACTION	プロバイダーが、コミットやロールバックなどのトランザクションをサポートしているかどうかを示します。	YES, NO
DIALECT	使用するSQL ダイアレクトを示します。
KEY_PROPERTIES	Uniform データベースを特定するプロパティを示します。
SUPPORTS_MULTIPLE_SCHEMAS	プロバイダー用に複数のスキームが存在するかどうかを示します。	YES, NO
SUPPORTS_MULTIPLE_CATALOGS	プロバイダー用に複数のカタログが存在するかどうかを示します。	YES, NO
DATASYNCVERSION	このドライバーにアクセスするために必要な、CData Sync のバージョン。	Standard, Starter, Professional, Enterprise
DATASYNCCATEGORY	このドライバーのCData Sync カテゴリ。	Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQL	API で提供されている以上の、追加SQL 機能がサポートされているかどうか。	TRUE, FALSE
SUPPORTS_BATCH_OPERATIONS	バッチ操作がサポートされているかどうか。	YES, NO
SQL_CAP	このドライバーでサポートされているすべてのSQL 機能。	SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX
PREFERRED_CACHE_OPTIONS	使用したいcacheOptions を指定する文字列値。
ENABLE_EF_ADVANCED_QUERY	ドライバーがEntity Framework の高度なクエリをサポートしているかどうかを示します。サポートしていなければ、クエリはクライアントサイドで処理されます。	YES, NO
PSEUDO_COLUMNS	利用可能な疑似カラムを示す文字列の配列。
MERGE_ALWAYS	値がtrue であれば、CData Sync 内でMerge Model が強制的に実行されます。	TRUE, FALSE
REPLICATION_MIN_DATE_QUERY	レプリケート開始日時を返すSELECT クエリ。
REPLICATION_MIN_FUNCTION	サーバーサイドでmin を実行するために使用する式名を、プロバイダーが指定できるようになります。
REPLICATION_START_DATE	レプリケート開始日を、プロバイダーが指定できるようになります。
REPLICATION_MAX_DATE_QUERY	レプリケート終了日時を返すSELECT クエリ。
REPLICATION_MAX_FUNCTION	サーバーサイドでmax を実行するために使用する式名を、プロバイダーが指定できるようになります。
IGNORE_INTERVALS_ON_INITIAL_REPLICATE	初回のレプリケートで、レプリケートをチャンクに分割しないテーブルのリスト。
CHECKCACHE_USE_PARENTID	CheckCache 構文を親キーカラムに対して実行するかどうかを示します。	TRUE, FALSE
CREATE_SCHEMA_PROCEDURES	スキーマファイルの生成に使用できる、ストアドプロシージャを示します。

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

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'

WHERE 句では、個々のテーブルの制限や要件が異なる場合がありますので注意してください。詳しくは、データモデルセクションを参照してください。

Columns


Name	Type	Description
NAME	String	SQL 構文のコンポーネント、またはサーバー上で処理できる機能。
VALUE	String	サポートされるSQL またはSQL 構文の詳細。

sys_identity

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

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

         SELECT * FROM sys_identity

Columns


Name	Type	Description
Id	String	データ変更処理から返された、データベース生成Id。
Batch	String	バッチの識別子。1 は単一処理。
Operation	String	バッチ内の処理の結果：INSERTED、UPDATED、またはDELETED。
Message	String	SUCCESS、またはバッチ内の更新が失敗した場合のエラーメッセージ。

接続文字列オプション

接続文字列プロパティは、接続を確立するために使用できるさまざまなオプションです。このセクションでは、本プロバイダーの接続文字列で設定できるオプションの一覧を示します。詳細については各リンクをクリックしてください。

Authentication

プロパティ	説明
APIKey	Sansan API キー。
IncludePastBizcards	IncludePastBizcards
Range	対象とする所有者の範囲。

SSL

プロパティ	説明
SSLServerCert	TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。

Logging

プロパティ	説明
Verbosity	ログファイルの記述をどの程度の詳細さで記載するかを決定するverbosity レベル。

Schema

プロパティ	説明
BrowsableSchemas	このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。

Miscellaneous

プロパティ	説明
MaxRows	クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。
Pagesize	Sansan から返されるページあたりの結果の最大数。
PseudoColumns	このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
Timeout	タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。

Authentication

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

プロパティ	説明
APIKey	Sansan API キー。
IncludePastBizcards	IncludePastBizcards
Range	対象とする所有者の範囲。

APIKey

Sansan API キー。

データ型

string

デフォルト値

""

解説

認証に使用されます。APIKey はアカウントの［設定］ページから取得できます。

IncludePastBizcards

データ型

bool

デフォルト値

false

解説

過去の名刺情報も含めて取得するかどうかを決定します。

Range

対象とする所有者の範囲。

データ型

string

デフォルト値

"all"

解説

Range 接続プロパティは、API からフェッチされるデータのスコープを決定します。 Range が"all" に設定されている場合、プロバイダーはユーザーが所属する組織のすべての名刺またはタグをフェッチします。 Range が"me" の場合は、自身の所有する名刺またはタグをフェッチします。クエリ中にこの接続プロパティをオーバーライドできます。例：

SELECT * FROM Bizcards WHERE Range='all'

SELECT * FROM Tags WHERE Range='me'

SSL

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

プロパティ	説明
SSLServerCert	TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。

SSLServerCert

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

データ型

string

デフォルト値

""

解説

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

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


説明	例
フルPEM 証明書（例では省略されています）	-----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
証明書を保有するローカルファイルへのパス。	C:\cert.cer
公開鍵（例では省略されています）	-----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
MD5 Thumbprint （hex 値はスペースおよびコロン区切り）	ecadbdda5a1529c58a1e9e09828d70e4
SHA1 Thumbprint （hex 値はスペースおよびコロン区切り）	34a929226ae0819f2ec14b4a3d904f801cbb150d

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

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

Logging

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

プロパティ	説明
Verbosity	ログファイルの記述をどの程度の詳細さで記載するかを決定するverbosity レベル。

Verbosity

ログファイルの記述をどの程度の詳細さで記載するかを決定するverbosity レベル。

データ型

string

デフォルト値

"1"

解説

Verbosity レベルは、Cloud がLogfile にどの程度の詳細さで記載するかを決定します。1 から5 までのVerbosity レベルがサポートされています。より詳しい説明は、ログページに記載されています。

Schema

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

プロパティ	説明
BrowsableSchemas	このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。

BrowsableSchemas

このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。

データ型

string

デフォルト値

""

解説

スキーマをデータベースからリストすると、負荷がかかる可能性があります。接続文字列でスキーマのリストを提供すると、パフォーマンスが向上します。

Miscellaneous

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

プロパティ	説明
MaxRows	クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。
Pagesize	Sansan から返されるページあたりの結果の最大数。
PseudoColumns	このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
Timeout	タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。

解説

Timeout が0に設定されている場合は、操作がタイムアウトしません。処理が正常に完了するか、エラー状態になるまで実行されます。

Timeout の有効期限が切れても処理が完了していない場合は、Cloud は例外をスローします。

Cloud

Sansan - CData Cloud

概要

主要機能

はじめに

Sansan への接続

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

接続の確立

Sansan への接続

Sansan へのアクセスの設定

Sansan アカウントの認証

SSL の設定

SSL 設定のカスタマイズ

ファイアウォールとプロキシ

Firewall またはProxy 経由の接続

HTTP プロキシ

その他のプロキシ

データモデル

テーブル

CData Cloud - Sansan テーブル

Bizcards

テーブル固有の情報

Select

Insert

Columns

Pseudo-Columns

ビュー

CData Cloud - Sansan ビュー

AcquireDepartment

Columns

Pseudo-Columns

AcquireUser

Columns

Pseudo-Columns

BizcardTags

テーブル固有の情報

Select

Columns

Pseudo-Columns

Contacts

テーブル固有の情報

Select

Columns

Pseudo-Columns

ExternalAttendees

テーブル固有の情報

Select

Columns

Pseudo-Columns

InternalAttendees

テーブル固有の情報

Select

Columns

Pseudo-Columns

Tags

テーブル固有の情報

Select

Columns

Pseudo-Columns

ストアドプロシージャ

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

システムテーブル

スキーマテーブル

データソーステーブル

クエリ情報テーブル

sys_catalogs

Columns

sys_schemas

Columns

sys_tables

Columns

sys_tablecolumns

Columns

sys_procedures

Columns

sys_procedureparameters

Columns

sys_keycolumns

Columns

sys_foreignkeys