Cloud

Build 25.0.9434
  • Bcart
    • はじめに
      • 接続の確立
      • カスタムOAuth アプリケーションの作成
      • SSL の設定
      • ファイアウォールとプロキシ
    • データモデル
      • テーブル
        • Bookmarks
        • Categories
        • Customers
        • Logistics
        • OrderProducts
        • Orders
        • OrderStatuses
        • OtherAddresses
        • Points
        • ProductFeatures
        • Products
        • ProductSets
        • ProductStock
      • ビュー
        • PriceGroups
        • ProductOptions
        • ShippingGroups
        • ViewGroups
      • ストアドプロシージャ
      • システムテーブル
        • sys_catalogs
        • sys_schemas
        • sys_tables
        • sys_tablecolumns
        • sys_procedures
        • sys_procedureparameters
        • sys_keycolumns
        • sys_foreignkeys
        • sys_primarykeys
        • sys_indexes
        • sys_connection_props
        • sys_sqlinfo
        • sys_identity
        • sys_information
    • 接続文字列オプション
      • Authentication
        • AuthScheme
        • PersonalAccessToken
      • OAuth
        • OAuthClientId
        • OAuthClientSecret
        • Scope
      • SSL
        • SSLServerCert
      • Logging
        • Verbosity
      • Schema
        • BrowsableSchemas
      • Miscellaneous
        • IncludeCustomFields
        • MaxRows
        • PseudoColumns
        • Timeout
        • UseDisplayNames
    • Third Party Copyrights

Bcart - CData Cloud

概要

CData Cloud は、クラウドホスト型のソリューションで、複数の標準サービスやプロトコルにまたがるBcart へのアクセスを実現します。SQL Server データベースに接続できるアプリケーションであれば、CData Cloud を介してBcart に接続できます。

CData Cloud により、他のOData エンドポイントや標準SQL Server と同じように、Bcart への接続を標準化し、構成することができます。

主要機能

  • SQL をフルサポート：Bcart は、標準のリレーショナルデータベースとして表示され、Filter、Group、Join などの操作を実行できます。これらの操作は基盤となるAPI でサポートされているかどうかに関わらず、標準SQL を使用します。
  • CRUD サポート：読み取りと書き込みの両方の操作がサポートされており、Cloud またはデータソースのダウンストリームで設定できるセキュリティ設定によってのみ制限されます。
  • セキュアアクセス：管理者は、ユーザーを作成し、特定のデータベースへのアクセス、読み取り専用操作、または完全な読み書きの権限を定義することができます。
  • 包括的なデータモデルとダイナミックディスカバリー：CData Cloud は、動的データや検索可能なメタデータへのフルアクセスなど、基盤となるデータソースで公開されるすべてのデータへの包括的なアクセスを提供します。

CData Cloud

はじめに

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

Bcart への接続

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

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

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

CData Cloud

接続の確立

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

Bcart への接続

パーソナルアクセストークン認証

Bcart ドライバーにはパーソナルアクセストークンが必要です。 Bcart API 管理ページにログイン後、「アプリケーション管理」画面のCreate New Token をクリックし、Name を入力して必要な権限を選択します。設定すると、パーソナルアクセストークンを取得できます。
PersonalAccessToken： 生成されたパーソナルアクセストークンを設定します。

OAuth 認証

この認証を有効にするには、カスタムOAuth アプリケーションを作成し、AuthScheme をOAuth に設定する必要があります。

以下のサブセクションでは、3つの一般的なOAuth 認証フローでのBcart への認証について詳しく説明します。

カスタムOAuth アプリケーションの作成については、カスタムOAuth アプリケーションの作成 を参照してください。 Bcart で利用可能な接続文字列プロパティの全リストは、Connection を参照してください。

OAuth アクセストークンの自動リフレッシュ：

Cloud がOAuth アクセストークンを自動的にリフレッシュするようにするには：

  1. はじめてデータに接続する前に、次の接続パラメータを設定します。
    • InitiateOAuth：REFRESH。
    • OAuthClientId：カスタムOAuth アプリケーション設定のクライアントId。
    • OAuthClientSecret：カスタムOAuth アプリケーション設定のクライアントシークレット。
    • OAuthAccessToken：GetOAuthAccessToken によって返されたアクセストークン。
    • OAuthSettingsLocation：Cloud がOAuth 値を保存する場所のパス。これは接続間で維持されます。
  2. その後のデータ接続では、以下を設定します。
    • InitiateOAuth
    • OAuthSettingsLocation

OAuth アクセストークンの手動リフレッシュ：

OAuth アクセストークンを手動でリフレッシュするために必要な唯一の値は、OAuth リフレッシュトークンです。

  1. ExpiresIn 期間（GetOAuthAccessToken が返す）が経過した後にOAuthAccessToken を手動でリフレッシュするには、RefreshOAuthAccessToken ストアドプロシージャを呼び出します。
  2. 次の接続プロパティを設定します。

    • OAuthClientId：カスタムOAuth アプリケーション設定のクライアントId。
    • OAuthClientSecret：カスタムOAuth アプリケーション設定のクライアントシークレット。

  3. RefreshOAuthAccessToken を呼び出し、OAuthRefreshToken にGetOAuthAccessToken によって返されたOAuth リフレッシュトークンを設定します。
  4. 新しいトークンが取得できたら、OAuthAccessToken プロパティにRefreshOAuthAccessToken によって返された値を設定します。これで新規接続が開かれます。

OAuth リフレッシュトークンを保存し、OAuth アクセストークンの有効期限が切れた後に手動でリフレッシュできるようにします。

CData Cloud

カスタムOAuth アプリケーションの作成

カスタムOAuth アプリケーションの作成

次の手順では、カスタムOAuth アプリケーションを作成し、アプリケーションのOAuth 値を取得する方法を説明します。

  1. Bcart Developer ポータルにログインします。
  2. アプリストア アプリ管理をクリックします。
  3. 作成をクリックします。
  4. 必要事項をすべて記入します。
  5. リダイレクトURL を指定します。
    • デスクトップアプリケーションを作成する場合は、Cloud のデフォルトであるhttp://localhost:33333 を入力します。あるいは、任意の別のポートを設定して、CallbackURL を正確なURL に設定します。
    • Web アプリケーションを作成する場合は、リダイレクトURL を、ユーザーがアプリケーションにアクセス許可を付与した後にアクセストークンを返すようにするWeb 上の場所に設定します。

変更を保存し、今後使用するために、クライアントId、クライアントシークレット、およびコールバックURL を控えておきます。

CData Cloud

SSL の設定

SSL 設定のカスタマイズ

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

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

CData Cloud

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

Firewall またはProxy 経由の接続

HTTP プロキシ

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

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

その他のプロキシ

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

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

CData Cloud

データモデル

概要

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

主要機能

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

テーブル

テーブル では、利用可能なテーブルを説明します。テーブルは、Customers、Orders、Products などを静的にモデル化するように定義されています。

ビュー

ビュー では、利用可能なビューを説明します。ビューは、PriceGroups、ProductOptions、ShippingGroups などを静的にモデル化するように定義されています。

CData Cloud

テーブル

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

CData Cloud - Bcart テーブル

Name Description
Bookmarks Usage information for the operation Bookmarks.rsd.
Categories Usage information for the operation Categories.rsd.
Customers Usage information for the operation Customers.rsd.
Logistics Usage information for the operation Logistics.rsd.
OrderProducts Usage information for the operation OrderProducts.rsd.
Orders Usage information for the operation Orders.rsd.
OrderStatuses Usage information for the operation OrderStatuses.rsd.
OtherAddresses Usage information for the operation OtherAddresses.rsd.
Points Usage information for the operation Points.rsd.
ProductFeatures Usage information for the operation ProductFeatures.rsd.
Products Usage information for the operation Products.rsd.
ProductSets Usage information for the operation ProductSets.rsd.
ProductStock Usage information for the operation ProductStock.rsd.

CData Cloud

Bookmarks

Bookmarks テーブルからデータを返します。

Select

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

  • ほとんどのカラムは次の演算子をサポートしています：<、>、<=、>=、=、!=、IN、NOT_IN。
例えば、次のクエリはサーバーサイドで処理されます。 
    SELECT * FROM Bookmarks WHERE Id = 12345
    SELECT * FROM Bookmarks WHERE CustomerId IN (1, 10)
    SELECT * FROM Bookmarks WHERE UpdatedAt <= '2019-09-26 09:20:45'

Insert

Bookmarks を追加するには、CustomerId、ProductId、および読み取り専用ではないカラムを指定します。 

    INSERT INTO Bookmarks (CustomerId, ProductId) VALUES (12345, 12345)

Bulk Insert


    INSERT INTO Bookmarks#TEMP (CustomerId, ProductId) VALUES (12345, 12345)
    INSERT INTO Bookmarks#TEMP (CustomerId, ProductId) VALUES (12345, 12345)
    INSERT INTO Bookmarks (CustomerId, ProductId) SELECT CustomerId, ProductId FROM Bookmarks#TEMP

Update

Bcart は、CustomerId、ProductId、および読み取り専用ではないカラムの更新を許可します。 

    UPDATE Bookmarks SET CustomerId = 12345 WHERE Id = 12345

Bulk Update


    INSERT INTO Bookmarks#TEMP (Id, CustomerId, ProductId) VALUES (1, 12345, 12345)
    INSERT INTO Bookmarks#TEMP (Id, CustomerId, ProductId) VALUES (2, 12345, 12345)
    UPDATE Bookmarks (Id, CustomerId, ProductId) SELECT Id, CustomerId, ProductId FROM Bookmarks#TEMP

Delete

Delete はこのテーブルではサポートされていません。

Columns

Name Type ReadOnly Description
Id [KEY] Integer True

CustomerId Integer False

ProductId Integer False

UpdatedAt Datetime False

CData Cloud

Categories

Categories テーブルからデータを返します。

Select

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

  • ほとんどのカラムは次の演算子をサポートしています：<、>、<=、>=、=、!=、IN、NOT_IN。
例えば、次のクエリはサーバーサイドで処理されます。 
    SELECT * FROM Categories WHERE Name = 'Sample Category'
    SELECT * FROM Categories WHERE Id IN (1, 10)
    SELECT * FROM Categories WHERE Priority <= 5

Insert

Categories を追加するには、Name および読み取り専用ではないカラムを指定します。 

    INSERT INTO Categories (Name) VALUES ('Sample Category')

Bulk Insert


    INSERT INTO Categories#TEMP (Name) VALUES ('Sample Category 1')
    INSERT INTO Categories#TEMP (Name) VALUES ('Sample Category 2')
    INSERT INTO Categories (Name) SELECT Name FROM Categories#TEMP

Update

Bcart は、Name、Description、および読み取り専用ではないカラムの更新を許可します。 

    UPDATE Categories SET Name = 'Sample Category' WHERE Id = 2

Bulk Update


    INSERT INTO Categories#TEMP (Id, Name) VALUES (1, 'Sample Category 1')
    INSERT INTO Categories#TEMP (Id, Name) VALUES (2, 'Sample Category 2')
    UPDATE Categories (Id, Name) SELECT Id, Name FROM Categories#TEMP

Delete

Delete はこのテーブルではサポートされていません。

Columns

Name Type ReadOnly Description
Id [KEY] Integer True

Name String False

Description String False

RvDescription String False

ParentCategoryId Integer False

HeaderImage String False

BannerImage String False

MenuImage String False

MetaTitle String False

MetaKeywords String False

MetaDescription String False

Priority Integer False

Flag Integer False

CData Cloud

Customers

Customers テーブルからデータを返します。

Select

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

  • ほとんどのカラムは次の演算子をサポートしています：<、>、<=、>=、=、!=、IN、NOT_IN。
  • カスタムフィールドカラムは次の演算子をサポートしています：=。
  • Password カラムはサーバーサイドの演算子をサポートしていません。
例えば、次のクエリはサーバーサイドで処理されます。 
    SELECT * FROM Customers WHERE CompName = 'Sample Company'
    SELECT * FROM Customers WHERE ParentId IN (1, 10)
    SELECT * FROM Customers WHERE UpdatedAt <= '2019-09-26 09:20:45'

Insert

Customers を追加するには、TantoLastName、Zip、Pref、Address1、Address2、Password 、および読み取り専用ではないカラムを指定します。 

    INSERT INTO Customers (TantoLastName, Zip, Pref, Address1, Address2, Password) VALUES ('Tanto', '123-4567', 'Miyagi', 'Sendai', 'CData', 'PASSWPRD')

Bulk Insert


    INSERT INTO Customers#TEMP (TantoLastName, Zip, Pref, Address1, Address2, Password) VALUES ('Tanto 1', '123-4567', 'Miyagi', 'Sendai', 'CData', 'PASSWPRD')
    INSERT INTO Customers#TEMP (TantoLastName, Zip, Pref, Address1, Address2, Password) VALUES ('Tanto 2', '123-4567', 'Miyagi', 'Sendai', 'CData', 'PASSWPRD')
    INSERT INTO Customers (Name, CategoryId) SELECT Name, CategoryId FROM Customers#TEMP

Update

Bcart は、TantoLastName、Zip、および読み取り専用ではないカラムの更新を許可します。 

    UPDATE Customers SET TantoLastName = 'Sample TantoLastName' WHERE Id = 2

Bulk Update


    INSERT INTO Customers#TEMP (Id, TantoLastName, Address1) VALUES (1, 'Sample TantoLastName 1', 'Sendai')
    INSERT INTO Customers#TEMP (Id, TantoLastName, Address1) VALUES (2, 'Sample TantoLastName 2', 'Sendai')
    UPDATE Customers (Id, TantoLastName, Address1) SELECT Id, TantoLastName, Address1 FROM Customers#TEMP

Delete

Delete はこのテーブルではサポートされていません。

Columns

Name Type ReadOnly Description
Id [KEY] Integer True

ExtId String False

AgentId String False

AgentRate String False

ParentId Integer False

DestinationCode String False

CompName String False

CompNameKana String False

CeoLastName String False

CeoFirstName String False

CeoLastNameKana String False

CeoFirstNameKana String False

Department String False

TantoLastName String False

TantoFirstName String False

TantoLastNameKana String False

TantoFirstNameKana String False

Zip String False

Pref String False

Address1 String False

Address2 String False

Address3 String False

Email String False

EmailCc String False

Tel String False

MobilePhone String False

Fax String False

Url String False

Foundation String False

Sales Integer False

Job String False

Memo String False

Payment String False

SpecialShippingCost String False

Paid String True

SpecialView Integer False

MmFlag Integer False

Point Integer False

PriceGroupId Integer False

ViewGroupId Integer False

SalesmanId String False

AfId String False

CutoffDate String False

PaymentMonth String False

PaymentDate String False

DefaultOtherShippingId Integer False

DefaultPayment String False

HiddenPrice Integer False

Status String False

Password String False

CreatedAt Datetime False

UpdatedAt Datetime False

CData Cloud

Logistics

Logistics テーブルからデータを返します。

Select

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

  • ほとんどのカラムは次の演算子をサポートしています：<、>、<=、>=、=、!=、IN、NOT_IN。
例えば、次のクエリはサーバーサイドで処理されます。 
    SELECT * FROM Logistics WHERE Name = 'Sample Product'
    SELECT * FROM Logistics WHERE ShippingGroupId IN (1, 10)
    SELECT * FROM Logistics WHERE ShipmentDate <= '2019-09-26 09:20:45'

Insert

Insert はこのテーブルではサポートされていません。

Update

Bcart は、ShipmentCode、DeliveryCode、および読み取り専用ではないカラムの更新を許可します。 

    UPDATE Logistics ShipmentCode = '123' WHERE Id = 20000001

Bulk Update


    INSERT INTO Logistics#TEMP (Id, ShipmentCode, Name) VALUES (20000001, 'Sample ShipmentCode 1', 'Sample Name 1')
    INSERT INTO Logistics#TEMP (Id, ShipmentCode, Name) VALUES (20000002, 'Sample ShipmentCode 2', 'Sample Name 2')
    UPDATE Logistics (Id, ShipmentCode, Name) SELECT Id, ShipmentCode, Name FROM Logistics#TEMP

Delete

Delete はこのテーブルではサポートされていません。

Columns

Name Type ReadOnly Description
Id [KEY] Integer True

ShipmentCode String False

DeliveryCode String False

DestinationCode String False

ShippingGroupId Integer False

CompName String False

Department String False

Name String False

Zip String False

Pref String False

Address1 String False

Address2 String False

Address3 String False

Tel String False

DueDate Date False

DueTime String False

Memo String False

ShipmentDate Date False

Status String False

CData Cloud

OrderProducts

OrderProducts テーブルからデータを返します。

Select

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

  • ほとんどのカラムは次の演算子をサポートしています：<、>、<=、>=、=、!=、IN、NOT_IN。
  • カスタムフィールドのカラムは次の演算子をサポートしています：=。
  • Options カラムはサーバーサイドの演算子をサポートしていません。
例えば、次のクエリはサーバーサイドで処理されます。 
    SELECT * FROM OrderProducts WHERE ProductName = 'Sample Order Product'
    SELECT * FROM OrderProducts WHERE OrderId IN (1, 10)
    SELECT * FROM OrderProducts WHERE ShippingSize <= 10

Insert

Insert はこのテーブルではサポートされていません。

Update

Bcart は、ProductName、MainNo、および読み取り専用ではないカラムの更新を許可します。 

    UPDATE OrderProducts SET ProductName = 'Sample Order Product' WHERE Id = 2

Bulk Update


    INSERT INTO OrderProducts#TEMP (Id, ProductName, MainNo) VALUES (1, 'Sample Order Product 1', '1')
    INSERT INTO OrderProducts#TEMP (Id, ProductName, MainNo) VALUES (2, 'Sample Order Product 2', '2')
    UPDATE OrderProducts (Id, ProductName, MainNo) SELECT Id, ProductName, MainNo FROM OrderProducts#TEMP

Delete

Delete はこのテーブルではサポートされていません。

Columns

Name Type ReadOnly Description
Id [KEY] Integer True

OrderId Integer False

LogisticsId Integer False

ProductId Integer False

MainNo String False

ProductNo String False

JanCode String False

LocationNo String False

ProductName String False

ProductSetId Integer False

SetName String False

UnitPrice Decimal True

SetQuantity Integer True

SetUnit String False

OrderProCount Integer True

ShippingSize Integer False

TaxRate String True

TaxTypeId Integer True

TaxIncl Integer True

ItemType String True

Options String True

CData Cloud

Orders

Orders テーブルからデータを返します。

Select

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

  • ほとんどのカラムは次の演算子をサポートしています：<、>、<=、>=、=、!=、IN、NOT_IN。
  • カスタムフィールドのカラムは次の演算子をサポートしています：=。
例えば、次のクエリはサーバーサイドで処理されます。 
    SELECT * FROM Orders WHERE CustomerCompName = 'Sample Customer'
    SELECT * FROM Orders WHERE Id IN (1, 10)
    SELECT * FROM Orders WHERE OrderedAt <= '2019-09-26 09:20:45'

Insert

Insert はこのテーブルではサポートされていません。

Update

Bcart は、CustomerCompName、Memo、および読み取り専用ではないカラムの更新を許可します。 

    UPDATE Orders SET CustomerCompName = 'Sample Customer' WHERE Id = 2

Bulk Update


    INSERT INTO Orders#TEMP (Id, CustomerCompName, Memo) VALUES (1, 'Sample Customer 1', 'Sample Memo')
    INSERT INTO Orders#TEMP (Id, CustomerCompName, Memo) VALUES (2, 'Sample Customer 2', 'Sample Memo')
    UPDATE Orders (Id, CustomerCompName, Memo) SELECT Id, CustomerCompName, Memo FROM Orders#TEMP

Delete

Delete はこのテーブルではサポートされていません。

Columns

Name Type ReadOnly Description
Id [KEY] Integer True

Code String True

CustomerId Integer False

CustomerExtId String False

CustomerParentId Integer False

CustomerSalesmanId String False

CustomerCompName String False

CustomerDepartment String False

CustomerName String False

CustomerTel String False

CustomerMobilePhone String False

CustomerEmail String False

CustomerPriceGroupId String False

CustomerZip String False

CustomerPref String False

CustomerAddress1 String False

CustomerAddress2 String False

CustomerAddress3 String False

Payment String False

PaymentAt Date False

TotalPrice Decimal True

Tax Decimal True

TaxRate String True

CODCost Decimal True

ShippingCost Decimal True

FinalPrice Decimal True

UsePoint Integer True

GetPoint Integer True

OrderTotals String True

CustomerMessage String False

AdminMessage String False

Memo String False

Enquete1 String False

Enquete2 String False

Enquete3 String False

Enquete4 String False

Enquete5 String False

OrderedAt Datetime True

AffiliateId String True

EstimateId String False

Status String False

Pseudo-Columns

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

Name Type Description
QualifiedInvoice Integer

CData Cloud

OrderStatuses

OrderStatuses テーブルからデータを返します。

Select

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

  • ほとんどのカラムは次の演算子をサポートしています：<、>、<=、>=、=、!=、IN、NOT_IN。
例えば、次のクエリはサーバーサイドで処理されます。 
    SELECT * FROM OrderStatuses WHERE Label = 'Sample Product'
    SELECT * FROM OrderStatuses WHERE Id IN (1, 10)
    SELECT * FROM OrderStatuses WHERE SystemDefined <= 5

Insert

OrderStatuses を追加するには、Label カラムを指定します。 

    INSERT INTO OrderStatuses (Label) VALUES ('Sample Label')

Bulk Insert


    INSERT INTO OrderStatuses#TEMP (Label) VALUES ('Sample Label 1')
    INSERT INTO OrderStatuses#TEMP (Label) VALUES ('Sample Label 2')
    INSERT INTO OrderStatuses (Label) SELECT Label FROM OrderStatuses#TEMP

Update

Bcart は、Label カラムの更新を許可します。 

    UPDATE OrderStatuses SET Label = 'Sample Label' WHERE Id = 2

Bulk Update


    INSERT INTO OrderStatuses#TEMP (Id, Label) VALUES (1, 'Sample Label 1')
    INSERT INTO OrderStatuses#TEMP (Id, Label) VALUES (2, 'Sample Label 2')
    UPDATE OrderStatuses (Id, Label) SELECT Id, Label FROM OrderStatuses#TEMP

Delete

Delete はこのテーブルではサポートされていません。

Columns

Name Type ReadOnly Description
Id [KEY] String True

Label String False

SystemDefined Integer True

CData Cloud

OtherAddresses

OtherAddresses テーブルからデータを返します。

Select

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

  • ほとんどのカラムは次の演算子をサポートしています：<、>、<=、>=、=、!=、IN、NOT_IN。
例えば、次のクエリはサーバーサイドで処理されます。 
    SELECT * FROM OtherAddresses WHERE Name = 'Sample Addresses'
    SELECT * FROM OtherAddresses WHERE Id IN (1, 10)
    SELECT * FROM OtherAddresses WHERE CustomerId <= 5

Insert

OtherAddresses を追加するには、Name、CustomerId、および読み取り専用ではないカラムを指定します。 

    INSERT INTO OtherAddresses (Name, Zip, Pref, Address1, Address2, CustomerId) VALUES ('Sample Address', '123-4567', 'Miyagi', 'Sendai', 'CData', 9999)

Bulk Insert


    INSERT INTO OtherAddresses#TEMP (Name, Zip, Pref, Address1, Address2, CustomerId) VALUES ('Sample Address 1', '123-4567', 'Miyagi', 'Sendai', 'CData', 9999)
    INSERT INTO OtherAddresses#TEMP (Name, Zip, Pref, Address1, Address2, CustomerId) VALUES ('Sample Address 2', '123-4567', 'Miyagi', 'Sendai', 'CData', 9999)
    INSERT INTO OtherAddresses (Name, Zip, Pref, Address1, Address2, CustomerId) SELECT Name, Zip, Pref, Address1, Address2, CustomerId FROM OtherAddresses#TEMP

Update

Bcart は、Name、Zip、および読み取り専用ではないカラムの更新を許可します。 

    UPDATE OtherAddresses SET Name = 'Sample Address' WHERE Id = 2

Bulk Update


    INSERT INTO OtherAddresses#TEMP (Id, Name) VALUES (1, 'Sample Address 1')
    INSERT INTO OtherAddresses#TEMP (Id, Name) VALUES (2, 'Sample Address 2')
    UPDATE OtherAddresses (Id, Name) SELECT Id, Name FROM OtherAddresses#TEMP

Delete

Delete はこのテーブルではサポートされていません。

Columns

Name Type ReadOnly Description
Id [KEY] Integer True

CustomerId Integer False

DestinationCode String False

CompName String False

Department String False

Name String False

Zip String False

Pref String False

Address1 String False

Address2 String False

Address3 String False

Tel String False

CData Cloud

Points

Points テーブルからデータを返します。

Select

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

  • ほとんどのカラムは次の演算子をサポートしています：<、>、<=、>=、=、!=、IN、NOT_IN。
例えば、次のクエリはサーバーサイドで処理されます。 
    SELECT * FROM Points WHERE Status = 'Sample Status'
    SELECT * FROM Points WHERE Id IN (1, 10)
    SELECT * FROM Points WHERE UpdatedAt <= '2019-09-26 09:20:45'

Insert

Points を追加するには、CustomerId、Point、Status、および読み取り専用ではないカラムを指定します。 

    INSERT INTO Points (CustomerId, Point, Status) VALUES (12345, 10, 'Sample Status')

Bulk Insert


    INSERT INTO Points#TEMP (CustomerId, Point, Status) VALUES (12345, 10, 'Sample Status')
    INSERT INTO Points#TEMP (CustomerId, Point, Status) VALUES (12346, 10, 'Sample Status')
    INSERT INTO Points (CustomerId, Point, Status) SELECT CustomerId, Point, Status FROM Points#TEMP

Update

Bcart は、CustomerId、Point、および読み取り専用ではないカラムの更新を許可します。 

    UPDATE Points SET Point = 10 WHERE Id = 2

Bulk Update


    INSERT INTO Points#TEMP (Id, Point) VALUES (1, 10)
    INSERT INTO Points#TEMP (Id, Point) VALUES (2, 20)
    UPDATE Points (Id, Point) SELECT Id, Point FROM Points#TEMP

Delete

Delete はこのテーブルではサポートされていません。

Columns

Name Type ReadOnly Description
Id [KEY] Integer True

CustomerId Integer False

OrderId Integer False

SubjectId Integer False

Point Integer False

Status String False

ActivatedAt Datetime False

CreatedAt Datetime False

UpdatedAt Datetime False

CData Cloud

ProductFeatures

ProductFeatures テーブルからデータを返します。

Select

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

  • ほとんどのカラムは次の演算子をサポートしています：<、>、<=、>=、=、!=、IN、NOT_IN。
例えば、次のクエリはサーバーサイドで処理されます。 
    SELECT * FROM ProductFeatures WHERE Name = 'Sample ProductFeatures'
    SELECT * FROM ProductFeatures WHERE Id IN (1, 10)
    SELECT * FROM ProductFeatures WHERE Priority <= 5

Insert

ProductFeatures を追加するには、Name、Description、および読み取り専用ではないカラムを指定します。 

    INSERT INTO ProductFeatures (Name, Description) VALUES ('Sample Product Features', 'Description')

Bulk Insert


    INSERT INTO ProductFeatures#TEMP (Name, Description) VALUES ('Sample Product Features 1', 'Sample Description')
    INSERT INTO ProductFeatures#TEMP (Name, Description) VALUES ('Sample Product Features 2', 'Sample Description')
    INSERT INTO ProductFeatures (Name, Description) SELECT Name, Description FROM ProductFeatures#TEMP

Update

Bcart は、Name、Description、および読み取り専用ではないカラムの更新を許可します。 

    UPDATE ProductFeatures SET Name = 'Sample Product Features' WHERE Id = 2

Bulk Update


    INSERT INTO ProductFeatures#TEMP (Id, Name, Description) VALUES (1, 'Sample Product Features 1', 'Sample Description')
    INSERT INTO ProductFeatures#TEMP (Id, Name, Description) VALUES (2, 'Sample Product Features 2', 'Sample Description')
    UPDATE ProductFeatures (Id, Name, Description) SELECT Id, Name, Description FROM ProductFeatures#TEMP

Delete

Delete はこのテーブルではサポートされていません。

Columns

Name Type ReadOnly Description
Id [KEY] Integer True

Name String False

RvDescription String False

Description String False

HeaderImage String False

BannerImage String False

MenuImage String False

MetaTitle String False

MetaKeywords String False

MetaDescription String False

Priority Integer False

Flag Integer False

CData Cloud

Products

Products テーブルからデータを返します。

Select

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

  • ほとんどのカラムは次の演算子をサポートしています：<、>、<=、>=、=、!=、IN、NOT_IN。
  • カスタムフィールドのカラムは次の演算子をサポートしています：=。
  • SubImages1Image、SubImages1Caption、および各SubImages 数値カラムはサーバーサイドの演算子をサポートしていません。
例えば、次のクエリはサーバーサイドで処理されます。 
    SELECT * FROM Products WHERE Name = 'Sample Product'
    SELECT * FROM Products WHERE Id IN (1, 10)
    SELECT * FROM Products WHERE UpdatedAt <= '2019-09-26 09:20:45'

Insert

Products を追加するには、Name、CategoryId、および読み取り専用ではないカラムを指定します。 

    INSERT INTO Products (Name, CategoryId) VALUES ('Sample Product', 2)

Bulk Insert


    INSERT INTO Products#TEMP (Name, CategoryId) VALUES ('Sample Product 1', 2)
    INSERT INTO Products#TEMP (Name, CategoryId) VALUES ('Sample Product 2', 2)
    INSERT INTO Products (Name, CategoryId) SELECT Name, CategoryId FROM Products#TEMP

Update

Bcart は、Name、CategoryId、および読み取り専用ではないカラムの更新を許可します。 

    UPDATE Products SET Name = 'Sample Product' WHERE Id = 2

Bulk Update


    INSERT INTO Products#TEMP (Id, Name, CategoryId) VALUES (1, 'Sample Product 1', 2)
    INSERT INTO Products#TEMP (Id, Name, CategoryId) VALUES (2, 'Sample Product 2', 2)
    UPDATE Products (Id, Name, CategoryId) SELECT Id, Name, CategoryId FROM Products#TEMP

Delete

Delete はこのテーブルではサポートされていません。

Columns

Name Type ReadOnly Description
Id [KEY] Integer True

MainNo String False

Name String False

CatchCopy String False

CategoryId Integer False

SubCategoryId String False

FeatureId1 Integer False

FeatureId2 Integer False

FeatureId3 Integer False

MadeIn String False

Size String False

Sozai String False

Caution String False

Tag String False

Description String False

MetaTitle String False

MetaKeywords String False

MetaDescription String False

Image String False

ViewGroupFilter String False

VisibleCustomerId String False

PrependText String False

AppendText String False

MiddleText String False

RvPrependText String False

RvAppendText String False

RvMiddleText String False

FileDownload String False

HanbaiStart Datetime False

HanbaiEnd Datetime False

RecommendProductId String False

ViewPattern Integer False

Priority Integer False

Flag String False

UpdatedAt Datetime False

SubImages1Image String False

SubImages1Caption String False

SubImages2Image String False

SubImages2Caption String False

SubImages3Image String False

SubImages3Caption String False

SubImages4Image String False

SubImages4Caption String False

SubImages5Image String False

SubImages5Caption String False

SubImages6Image String False

SubImages6Caption String False

CData Cloud

ProductSets

ProductSets テーブルからデータを返します。

Select

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

  • ほとんどのカラムは次の演算子をサポートしています：<、>、<=、>=、=、!=、IN、NOT_IN。
  • カスタムフィールドのカラムは次の演算子をサポートしています：=。
  • GroupPrice1Name、GroupPrice1Rate、および各GroupPrice 数値カラムはサーバーサイドの演算子をサポートしていません。
例えば、次のクエリはサーバーサイドで処理されます。 
    SELECT * FROM ProductSets WHERE Name = 'Sample ProductSets'
    SELECT * FROM ProductSets WHERE Id IN (1, 10)
    SELECT * FROM ProductSets WHERE UpdatedAt <= '2019-09-26 09:20:45'

Insert

ProductSets を追加するには、Name、ProductId、UnitPrice、および読み取り専用ではないカラムを指定します。 

    INSERT INTO ProductSets (Name, ProductId, UnitPrice) VALUES ('Sample Product Set', 2, 1000)

Bulk Insert


    INSERT INTO ProductSets#TEMP (Name, ProductId, UnitPrice) VALUES ('Sample Product Set 1', 2, 1000)
    INSERT INTO ProductSets#TEMP (Name, ProductId, UnitPrice) VALUES ('Sample Product Set 2', 2, 1000)
    INSERT INTO ProductSets (Name, ProductId, UnitPrice) SELECT Name, ProductId, UnitPrice FROM ProductSets#TEMP

Update

Bcart は、Name、ProductId、UnitPrice、および読み取り専用ではないカラムの更新を許可します。 

    UPDATE ProductSets SET Name = 'Sample Product Set' WHERE Id = 2

Bulk Update


    INSERT INTO ProductSets#TEMP (Id, Name, UnitPrice) VALUES (1, 'Sample Product Set 1', 2000)
    INSERT INTO ProductSets#TEMP (Id, Name, UnitPrice) VALUES (2, 'Sample Product Set 2', 3000)
    UPDATE ProductSets (Id, Name, UnitPrice) SELECT Id, Name, UnitPrice FROM ProductSets#TEMP

Delete

Delete はこのテーブルではサポートされていません。

Columns

Name Type ReadOnly Description
Id [KEY] Integer True

ProductId Integer False

ProductNo String False

JanCode String False

LocationNo String False

JodaiType String False

Jodai Integer False

Name String False

UnitPrice Decimal False

MinOrder Integer False

MaxOrder Integer False

GroupPrice1Name String False

GroupPrice1Rate String False

GroupPrice1UnitPrice Decimal False

GroupPrice1FixedPrice Decimal False

GroupPrice1VolumeDiscount String False

GroupPrice2Name String False

GroupPrice2Rate String False

GroupPrice2UnitPrice Decimal False

GroupPrice2FixedPrice Decimal False

GroupPrice2VolumeDiscount String False

GroupPrice3Name String False

GroupPrice3Rate String False

GroupPrice3UnitPrice Decimal False

GroupPrice3FixedPrice Decimal False

GroupPrice3VolumeDiscount String False

GroupPrice4Name String False

GroupPrice4Rate String False

GroupPrice4UnitPrice Decimal False

GroupPrice4FixedPrice Decimal False

GroupPrice4VolumeDiscount String False

GroupPrice5Name String False

GroupPrice5Rate String False

GroupPrice5UnitPrice Decimal False

GroupPrice5FixedPrice Decimal False

GroupPrice5VolumeDiscount String False

GroupPrice6Name String False

GroupPrice6Rate String False

GroupPrice6UnitPrice Decimal False

GroupPrice6FixedPrice Decimal False

GroupPrice6VolumeDiscount String False

GroupPrice7Name String False

GroupPrice7Rate String False

GroupPrice7UnitPrice Decimal False

GroupPrice7FixedPrice Decimal False

GroupPrice7VolumeDiscount String False

GroupPrice8Name String False

GroupPrice8Rate String False

GroupPrice8UnitPrice Decimal False

GroupPrice8FixedPrice Decimal False

GroupPrice8VolumeDiscount String False

GroupPrice9Name String False

GroupPrice9Rate String False

GroupPrice9UnitPrice Decimal False

GroupPrice9FixedPrice Decimal False

GroupPrice9VolumeDiscount String False

GroupPrice10Name String False

GroupPrice10Rate String False

GroupPrice10UnitPrice Decimal False

GroupPrice10FixedPrice Decimal False

GroupPrice10VolumeDiscount String False

GroupPriceNName String False

GroupPriceNRate String False

GroupPriceNUnitPrice Decimal False

GroupPriceNFixedPrice Decimal False

GroupPriceNVolumeDiscount String False

SpecialPrice String False

VolumeDiscount String False

Quantity Integer False

Unit String False

Description String False

Stock Integer False

StockFlag Integer False

StockParent String False

StockViewId Integer False

StockFew Integer False

ViewGroupFilter String False

VisibleCustomerId String False

OptionIds String False

ShippingGroupId Integer False

ShippingSize Integer False

Priority Integer False

SetFlag String False

TaxTypeId Integer False

UpdatedAt Datetime False

CData Cloud

ProductStock

ProductStock テーブルからデータを返します。

Select

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

  • ほとんどのカラムは次の演算子をサポートしています：<、>、<=、>=、=、!=、IN、NOT_IN。
例えば、次のクエリはサーバーサイドで処理されます。 
    SELECT * FROM ProductStock WHERE Name = 'Sample Stock'
    SELECT * FROM ProductStock WHERE Id IN (1, 10)
    SELECT * FROM ProductStock WHERE Stock <= 10

Insert

Insert はこのテーブルではサポートされていません。

Update

Bcart は、Stock、StockFlag、および読み取り専用ではないカラムの更新を許可します。 

    UPDATE ProductStock SET Stock = 15 WHERE ProductNo = 2

相対値で在庫数を更新する必要がある場合は、StockRelativeUpdateValue で相対値を指定します。

次のクエリは、在庫数を2つ減らすものです。 

    UPDATE ProductStock SET StockRelativeUpdateValue = -1 WHERE ProductNo = 2

Bulk Update


    INSERT INTO ProductStock#TEMP (ProductNo, Stock) VALUES ('A001', 2)
    INSERT INTO ProductStock#TEMP (ProductNo, Stock) VALUES ('A002', 3)
    UPDATE ProductStock (ProductNo, Stock) SELECT ProductNo, Stock FROM ProductStock#TEMP

Delete

Delete はこのテーブルではサポートされていません。

Columns

Name Type ReadOnly Description
Id Integer True

ProductId Integer True

ProductNo [KEY] String True

Name String True

Stock Integer False

StockFlag Integer False

StockParent String False

Pseudo-Columns

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

Name Type Description
StockRelativeUpdateValue String

CData Cloud

ビュー

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

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

CData Cloud - Bcart ビュー

Name Description
PriceGroups Usage information for the operation PriceGroups.rsd.
ProductOptions Usage information for the operation ProductOptions.rsd.
ShippingGroups Usage information for the operation ShippingGroups.rsd.
ViewGroups Usage information for the operation ViewGroups.rsd.

CData Cloud

PriceGroups

PriceGroups テーブルからデータを返します。

Select

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

  • ほとんどのカラムは次の演算子をサポートしています：<、>、<=、>=、=、!=、IN、NOT_IN。
例えば、次のクエリはサーバーサイドで処理されます。 
    SELECT * FROM PriceGroups WHERE Name = 'Sample PriceGroups'
    SELECT * FROM PriceGroups WHERE Id IN (1, 10)
    SELECT * FROM PriceGroups WHERE Id <= '10'

Columns

Name Type Description
Id [KEY] String
Name String
Rate String

CData Cloud

ProductOptions

ProductOptions テーブルからデータを返します。

Select

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

  • ほとんどのカラムは次の演算子をサポートしています：<、>、<=、>=、=、!=、IN、NOT_IN。
  • カスタムフィールドのカラムは次の演算子をサポートしています：=。
  • nputRulesType、InputRulesLimitType、InputRulesLimitMin、およびInputRulesLimitMax カラムはサーバーサイドの演算子をサポートしていません。
例えば、次のクエリはサーバーサイドで処理されます。 
    SELECT * FROM ProductOptions WHERE Name = 'Sample ProductOptions'
    SELECT * FROM ProductOptions WHERE Id IN (1, 10)
    SELECT * FROM ProductOptions WHERE UpdatedAt <= '2019-09-26 09:20:45'

Columns

Name Type Description
Id [KEY] Integer
Name String
IsActive Integer
InputType String
InputChoices String
InputRulesType String
InputRulesLimitType String
InputRulesLimitMin String
InputRulesLimitMax String
Unit String
IsDescriptionHtml Integer
Description String
Required Boolean
SortPriority Integer
CreatedAt Datetime
UpdatedAt Datetime

CData Cloud

ShippingGroups

ShippingGroups テーブルからデータを返します。

Select

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

  • ほとんどのカラムは次の演算子をサポートしています：<、>、<=、>=、=、!=、IN、NOT_IN。
  • CodCost、DueHour、およびCost カラムはサーバーサイドの演算子をサポートしていません。
例えば、次のクエリはサーバーサイドで処理されます。 
    SELECT * FROM ShippingGroups WHERE Name = 'Sample ShippingGroups'
    SELECT * FROM ShippingGroups WHERE Id IN (1, 10)
    SELECT * FROM ShippingGroups WHERE CostFreePrice <= 10

Columns

Name Type Description
Id [KEY] Integer
Name String
Description String
Company Integer
ShippingOtherFlag String
CodCost String
CodCostMaxPrice String
CodCostMaxCost String
CodFlag Integer
TaxIncluded Integer
TaxRounding String
TaxCodIncluded Integer
TaxCodRounding String
DueDateFlag Integer
DueDateStartDay String
DueDateIncrement String
DueDateCarryoverHourFlag Integer
DueDateCarryoverHour String
DueDateCarryoverHolidayFlag Integer
DueDateDescription String
DueHourFlag Integer
DueHour String
DueHourDescription String
OtherFlag Integer
CodeUrl String
CostFreeFlag Integer
CostFreePrice Decimal
Cost String
CostText String

CData Cloud

ViewGroups

ViewGroups テーブルからデータを返します。

Select

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

  • ほとんどのカラムは次の演算子をサポートしています：<、>、<=、>=、=、!=、IN、NOT_IN。
例えば、次のクエリはサーバーサイドで処理されます。 
    SELECT * FROM ViewGroups WHERE Name = 'Sample ViewGroups'
    SELECT * FROM ViewGroups WHERE Id IN (1, 10)
    SELECT * FROM ViewGroups WHERE Id <= 10

Columns

Name Type Description
Id [KEY] Integer
Name String

CData Cloud

ストアドプロシージャ

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

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

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

CData Cloud

システムテーブル

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

スキーマテーブル

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

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

CData Cloud

sys_catalogs

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

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

SELECT * FROM sys_catalogs

Columns

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

CData Cloud

sys_schemas

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

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

          SELECT * FROM sys_schemas

Columns

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

CData Cloud

sys_tables

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

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

          SELECT * FROM sys_tables

Columns

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

CData Cloud

sys_tablecolumns

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

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

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

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 から返されたフィールドがテーブルの主キーであるかどうか。
ColumnType String スキーマ内のカラムの役割または分類。可能な値は、SYSTEM、LINKEDCOLUMN、NAVIGATIONKEY、REFERENCECOLUMN、およびNAVIGATIONPARENTCOLUMN が含まれます。

CData Cloud

sys_procedures

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

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

          SELECT * FROM sys_procedures

Columns

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

CData Cloud

sys_procedureparameters

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

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

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

パラメータに加えて結果セットのカラムを含めるには、IncludeResultColumns 擬似カラムをTrue に設定します。 

SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'SelectEntries' AND IncludeResultColumns='True'

Columns

Name Type Description
CatalogName String ストアドプロシージャを含むデータベースの名前。
SchemaName String ストアドプロシージャを含むスキーマの名前。
ProcedureName String パラメータを含むストアドプロシージャの名前。
ColumnName String ストアドプロシージャパラメータの名前。
Direction Int32 パラメータのタイプに対応する整数値：input (1)。input/output (2)、またはoutput(4)。input/output タイプパラメータは、入力パラメータと出力パラメータの両方になれます。
DataType Int32 データ型を示す整数値。この値は、実行時に環境に基づいて決定されます。
DataTypeName String データ型の名前。
NumericPrecision Int32 数値データの場合は最大精度。文字データおよび日時データの場合は、カラムの長さ（文字数）。
Length Int32 文字データの場合は、許可される文字数。数値データの場合は、許可される桁数。
NumericScale Int32 数値データの小数点以下の桁数。
IsNullable Boolean パラメータがNull を含められるかどうか。
IsRequired Boolean プロシージャの実行にパラメータが必要かどうか。
IsArray Boolean パラメータが配列かどうか。
Description String パラメータの説明。
Ordinal Int32 パラメータのインデックス。
Values String このパラメータで設定できる値は、このカラムに表示されるものに限られます。指定できる値はカンマ区切りです。
SupportsStreams Boolean パラメータがファイルを表すかどうか。ファイルは、ファイルパスとして渡すことも、ストリームとして渡すこともできます。
IsPath Boolean パラメータがスキーマ作成操作のターゲットパスかどうか。
Default String 何も値が指定されていない場合に、このパラメータで使用される値。
SpecificName String 複数のストアドプロシージャが同じ名前を持つ場合、それぞれの同名のストアドプロシージャを一意に識別するラベル。特定の名前を持つプロシージャが1つだけの場合は、その名前がここに単純に反映されます。
IsCDataProvided Boolean プロシージャがネイティブのBcart プロシージャではなく、CData によって追加 / 実装されているかどうか。

Pseudo-Columns

Name Type Description
IncludeResultColumns Boolean 出力にパラメータに加えて結果セットのカラムを含めるかどうか。デフォルトはFalse です。

CData Cloud

sys_keycolumns

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

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

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

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 主キーのカラム名。

CData Cloud

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 外部キーがインポート（他のテーブルを指す）キーかエクスポート（他のテーブルから参照される）キーかを指定します。

CData Cloud

sys_primarykeys

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

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

         SELECT * FROM sys_primarykeys

Columns

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

CData Cloud

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 インデックスのカラムのシーケンスナンバー。

CData Cloud

sys_connection_props

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

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

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 プロパティに関するその他のさまざまな情報。

CData Cloud

sys_sqlinfo

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

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

データソースのSELECT 機能

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

名前説明有効な値
AGGREGATE_FUNCTIONSサポートされている集計関数。AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNTCOUNT 関数がサポートされているかどうか。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_BYGROUP 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_PROPERTIESUniform データベースを特定するプロパティを示します。
SUPPORTS_MULTIPLE_SCHEMASプロバイダー用に複数のスキームが存在するかどうかを示します。YES, NO
SUPPORTS_MULTIPLE_CATALOGSプロバイダー用に複数のカタログが存在するかどうかを示します。YES, NO
DATASYNCVERSIONこのドライバーにアクセスするために必要な、CData Sync のバージョン。Standard, Starter, Professional, Enterprise
DATASYNCCATEGORYこのドライバーのCData Sync カテゴリ。Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQLAPI で提供されている以上の、追加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_PARENTIDCheckCache 構文を親キーカラムに対して実行するかどうかを示します。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 構文の詳細。

CData Cloud

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、またはバッチ内の更新が失敗した場合のエラーメッセージ。

CData Cloud

sys_information

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

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

SELECT * FROM sys_information

Columns

NameTypeDescription
ProductString製品名。
VersionString製品のバージョン番号。
DatasourceString製品が接続するデータソースの名前。
NodeIdString製品がインストールされているマシンの固有識別子。
HelpURLString製品のヘルプドキュメントのURL。
LicenseString製品のライセンス情報。（この情報が利用できない場合、この項目は空白のままか「N/A」と表示されます。）
LocationString製品のライブラリが格納されているファイルパスの場所。
EnvironmentString製品が現在稼働している環境またはランタイムのバージョン。
DataSyncVersionString本コネクタを使用するために必要なCData Sync のティア。
DataSyncCategoryStringCData Sync 機能のカテゴリ（例：Source、Destination）。

CData Cloud

接続文字列オプション

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

Authentication

プロパティ説明
AuthSchemeBcart に接続する際に使用する認証の種類。
PersonalAccessTokenPersonal Access Token は、Bcart API へのリクエストを許可します。

OAuth

プロパティ説明
OAuthClientIdカスタムOAuth アプリケーションに割り当てられたクライアントID（コンシューマーキーとも呼ばれます）を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。
OAuthClientSecretカスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。（カスタムOAuth アプリケーションのみ）
Scopeデータへの適切なアクセスを確実にするために、認証ユーザーのアプリケーションへのアクセス範囲を指定します。 カスタムOAuth アプリケーションが必要な場合は、通常、アプリケーションの作成時に指定します。

SSL

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

Logging

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

Schema

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

Miscellaneous

プロパティ説明
IncludeCustomFields各テーブルからカスタムフィールドを取得する場合は、true に設定します。
MaxRows集計やGROUP BY を含まないクエリで返される最大行数を指定します。
PseudoColumnsテーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。
Timeoutprovider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。
UseDisplayNamesカスタムフィールドの表示名を各カラム名に使用する場合は、true に設定します。
CData Cloud

Authentication

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

プロパティ説明
AuthSchemeBcart に接続する際に使用する認証の種類。
PersonalAccessTokenPersonal Access Token は、Bcart API へのリクエストを許可します。
CData Cloud

AuthScheme

Bcart に接続する際に使用する認証の種類。

Possible Values

OAuth, PersonalAccessToken

データ型

string

デフォルト値

"PersonalAccessToken"

解説

  • OAuth：コードグラントタイプでOAuth 認証を実行する場合に設定。
  • PersonalAccessToken：パーソナルアクセストークン認証を実行する場合に設定。

CData Cloud

PersonalAccessToken

Personal Access Token は、Bcart API へのリクエストを許可します。

データ型

string

デフォルト値

""

解説

Bcart API 管理ページにログイン後、「アプリケーション管理」画面のCreate New Token をクリックし、Name を入力して必要な権限を選択します。設定すると、パーソナルアクセストークンを取得できます。

CData Cloud

OAuth

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

プロパティ説明
OAuthClientIdカスタムOAuth アプリケーションに割り当てられたクライアントID（コンシューマーキーとも呼ばれます）を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。
OAuthClientSecretカスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。（カスタムOAuth アプリケーションのみ）
Scopeデータへの適切なアクセスを確実にするために、認証ユーザーのアプリケーションへのアクセス範囲を指定します。 カスタムOAuth アプリケーションが必要な場合は、通常、アプリケーションの作成時に指定します。
CData Cloud

OAuthClientId

カスタムOAuth アプリケーションに割り当てられたクライアントID（コンシューマーキーとも呼ばれます）を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。

データ型

string

デフォルト値

""

解説

このプロパティは2つのケースで必要となります：

  • カスタムOAuth アプリケーションを使用する場合。たとえば、Web ベースの認証フロー、サービスベースの認証、またはアプリケーションの登録が必要な証明書ベースのフローなどが該当します。
  • ドライバーが埋め込みOAuth 資格情報を提供しない場合。

（ドライバーが埋め込みOAuth 資格情報を提供する場合、この値はすでにCloud によって設定されており、手動で入力する必要がないことがあります。）

OAuthClientId は、認証付きの接続を構成する際に、OAuthClientSecret やOAuthSettingsLocation などの他のOAuth 関連プロパティと一緒に使用されるのが一般的です。

OAuthClientId は、ユーザーがOAuth 経由で認証を行う前に設定する必要がある、主要な接続パラメータの1つです。 この値は、通常、ID プロバイダーのアプリケーション登録設定で確認できます。 Client ID、Application ID、Consumer Key などとラベル付けされた項目を探してください。

クライアントID は、クライアントシークレットのような機密情報とは見なされませんが、アプリケーションの識別情報の一部であるため、慎重に取り扱う必要があります。公開リポジトリや共有設定ファイルでこの値を露出させないようにしてください。

接続設定時にこのプロパティを使用する方法の詳細については、接続の確立 を参照してください。

CData Cloud

OAuthClientSecret

カスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。（カスタムOAuth アプリケーションのみ）

データ型

string

デフォルト値

""

解説

このプロパティ（アプリケーションシークレットまたはコンシューマシークレットとも呼ばれます）は、安全なクライアント認証を必要とするすべてのフローでカスタムOAuth アプリケーションを使用する場合に必要です。たとえば、Web ベースのOAuth、サービスベースの接続、証明書ベースの認可フローなどが該当します。 組み込みOAuth アプリケーションを使用する場合は必要ありません。

クライアントシークレットは、OAuth フローのトークン交換ステップで使用されます。このステップでは、ドライバーが認可サーバーにアクセストークンを要求します。 この値が欠落しているか正しくない場合、認証はinvalid_client またはunauthorized_client エラーで失敗します。

OAuthClientSecret は、ユーザーがOAuth 経由で認証を行う前に設定する必要がある、主要な接続パラメータの1つです。この値は、OAuth アプリケーションを登録する際にID プロバイダーから取得できます。

Notes：

  • この値は安全に保管し、公開リポジトリやスクリプト、安全でない環境では決して公開しないようにしてください。
  • クライアントシークレットは、一定期間が経過すると有効期限が切れる場合もあります。 アクセスを中断させないために、有効期限を常に監視し、必要に応じてシークレットをローテーションするようにしてください。

接続設定時にこのプロパティを使用する方法の詳細については、接続の確立 を参照してください。

CData Cloud

Scope

データへの適切なアクセスを確実にするために、認証ユーザーのアプリケーションへのアクセス範囲を指定します。 カスタムOAuth アプリケーションが必要な場合は、通常、アプリケーションの作成時に指定します。

データ型

string

デフォルト値

""

解説

スコープは、認証ユーザーがどのようなアクセス権を持つかを定義するために設定されます。例えば、読み取り、読み取りと書き込み、機密情報への制限付きアクセスなどです。システム管理者は、スコープを使用して機能またはセキュリティクリアランスによるアクセスを選択的に有効化できます。

InitiateOAuth がGETANDREFRESH に設定されている場合、要求するスコープを変更したい場合はこのプロパティを使用する必要があります。

InitiateOAuth がREFRESH またはOFF のいずれかに設定されている場合、このプロパティまたはScope 入力を使用して、要求するスコープを変更できます。

CData Cloud

SSL

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

プロパティ説明
SSLServerCertTLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。
CData Cloud

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

Note：'*' を使用してすべての証明書を受け入れるように指定することも可能ですが、セキュリティ上の懸念があるため推奨されません。

CData Cloud

Logging

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

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

Verbosity

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

データ型

string

デフォルト値

"1"

解説

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

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

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

CData Cloud

Schema

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

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

BrowsableSchemas

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

データ型

string

デフォルト値

""

解説

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

CData Cloud

Miscellaneous

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

プロパティ説明
IncludeCustomFields各テーブルからカスタムフィールドを取得する場合は、true に設定します。
MaxRows集計やGROUP BY を含まないクエリで返される最大行数を指定します。
PseudoColumnsテーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。
Timeoutprovider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。
UseDisplayNamesカスタムフィールドの表示名を各カラム名に使用する場合は、true に設定します。
CData Cloud

IncludeCustomFields

各テーブルからカスタムフィールドを取得する場合は、true に設定します。

Possible Values

TRUE, FALSE

データ型

bool

デフォルト値

false

解説

各テーブルからカスタムフィールドを取得する場合は、true に設定します。

CData Cloud

MaxRows

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

データ型

int

デフォルト値

-1

解説

このプロパティのデフォルト値である-1 は、クエリに明示的にLIMIT 句が含まれていない限り、行の制限が適用されないことを意味します。 （クエリにLIMIT 句が含まれている場合、クエリで指定された値がMaxRows 設定よりも優先されます。）

MaxRows を0より大きい整数に設定することで、クエリがデフォルトで過度に大きな結果セットを返さないようにします。

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

CData Cloud

PseudoColumns

テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。

データ型

string

デフォルト値

""

解説

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

個々の擬似カラムを指定するには、以下の形式を使用します。

Table1=Column1;Table1=Column2;Table2=Column3

すべてのテーブルのすべての擬似カラムを含めるには、次を使用してください： 

*=*

CData Cloud

Timeout

provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。

データ型

int

デフォルト値

60

解説

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

タイムアウトはデフォルトで60秒に設定されています。タイムアウトを無効にするには、このプロパティを0に設定します。

タイムアウトを無効にすると、操作が成功するか、サーバー側のタイムアウト、ネットワークの中断、またはサーバーのリソース制限などの他の条件で失敗するまで無期限に実行されます。

Note： このプロパティは慎重に使用してください。長時間実行される操作がパフォーマンスを低下させたり、応答しなくなる可能性があるためです。

CData Cloud

UseDisplayNames

カスタムフィールドの表示名を各カラム名に使用する場合は、true に設定します。

Possible Values

TRUE, FALSE

データ型

bool

デフォルト値

false

解説

カスタムフィールドの表示名を各カラム名に使用する場合は、true に設定します。

CData Cloud

Third Party Copyrights

LZMA from 7Zip LZMA SDK

LZMA SDK is placed in the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or distribute the original LZMA SDK code, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.

LZMA2 from XZ SDK

Version 1.9 and older are in the public domain.

Xamarin.Forms

Xamarin SDK

The MIT License (MIT)

Copyright (c) .NET Foundation Contributors

All rights reserved.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

NSIS 3.10

Copyright (C) 1999-2025 Contributors THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS COMMON PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.

1. DEFINITIONS

"Contribution" means:

a) in the case of the initial Contributor, the initial code and documentation distributed under this Agreement, and b) in the case of each subsequent Contributor:

i) changes to the Program, and

ii) additions to the Program;

where such changes and/or additions to the Program originate from and are distributed by that particular Contributor. A Contribution 'originates' from a Contributor if it was added to the Program by such Contributor itself or anyone acting on such Contributor's behalf. Contributions do not include additions to the Program which: (i) are separate modules of software distributed in conjunction with the Program under their own license agreement, and (ii) are not derivative works of the Program.

"Contributor" means any person or entity that distributes the Program.

"Licensed Patents " mean patent claims licensable by a Contributor which are necessarily infringed by the use or sale of its Contribution alone or when combined with the Program.

"Program" means the Contributions distributed in accordance with this Agreement.

"Recipient" means anyone who receives the Program under this Agreement, including all Contributors.

2. GRANT OF RIGHTS

a) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, distribute and sublicense the Contribution of such Contributor, if any, and such derivative works, in source code and object code form.

b) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free patent license under Licensed Patents to make, use, sell, offer to sell, import and otherwise transfer the Contribution of such Contributor, if any, in source code and object code form. This patent license shall apply to the combination of the Contribution and the Program if, at the time the Contribution is added by the Contributor, such addition of the Contribution causes such combination to be covered by the Licensed Patents. The patent license shall not apply to any other combinations which include the Contribution. No hardware per se is licensed hereunder.

c) Recipient understands that although each Contributor grants the licenses to its Contributions set forth herein, no assurances are provided by any Contributor that the Program does not infringe the patent or other intellectual property rights of any other entity. Each Contributor disclaims any liability to Recipient for claims brought by any other entity based on infringement of intellectual property rights or otherwise. As a condition to exercising the rights and licenses granted hereunder, each Recipient hereby assumes sole responsibility to secure any other intellectual property rights needed, if any. For example, if a third party patent license is required to allow Recipient to distribute the Program, it is Recipient's responsibility to acquire that license before distributing the Program.

d) Each Contributor represents that to its knowledge it has sufficient copyright rights in its Contribution, if any, to grant the copyright license set forth in this Agreement.

3. REQUIREMENTS

A Contributor may choose to distribute the Program in object code form under its own license agreement, provided that:

a) it complies with the terms and conditions of this Agreement; and

b) its license agreement:

i) effectively disclaims on behalf of all Contributors all warranties and conditions, express and implied, including warranties or conditions of title and non-infringement, and implied warranties or conditions of merchantability and fitness for a particular purpose;

ii) effectively excludes on behalf of all Contributors all liability for damages, including direct, indirect, special, incidental and consequential damages, such as lost profits;

iii) states that any provisions which differ from this Agreement are offered by that Contributor alone and not by any other party; and

iv) states that source code for the Program is available from such Contributor, and informs licensees how to obtain it in a reasonable manner on or through a medium customarily used for software exchange.

When the Program is made available in source code form:

a) it must be made available under this Agreement; and

b) a copy of this Agreement must be included with each copy of the Program.

Contributors may not remove or alter any copyright notices contained within the Program.

Each Contributor must identify itself as the originator of its Contribution, if any, in a manner that reasonably allows subsequent Recipients to identify the originator of the Contribution.

4. COMMERCIAL DISTRIBUTION

Commercial distributors of software may accept certain responsibilities with respect to end users, business partners and the like. While this license is intended to facilitate the commercial use of the Program, the Contributor who includes the Program in a commercial product offering should do so in a manner which does not create potential liability for other Contributors. Therefore, if a Contributor includes the Program in a commercial product offering, such Contributor ("Commercial Contributor") hereby agrees to defend and indemnify every other Contributor ("Indemnified Contributor") against any losses, damages and costs (collectively "Losses") arising from claims, lawsuits and other legal actions brought by a third party against the Indemnified Contributor to the extent caused by the acts or omissions of such Commercial Contributor in connection with its distribution of the Program in a commercial product offering. The obligations in this section do not apply to any claims or Losses relating to any actual or alleged intellectual property infringement. In order to qualify, an Indemnified Contributor must: a) promptly notify the Commercial Contributor in writing of such claim, and b) allow the Commercial Contributor to control, and cooperate with the Commercial Contributor in, the defense and any related settlement negotiations. The Indemnified Contributor may participate in any such claim at its own expense.

For example, a Contributor might include the Program in a commercial product offering, Product X. That Contributor is then a Commercial Contributor. If that Commercial Contributor then makes performance claims, or offers warranties related to Product X, those performance claims and warranties are such Commercial Contributor's responsibility alone. Under this section, the Commercial Contributor would have to defend claims against the other Contributors related to those performance claims and warranties, and if a court requires any other Contributor to pay any damages as a result, the Commercial Contributor must pay those damages.

5. NO WARRANTY

EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the appropriateness of using and distributing the Program and assumes all risks associated with its exercise of rights under this Agreement, including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs or equipment, and unavailability or interruption of operations.

6. DISCLAIMER OF LIABILITY

EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

7. GENERAL

If any provision of this Agreement is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this Agreement, and without further action by the parties hereto, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.

If Recipient institutes patent litigation against a Contributor with respect to a patent applicable to software (including a cross-claim or counterclaim in a lawsuit), then any patent licenses granted by that Contributor to such Recipient under this Agreement shall terminate as of the date such litigation is filed. In addition, if Recipient institutes patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Program itself (excluding combinations of the Program with other software or hardware) infringes such Recipient's patent(s), then such Recipient's rights granted under Section 2(b) shall terminate as of the date such litigation is filed.

All Recipient's rights under this Agreement shall terminate if it fails to comply with any of the material terms or conditions of this Agreement and does not cure such failure in a reasonable period of time after becoming aware of such noncompliance. If all Recipient's rights under this Agreement terminate, Recipient agrees to cease use and distribution of the Program as soon as reasonably practicable. However, Recipient's obligations under this Agreement and any licenses granted by Recipient relating to the Program shall continue and survive.

Everyone is permitted to copy and distribute copies of this Agreement, but in order to avoid inconsistency the Agreement is copyrighted and may only be modified in the following manner. The Agreement Steward reserves the right to publish new versions (including revisions) of this Agreement from time to time. No one other than the Agreement Steward has the right to modify this Agreement. IBM is the initial Agreement Steward. IBM may assign the responsibility to serve as the Agreement Steward to a suitable separate entity. Each new version of the Agreement will be given a distinguishing version number. The Program (including Contributions) may always be distributed subject to the version of the Agreement under which it was received. In addition, after a new version of the Agreement is published, Contributor may elect to distribute the Program (including its Contributions) under the new version. Except as expressly stated in Sections 2(a) and 2(b) above, Recipient receives no rights or licenses to the intellectual property of any Contributor under this Agreement, whether expressly, by implication, estoppel or otherwise. All rights in the Program not expressly granted under this Agreement are reserved.

This Agreement is governed by the laws of the State of New York and the intellectual property laws of the United States of America. No party to this Agreement will bring a legal action under this Agreement more than one year after the cause of action arose. Each party waives its rights to a jury trial in any resulting litigation.

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 25.0.9434