接続の確立

Sync App アプリケーションの接続ページに移動し、接続の追加 パネルで対応するアイコンを選択して、Magento への接続を作成します。Magento アイコンが利用できない場合は、Add More アイコンをクリックしてCData サイトからMagento コネクタをダウンロードおよびインストールします。

必須プロパティは［設定］タブにリストされています。［Advanced］タブには、通常は必要ない接続プロパティが表示されます。

Magento 2.x への接続

接続するには、URL を例えばhttp://yoursitename/magento2 に設定します。オプションで、接続先のストアのStoreCode を指定します（2つ以上存在する場合）。

Authenticating to Magento

To authenticate to Magento 2.x server versions, you can use either the Basic or the Token AuthScheme.

Basic

AuthScheme Set this to Basic.
User Set this to your user name in Magento.
Password Set this to your password in Magento.

Access Token

AuthScheme Set this to Token.
AccessToken Set this to your AccessToken in Magento.

To generate the AccessToken, Log in to the Magento Stores > Settings > Configuration > Services > OAuth > Access Token.

高度な機能

このセクションでは、Magento Sync App の高度な機能を厳選して説明します。

ユーザー定義ビュー

Sync App を使用すると、事前設定されたクエリによって内容が決定されるユーザー定義ビューと呼ばれる仮想テーブルを定義できます。このビューは、ドライバーに発行されるクエリを直接制御できない場合に有効です。カスタムビューの作成と設定の概要については、ユーザー定義ビューを参照してください。

SSL の設定

SSL の設定を使用して、Sync App が証明書のネゴシエーションをどのように扱うかを調整します。さまざまな証明書形式を選択できます。詳しくは、接続文字列オプションにあるSSLServerCert プロパティを参照してください。

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

Windows プロキシとHTTP プロキシを含むファイアウォールとプロキシに合致するようSync App を設定します。トンネル接続を設定することもできます。

クエリ処理

Sync App は、Magento にできるだけ多くのSELECT ステートメント処理をオフロードし、残りのクエリをクライアント側のインメモリで処理します。

詳しくはクエリ処理を参照してください。

ログ

CData ログを調整するために使用可能な設定の概要については、ログを参照してください。基本的なロギングでは、次の2つの接続プロパティを設定するだけです。LogModules 接続プロパティを使用してログに記録する情報のサブセットを選択できる、より洗練されたロギングをサポートする多数の機能があります。

SSL の設定

SSL 設定のカスタマイズ

デフォルトでは、Sync App はサーバーの証明書をシステムの信頼できる証明書ストアと照合して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 Sync App は、Magento 2.x API を介して、アカウントをリレーショナルデータベースとしてモデル化します。この章で説明するデータモデルは、Magento 環境がどのように見えるかの例を示します。実際のデータモデルは、Magento アカウントに基づいて動的に取得されます。

主要機能

Sync App は商品、顧客、および在庫などのMagento エンティティをリレーショナルテーブルとしてモデル化し、SQL を記述してMagento データをクエリできるようにします。
ストアドプロシージャを使用すると、オブジェクトのダウンロードやアップロードなど、Magento の操作を実行できます。
これらのオブジェクトへのライブ接続により、Sync App を使用するとMagento アカウントへのあらゆる変更が即座に反映されます。

テーブル

Sync App はMagento のデータを、標準のSQL ステートメントを使用してクエリできるテーブルのリストにモデル化します。

一般的には、Magento テーブルのクエリは、リレーショナルデータベースのテーブルのクエリと同じです。時には特別なケースもあります。例えば、テーブルの特定のカラムデータを取得するために特定のカラムをWHERE 句に含める必要がある場合などです。これは通常、特定のカラムを取得するために行ごとに個別のリクエストを行う必要がある場合に必要です。これらの特別な状況は、以下にリンクされているテーブルページの上部に明確に文書化されています。

Magento Connector for CData Sync テーブル


Name	Description
BundleProductLinkChildren	BundleProductLinkChildren is an auto generated table
BundleProductOption	BundleProductOption is an auto generated table
CatalogAttributeSet	CatalogAttributeSet is an auto generated table
CatalogCategoryAttribute	CatalogCategoryAttribute is an auto generated table
CatalogCategoryAttributeOptionOptions	CatalogCategoryAttributeOptionOptions is an auto generated table
CatalogCategoryLinkProducts	CatalogCategoryLinkProducts is an auto generated table
CatalogProductAttribute	CatalogProductAttribute is an auto generated table
CatalogProductAttributeTypesList	CatalogProductAttributeTypesList is an auto generated table
CatalogProductLinkTypeList	CatalogProductLinkTypeList is an auto generated table
CatalogProductTierPriceTiers	CatalogProductTierPriceTiers is an auto generated table
CatalogProductTypeList	CatalogProductTypeList is an auto generated table
CheckoutAgreementsCheckoutAgreements	CheckoutAgreementsCheckoutAgreements is an auto generated table
CmsBlock	CmsBlock is an auto generated table
CmsPage	CmsPage is an auto generated table
ConfigurableProductLinkChildren	ConfigurableProductLinkChildren is an auto generated table
ConfigurableProductOption	ConfigurableProductOption is an auto generated table
CustomerAccountBillingAddress	CustomerAccountBillingAddress is an auto generated table
CustomerAccountShippingAddress	CustomerAccountShippingAddress is an auto generated table
CustomerAddress	CustomerAddress is an auto generated table
CustomerGroup	CustomerGroup is an auto generated table
CustomerGroupDefault	CustomerGroupDefault is an auto generated table
Customers	Customers is an auto generated table
DirectoryCountryInformationAcquirer	DirectoryCountryInformationAcquirer is an auto generated table
DirectoryCurrencyInformationAcquirer	DirectoryCurrencyInformationAcquirer is an auto generated table
DownloadableLink	DownloadableLink is an auto generated table
DownloadableSample	DownloadableSample is an auto generated table
EavAttributeSet	EavAttributeSet is an auto generated table
GiftMessageCart	GiftMessageCart is an auto generated table
GiftMessageGuestCart	GiftMessageGuestCart is an auto generated table
GiftMessageGuestItem	GiftMessageGuestItem is an auto generated table
GiftMessageItem	GiftMessageItem is an auto generated table
GuestBillingAddresses	GuestBillingAddresses is an auto generated table
GuestPaymentInformation	GuestPaymentInformation is an auto generated table
GuestPaymentMethods	GuestPaymentMethods is an auto generated table
GuestPaymentSelectedMethods	GuestPaymentSelectedMethods is an auto generated table
GuestShippingMethods	GuestShippingMethods is an auto generated table
Inventory	Inventory is an auto generated table
OrderComments	OrderComments is an auto generated table
OrderItems	OrderItems is an auto generated table
Orders	Orders is an auto generated table
PaymentMethods	PaymentMethods is an auto generated table
PaymentSelectedMethods	PaymentSelectedMethods is an auto generated table
ProductAttributeGroup	ProductAttributeGroup is an auto generated table
ProductAttributeOptions	ProductAttributeOptions is an auto generated table
ProductAttributes	ProductAttributes is an auto generated table
ProductCategories	ProductCategories is an auto generated table
ProductCustomOption	ProductCustomOption is an auto generated table
ProductMedia	ProductMedia is an auto generated table
Products	Products is an auto generated table
QuoteCart	QuoteCart is an auto generated table
QuoteCartItem	QuoteCartItem is an auto generated table
QuoteCartTotal	QuoteCartTotal is an auto generated table
QuoteGuestCart	QuoteGuestCart is an auto generated table
QuoteGuestCartItem	QuoteGuestCartItem is an auto generated table
QuoteGuestCartTotal	QuoteGuestCartTotal is an auto generated table
SalesCreditmemo	SalesCreditmemo is an auto generated table
SalesCreditmemoComments	SalesCreditmemoComments is an auto generated table
SalesInvoice	SalesInvoice is an auto generated table
SalesInvoiceComments	SalesInvoiceComments is an auto generated table
SalesRule	SalesRule is an auto generated table
SalesRuleCoupon	SalesRuleCoupon is an auto generated table
SalesShipment	SalesShipment is an auto generated table
SalesShipmentComments	SalesShipmentComments is an auto generated table
SalesTransaction	SalesTransaction is an auto generated table
ShippingMethods	ShippingMethods is an auto generated table
StoreGroup	StoreGroup is an auto generated table
Stores	Stores is an auto generated table
StoreWebsite	StoreWebsite is an auto generated table
TaxClass	TaxClass is an auto generated table
TaxRate	TaxRate is an auto generated table
TaxRule	TaxRule is an auto generated table

BundleProductLinkChildren

BundleProductLinkChildren is an auto generated table

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	False	The identifier
CanChangeQuantity	Int	False	Whether quantity could be changed
ExtensionAttributes	String	False	This is an auto-generated column
IsDefault	Bool	False	Is default
OptionId	Int	False	Option id
Position	Int	False	Position
Price	String	False	Price
PriceType	Int	False	Price type
Qty	String	False	Qty
Sku	String	False	Linked product sku

Pseudo-Columns

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


Name	Type	Description
ProductSku_p	String	This is an auto-generated column

BundleProductOption

BundleProductOption is an auto generated table

Columns


Name	Type	ReadOnly	Description
ExtensionAttributes	String	False	This is an auto-generated column
OptionId [KEY]	Int	False	Option id
Position	Int	False	Option position
ProductLinks	String	False	Product links
Required	Bool	False	Is required option
Sku [KEY]	String	False	Product sku
Title	String	False	Option title
Type	String	False	Input type

Pseudo-Columns

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


Name	Type	Description
Sku_p	String	This is an auto-generated column
OptionId_p	Int	This is an auto-generated column

CatalogAttributeSet

CatalogAttributeSet is an auto generated table

Columns


Name	Type	ReadOnly	Description
AttributeSetId [KEY]	Int	False	Attribute set ID
AttributeSetName	String	False	Attribute set name
EntityTypeId	Int	False	Attribute set entity type id
ExtensionAttributes	String	False	This is an auto-generated column
SortOrder	Int	False	Attribute set sort order index

Pseudo-Columns

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


Name	Type	Description
AttributeSetId_p	Int	This is an auto-generated column

CatalogCategoryAttribute

CatalogCategoryAttribute is an auto generated table

Columns


Name	Type	ReadOnly	Description
ApplyTo	String	False	Apply to value for the element
AttributeCode	String	False	Code of the attribute.
AttributeId [KEY]	Int	False	Id of the attribute.
BackendModel	String	False	Backend model
BackendType	String	False	Backend type.
DefaultFrontendLabel	String	False	Frontend label for default store
DefaultValue	String	False	Default value for the element.
EntityTypeId	String	False	Entity type id
ExtensionAttributes	String	False	This is an auto-generated column
FrontendClass	String	False	Frontend class of attribute
FrontendInput	String	False	HTML for input element.
FrontendLabels	String	False	Frontend label for each store
IsComparable	String	False	The attribute can be compared on the frontend
IsFilterable	Bool	False	It used in layered navigation
IsFilterableInGrid	Bool	False	It is filterable in catalog product grid
IsFilterableInSearch	Bool	False	It is used in search results layered navigation
IsHtmlAllowedOnFront	Bool	False	The HTML tags are allowed on the frontend
IsRequired	Bool	False	Attribute is required.
IsSearchable	String	False	The attribute can be used in Quick Search
IsUnique	String	False	This is a unique attribute
IsUsedForPromoRules	String	False	The attribute can be used for promo rules
IsUsedInGrid	Bool	False	It is used in catalog product grid
IsUserDefined	Bool	False	Current attribute has been defined by a user.
IsVisible	Bool	False	Attribute is visible on frontend.
IsVisibleInAdvancedSearch	String	False	The attribute can be used in Advanced Search
IsVisibleInGrid	Bool	False	It is visible in catalog product grid
IsVisibleOnFront	String	False	The attribute is visible on the frontend
IsWysiwygEnabled	Bool	False	WYSIWYG flag
Note	String	False	The note attribute for the element.
Options	String	False	Options of the attribute (key => value pairs for select)
Position	Int	False	Position
Scope	String	False	Attribute scope
SourceModel	String	False	Source model
UsedForSortBy	Bool	False	It is used for sorting in product listing
UsedInProductListing	String	False	The attribute can be used in product listing
ValidationRules	String	False	Validation rules.

Pseudo-Columns

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


Name	Type	Description
AttributeCode_p	String	This is an auto-generated column

CatalogCategoryAttributeOptionOptions

CatalogCategoryAttributeOptionOptions is an auto generated table

Columns


Name	Type	ReadOnly	Description
IsDefault	Bool	False	Default
Label [KEY]	String	False	Option label
SortOrder	Int	False	Option order
StoreLabels	String	False	Option label for store scopes
Value	String	False	Option value

Pseudo-Columns

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


Name	Type	Description
AttributeCode_p	String	This is an auto-generated column

CatalogCategoryLinkProducts

CatalogCategoryLinkProducts is an auto generated table

Columns


Name	Type	ReadOnly	Description
CategoryId	String	False	Category id
ExtensionAttributes	String	False	This is an auto-generated column
Position	Int	False	This is an auto-generated column
Sku [KEY]	String	False	This is an auto-generated column

Pseudo-Columns

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


Name	Type	Description
CategoryId_p	Int	This is an auto-generated column

CatalogProductAttribute

CatalogProductAttribute is an auto generated table

Columns


Name	Type	ReadOnly	Description
ApplyTo	String	False	Apply to value for the element
AttributeCode	String	False	Code of the attribute.
AttributeId [KEY]	Int	False	Id of the attribute.
BackendModel	String	False	Backend model
BackendType	String	False	Backend type.
DefaultFrontendLabel	String	False	Frontend label for default store
DefaultValue	String	False	Default value for the element.
EntityTypeId	String	False	Entity type id
ExtensionAttributes	String	False	This is an auto-generated column
FrontendClass	String	False	Frontend class of attribute
FrontendInput	String	False	HTML for input element.
FrontendLabels	String	False	Frontend label for each store
IsComparable	String	False	The attribute can be compared on the frontend
IsFilterable	Bool	False	It used in layered navigation
IsFilterableInGrid	Bool	False	It is filterable in catalog product grid
IsFilterableInSearch	Bool	False	It is used in search results layered navigation
IsHtmlAllowedOnFront	Bool	False	The HTML tags are allowed on the frontend
IsRequired	Bool	False	Attribute is required.
IsSearchable	String	False	The attribute can be used in Quick Search
IsUnique	String	False	This is a unique attribute
IsUsedForPromoRules	String	False	The attribute can be used for promo rules
IsUsedInGrid	Bool	False	It is used in catalog product grid
IsUserDefined	Bool	False	Current attribute has been defined by a user.
IsVisible	Bool	False	Attribute is visible on frontend.
IsVisibleInAdvancedSearch	String	False	The attribute can be used in Advanced Search
IsVisibleInGrid	Bool	False	It is visible in catalog product grid
IsVisibleOnFront	String	False	The attribute is visible on the frontend
IsWysiwygEnabled	Bool	False	WYSIWYG flag
Note	String	False	The note attribute for the element.
Options	String	False	Options of the attribute (key => value pairs for select)
Position	Int	False	Position
Scope	String	False	Attribute scope
SourceModel	String	False	Source model
UsedForSortBy	Bool	False	It is used for sorting in product listing
UsedInProductListing	String	False	The attribute can be used in product listing
ValidationRules	String	False	Validation rules.

Pseudo-Columns

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


Name	Type	Description
AttributeCode_p	String	This is an auto-generated column

CatalogProductAttributeTypesList

CatalogProductAttributeTypesList is an auto generated table

Columns


Name	Type	ReadOnly	Description
ExtensionAttributes	String	False	This is an auto-generated column
Label [KEY]	String	False	Type label
Value	String	False	Value

CatalogProductLinkTypeList

CatalogProductLinkTypeList is an auto generated table

Columns


Name	Type	ReadOnly	Description
Code [KEY]	Int	False	Link type code
ExtensionAttributes	String	False	This is an auto-generated column
Name	String	False	Link type name
Type	String	False	Attribute type

Pseudo-Columns

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


Name	Type	Description
Type_p	String	This is an auto-generated column

CatalogProductTierPriceTiers

CatalogProductTierPriceTiers is an auto generated table

Columns


Name	Type	ReadOnly	Description
CustomerGroupId [KEY]	Int	False	Customer group id
ExtensionAttributes	String	False	This is an auto-generated column
Qty	String	False	Tier qty
Value	String	False	Price value

Pseudo-Columns

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


Name	Type	Description
CustomerGroupId_p	String	'all' can be used to specify 'ALL GROUPS'
Sku_p	String	This is an auto-generated column

CatalogProductTypeList

CatalogProductTypeList is an auto generated table

Columns


Name	Type	ReadOnly	Description
ExtensionAttributes	String	False	This is an auto-generated column
Label [KEY]	String	False	Product type label
Name	String	False	Product type code

CheckoutAgreementsCheckoutAgreements

CheckoutAgreementsCheckoutAgreements is an auto generated table

Columns


Name	Type	ReadOnly	Description
AgreementId [KEY]	Int	False	Agreement ID.
CheckboxText	String	False	Agreement checkbox text.
Content	String	False	Agreement content.
ContentHeight	String	False	Agreement content height. Otherwise, null.
ExtensionAttributes	String	False	This is an auto-generated column
IsActive	Bool	False	Agreement status.
IsHtml	Bool	False	* true - HTML. * false - plain text.
Mode	Int	False	The agreement applied mode.
Name	String	False	Agreement name.

CmsBlock

CmsBlock is an auto generated table

Columns


Name	Type	ReadOnly	Description
Id [KEY]	Int	False	ID
Active	Bool	False	Active
Content	String	False	Content
CreationTime	Datetime	False	Creation time
Identifier	String	False	Identifier
Title	String	False	Title
UpdateTime	Datetime	False	Update time

Pseudo-Columns

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


Name	Type	Description
BlockId_p	Int	This is an auto-generated column
Id_p	String	This is an auto-generated column

CmsPage

CmsPage is an auto generated table

Columns


Name	Type	ReadOnly	Description
Id [KEY]	Int	False	ID
Active	Bool	False	Active
Content	String	False	Content
ContentHeading	String	False	Content heading
CreationTime	Datetime	False	Creation time
CustomLayoutUpdateXml	String	False	Custom layout update xml
CustomRootTemplate	String	False	Custom root template
CustomTheme	String	False	Custom theme
CustomThemeFrom	String	False	Custom theme from
CustomThemeTo	String	False	Custom theme to
Identifier	String	False	Identifier
LayoutUpdateXml	String	False	Layout update xml
MetaDescription	String	False	Meta description
MetaKeywords	String	False	Meta keywords
MetaTitle	String	False	Meta title
PageLayout	String	False	Page layout
SortOrder	String	False	Sort order
Title	String	False	Title
UpdateTime	Datetime	False	Update time

Pseudo-Columns

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


Name	Type	Description
Id_p	String	This is an auto-generated column
PageId_p	Int	This is an auto-generated column

ConfigurableProductLinkChildren

ConfigurableProductLinkChildren is an auto generated table

Columns


Name	Type	ReadOnly	Description
Id [KEY]	Int	False	Id
AttributeSetId	Int	False	Attribute set id
CreatedAt	Datetime	False	Created date
ExtensionAttributes	String	False	This is an auto-generated column
MediaGalleryEntries	String	False	Media gallery entries
Name	String	False	Name
Options	String	False	List of product options
Price	String	False	Price
ProductLinks	String	False	Product links info
Sku	String	False	Sku
Status	Int	False	Status
TierPrices	String	False	List of product tier prices
TypeId	String	False	Type id
UpdatedAt	Datetime	False	Updated date
Visibility	Int	False	Visibility
Weight	String	False	Weight

Pseudo-Columns

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


Name	Type	Description
Sku_p	String	This is an auto-generated column

ConfigurableProductOption

ConfigurableProductOption is an auto generated table

Columns


Name	Type	ReadOnly	Description
Id [KEY]	Int	False	This is an auto-generated column
AttributeId	String	False	This is an auto-generated column
ExtensionAttributes	String	False	This is an auto-generated column
IsUseDefault	Bool	False	This is an auto-generated column
Label	String	False	This is an auto-generated column
Position	Int	False	This is an auto-generated column
ProductId	Int	False	This is an auto-generated column
Values	String	False	This is an auto-generated column

Pseudo-Columns

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


Name	Type	Description
Sku_p	String	This is an auto-generated column
Id_p	Int	This is an auto-generated column

CustomerAccountBillingAddress

CustomerAccountBillingAddress is an auto generated table

Columns


Name	Type	ReadOnly	Description
Id [KEY]	Int	False	ID
City	String	False	City name
Company	String	False	Company
CountryId	String	False	Country code in ISO_3166-2 format
CustomerId	Int	False	Customer ID
DefaultBilling	Bool	False	If this address is default billing address
DefaultShipping	Bool	False	If this address is default shipping address.
ExtensionAttributes	String	False	This is an auto-generated column
Fax	String	False	Fax number
Firstname	String	False	First name
Lastname	String	False	Last name
Middlename	String	False	Middle name
Postcode	String	False	Postcode
Prefix	String	False	Prefix
Region	String	False	This is an auto-generated column
RegionId	Int	False	Region ID
Street	String	False	Street
Suffix	String	False	Suffix
Telephone	String	False	Telephone number
VatId	String	False	Vat id

Pseudo-Columns

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


Name	Type	Description
CustomerId_p	Int	This is an auto-generated column

CustomerAccountShippingAddress

CustomerAccountShippingAddress is an auto generated table

Columns


Name	Type	ReadOnly	Description
Id [KEY]	Int	False	ID
City	String	False	City name
Company	String	False	Company
CountryId	String	False	Country code in ISO_3166-2 format
CustomerId	Int	False	Customer ID
DefaultBilling	Bool	False	If this address is default billing address
DefaultShipping	Bool	False	If this address is default shipping address.
ExtensionAttributes	String	False	This is an auto-generated column
Fax	String	False	Fax number
Firstname	String	False	First name
Lastname	String	False	Last name
Middlename	String	False	Middle name
Postcode	String	False	Postcode
Prefix	String	False	Prefix
Region	String	False	This is an auto-generated column
RegionId	Int	False	Region ID
Street	String	False	Street
Suffix	String	False	Suffix
Telephone	String	False	Telephone number
VatId	String	False	Vat id

Pseudo-Columns

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


Name	Type	Description
CustomerId_p	Int	This is an auto-generated column

CustomerAddress

CustomerAddress is an auto generated table

Columns


Name	Type	ReadOnly	Description
Id [KEY]	Int	False	ID
City	String	False	City name
Company	String	False	Company
CountryId	String	False	Country code in ISO_3166-2 format
CustomerId	Int	False	Customer ID
DefaultBilling	Bool	False	If this address is default billing address
DefaultShipping	Bool	False	If this address is default shipping address.
ExtensionAttributes	String	False	This is an auto-generated column
Fax	String	False	Fax number
Firstname	String	False	First name
Lastname	String	False	Last name
Middlename	String	False	Middle name
Postcode	String	False	Postcode
Prefix	String	False	Prefix
Region	String	False	This is an auto-generated column
RegionId	Int	False	Region ID
Street	String	False	Street
Suffix	String	False	Suffix
Telephone	String	False	Telephone number
VatId	String	False	Vat id

Pseudo-Columns

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


Name	Type	Description
AddressId_p	Int	This is an auto-generated column

CustomerGroup

CustomerGroup is an auto generated table

Columns


Name	Type	ReadOnly	Description
Id [KEY]	Int	False	Id
Code	String	False	Code
ExtensionAttributes	String	False	This is an auto-generated column
TaxClassId	Int	False	Tax class id
TaxClassName	String	False	Tax class name

Pseudo-Columns

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


Name	Type	Description
Id_p	Int	This is an auto-generated column

CustomerGroupDefault

CustomerGroupDefault is an auto generated table

Columns


Name	Type	ReadOnly	Description
Id [KEY]	Int	False	Id
Code	String	False	Code
ExtensionAttributes	String	False	This is an auto-generated column
TaxClassId	Int	False	Tax class id
TaxClassName	String	False	Tax class name

Customers

Customers is an auto generated table

Select

The Customers table supports server-side processing for all columns in the WHERE clause. Most of these columns support server-side processing for the >, >=, <, <=, =, IN, NOT IN and LIKE operators.

The following examples show the types of queries processed server side.

Retrieve all customers from your Magento server.
```
SELECT * FROM Customers
```
Retrieve a single customer:
```
SELECT * FROM Customers WHERE Id = '1'
```

Filter by status:

SELECT * FROM Customers WHERE GroupId = 1

Filter by created date:

SELECT * FROM Customers WHERE CreatedAt > '2017-08-01'

Example query with multiple filters:

SELECT * FROM Customers WHERE DefaultBilling IN (1,2) AND Firstname LIKE '%i%' AND WebsiteId=1 LIMIT 50

You can turn off client-side execution by setting SupportEnhancedSQL to false, in which case any search criteria that refers to any other columns will cause an error.

Insert

To add a Customer, the FirstName, LastName, and Email fields are required.

INSERT INTO Customers(FirstName,LastName,Email,WebsiteId,GroupId) VALUES ('John','Doe','[email protected]',1,1)

Update

Magento allows updates for the FirstName, LastName, MiddleName, Suffix, Email, GroupId, Prefix, DisableAutoGroupChange, and Taxvat columns. WebsiteId is a required value.

UPDATE Customers SET FirstName='Jane', Email='[email protected]', GroupId=2, DisableAutoGroupChange='0', Prefix='x', Middlename='J', LastName='Doe', Suffix='y',Taxvat=1, WebsiteId=1 WHERE Id = 4

Delete

Customers can be deleted by providing the Id of the Customer and issuing a DELETE statement.

DELETE FROM Customers WHERE Id = 4

Columns


Name	Type	ReadOnly	Description
Id [KEY]	Int	False	Customer id
Addresses	String	False	Customer addresses.
Confirmation	String	False	Confirmation
CreatedAt	Datetime	False	Created at time
CreatedIn	String	False	Created in area
DefaultBilling	String	False	Default billing address id
DefaultShipping	String	False	Default shipping address id
DisableAutoGroupChange	Int	False	Disable auto group change flag.
Dob	String	False	Date of birth
Email	String	False	Email address
ExtensionAttributes	String	False	This is an auto-generated column
Firstname	String	False	First name
Gender	Int	False	Gender
GroupId	Int	False	Group id
Lastname	String	False	Last name
Middlename	String	False	Middle name
Prefix	String	False	Prefix
StoreId	Int	False	Store id
Suffix	String	False	Suffix
Taxvat	String	False	Tax Vat
UpdatedAt	Datetime	False	Updated at time
WebsiteId	Int	False	Website id

Pseudo-Columns

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


Name	Type	Description
Id_p	String	This is an auto-generated column

DirectoryCountryInformationAcquirer

DirectoryCountryInformationAcquirer is an auto generated table

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	False	The country id for the store.
AvailableRegions	String	False	The available regions for the store.
ExtensionAttributes	String	False	This is an auto-generated column
FullNameEnglish	String	False	The country full name (in English) for the store.
FullNameLocale	String	False	The country full name (in store locale) for the store.
ThreeLetterAbbreviation	String	False	The country 3 letter abbreviation for the store.
TwoLetterAbbreviation	String	False	The country 2 letter abbreviation for the store.

Pseudo-Columns

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


Name	Type	Description
CountryId_p	String	This is an auto-generated column

DirectoryCurrencyInformationAcquirer

DirectoryCurrencyInformationAcquirer is an auto generated table

Columns


Name	Type	ReadOnly	Description
AvailableCurrencyCodes	String	False	The list of allowed currency codes for the store.
BaseCurrencyCode [KEY]	String	False	The base currency code for the store.
BaseCurrencySymbol	String	False	The currency symbol of the base currency for the store.
DefaultDisplayCurrencyCode	String	False	The default display currency code for the store.
DefaultDisplayCurrencySymbol	String	False	The currency symbol of the default display currency for the store.
ExchangeRates	String	False	The list of exchange rate information for the store.
ExtensionAttributes	String	False	This is an auto-generated column

DownloadableLink

DownloadableLink is an auto generated table

Columns


Name	Type	ReadOnly	Description
Id [KEY]	Int	False	Sample(or link) id
ExtensionAttributes	String	False	This is an auto-generated column
IsShareable	Int	False	Shareable status
LinkFile	String	False	relative file path
LinkFileContent	String	False	This is an auto-generated column
LinkType	String	False	This is an auto-generated column
LinkUrl	String	False	Link url or null when type is 'file'
NumberOfDownloads	Int	False	Of downloads per user
Price	String	False	Price
SampleFile	String	False	relative file path
SampleFileContent	String	False	This is an auto-generated column
SampleType	String	False	This is an auto-generated column
SampleUrl	String	False	file URL
SortOrder	Int	False	This is an auto-generated column
Title	String	False	This is an auto-generated column

Pseudo-Columns

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


Name	Type	Description
Id_p	Int	This is an auto-generated column
Sku_p	String	This is an auto-generated column

DownloadableSample

DownloadableSample is an auto generated table

Columns


Name	Type	ReadOnly	Description
Id [KEY]	Int	False	Sample(or link) id
ExtensionAttributes	String	False	This is an auto-generated column
SampleFile	String	False	relative file path
SampleFileContent	String	False	This is an auto-generated column
SampleType	String	False	This is an auto-generated column
SampleUrl	String	False	file URL
SortOrder	Int	False	Order index for sample
Title	String	False	Title

Pseudo-Columns

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


Name	Type	Description
Id_p	Int	This is an auto-generated column
Sku_p	String	This is an auto-generated column

EavAttributeSet

EavAttributeSet is an auto generated table

Columns


Name	Type	ReadOnly	Description
AttributeSetId [KEY]	Int	False	Attribute set ID
AttributeSetName	String	False	Attribute set name
EntityTypeId	Int	False	Attribute set entity type id
ExtensionAttributes	String	False	This is an auto-generated column
SortOrder	Int	False	Attribute set sort order index

Pseudo-Columns

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


Name	Type	Description
AttributeSetId_p	Int	This is an auto-generated column

GiftMessageCart

GiftMessageCart is an auto generated table

Columns


Name	Type	ReadOnly	Description
CustomerId	Int	False	Customer ID. Otherwise, null.
ExtensionAttributes	String	False	This is an auto-generated column
GiftMessageId [KEY]	Int	False	Gift message ID. Otherwise, null.
Message	String	False	Message text.
Recipient	String	False	Recipient name.
Sender	String	False	Sender name.

Pseudo-Columns

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


Name	Type	Description
CartId_p	Int	The cart ID.

GiftMessageGuestCart

GiftMessageGuestCart is an auto generated table

Columns


Name	Type	ReadOnly	Description
CustomerId	Int	False	Customer ID. Otherwise, null.
ExtensionAttributes	String	False	This is an auto-generated column
GiftMessageId [KEY]	Int	False	Gift message ID. Otherwise, null.
Message	String	False	Message text.
Recipient	String	False	Recipient name.
Sender	String	False	Sender name.

Pseudo-Columns

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


Name	Type	Description
CartId_p	String	The cart ID.

GiftMessageGuestItem

GiftMessageGuestItem is an auto generated table

Columns


Name	Type	ReadOnly	Description
CustomerId	Int	False	Customer ID. Otherwise, null.
ExtensionAttributes	String	False	This is an auto-generated column
GiftMessageId [KEY]	Int	False	Gift message ID. Otherwise, null.
Message	String	False	Message text.
Recipient	String	False	Recipient name.
Sender	String	False	Sender name.

Pseudo-Columns

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


Name	Type	Description
CartId_p	String	The cart ID.
ItemId_p	Int	The item ID.

GiftMessageItem

GiftMessageItem is an auto generated table

Columns


Name	Type	ReadOnly	Description
CustomerId	Int	False	Customer ID. Otherwise, null.
ExtensionAttributes	String	False	This is an auto-generated column
GiftMessageId [KEY]	Int	False	Gift message ID. Otherwise, null.
Message	String	False	Message text.
Recipient	String	False	Recipient name.
Sender	String	False	Sender name.

Pseudo-Columns

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


Name	Type	Description
ItemId_p	Int	The item ID.
CartId_p	Int	The cart ID.

GuestBillingAddresses

GuestBillingAddresses is an auto generated table

Columns


Name	Type	ReadOnly	Description
Id [KEY]	Int	False	Id
City	String	False	City name
Company	String	False	Company
CountryId	String	False	Country id
CustomerAddressId	Int	False	Customer address id
CustomerId	Int	False	Customer id
Email	String	False	Billing/shipping email
ExtensionAttributes	String	False	This is an auto-generated column
Fax	String	False	Fax number
Firstname	String	False	First name
Lastname	String	False	Last name
Middlename	String	False	Middle name
Postcode	String	False	Postcode
Prefix	String	False	Prefix
Region	String	False	Region name
RegionCode	String	False	Region code
RegionId	Int	False	Region id
SameAsBilling	Int	False	Same as billing flag
SaveInAddressBook	Int	False	Save in address book flag
Street	String	False	Street
Suffix	String	False	Suffix
Telephone	String	False	Telephone number
VatId	String	False	Vat id

Pseudo-Columns

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


Name	Type	Description
CartId_p	String	The cart ID.

GuestPaymentInformation

GuestPaymentInformation is an auto generated table

Columns


Name	Type	ReadOnly	Description
ExtensionAttributes	String	False	This is an auto-generated column
PaymentMethods	String	False	This is an auto-generated column
Totals	String	False	This is an auto-generated column

Pseudo-Columns

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


Name	Type	Description
CartId_p	String	This is an auto-generated column

GuestPaymentMethods

GuestPaymentMethods is an auto generated table

Columns


Name	Type	ReadOnly	Description
Code [KEY]	String	False	Payment method code
Title	String	False	Payment method title

Pseudo-Columns

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


Name	Type	Description
CartId_p	String	The cart ID.

GuestPaymentSelectedMethods

GuestPaymentSelectedMethods is an auto generated table

Columns


Name	Type	ReadOnly	Description
AdditionalData	String	False	Payment additional details
ExtensionAttributes	String	False	This is an auto-generated column
Method [KEY]	String	False	Payment method code
PoNumber	String	False	Purchase order number

Pseudo-Columns

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


Name	Type	Description
CartId_p	String	The cart ID.

GuestShippingMethods

GuestShippingMethods is an auto generated table

Columns


Name	Type	ReadOnly	Description
Amount	String	False	Shipping amount in store currency.
Available	Bool	False	The value of the availability flag for the current shipping method.
BaseAmount	String	False	Shipping amount in base currency.
CarrierCode	String	False	Shipping carrier code.
CarrierTitle	String	False	Shipping carrier title. Otherwise, null.
ErrorMessage	String	False	Shipping Error message.
ExtensionAttributes	String	False	This is an auto-generated column
MethodCode [KEY]	String	False	Shipping method code.
MethodTitle	String	False	Shipping method title. Otherwise, null.
PriceExclTax	String	False	Shipping price excl tax.
PriceInclTax	String	False	Shipping price incl tax.

Pseudo-Columns

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


Name	Type	Description
CartId_p	String	The shopping cart ID.

Inventory

Inventory is an auto generated table

Select

You must specify the product SKU to query this table. The Sync App will use the Magento API to filter the results by ProductSku_p while the rest of the filter is executed client side within the Sync App.

For example, the following query is the only one supported server side:

SELECT * FROM Inventory WHERE ProductSKU = 'sjl-8082'

You can turn off client-side execution by setting SupportEnhancedSQL to false, in which case any search criteria that refers to any other columns will cause an error.

Update

To update a product inventory, you must set the ItemId of an existing item along with the ProductSKU.

UPDATE [Inventory] SET Qty = '87' WHERE ProductSKU = 'sjl-8082' AND ItemId = '1'

Columns


Name	Type	ReadOnly	Description
SearchCriteria	String	False	This is an auto-generated column
TotalCount	Int	False	Total count.
Backorders	Int	False	Backorders status
EnableQtyIncrements	Bool	False	Whether Quantity Increments is enabled
ExtensionAttributes	String	False	This is an auto-generated column
IsDecimalDivided	Bool	False	This is an auto-generated column
IsInStock	Bool	False	Stock Availability
IsQtyDecimal	Bool	False	This is an auto-generated column
ItemId	Int	False	This is an auto-generated column
LowStockDate	String	False	This is an auto-generated column
ManageStock	Bool	False	Can Manage Stock
MaxSaleQty	String	False	Maximum Qty Allowed in Shopping Cart data wrapper
MinQty	String	False	Minimal quantity available for item status in stock
MinSaleQty	String	False	Minimum Qty Allowed in Shopping Cart or NULL when there is no limitation
NotifyStockQty	String	False	Notify for Quantity Below data wrapper
ProductId	Int	False	This is an auto-generated column
Qty	String	False	This is an auto-generated column
QtyIncrements	String	False	Quantity Increments data wrapper
ShowDefaultNotificationMessage	Bool	False	This is an auto-generated column
StockId	Int	False	Stock identifier
StockStatusChangedAuto	Int	False	This is an auto-generated column
UseConfigBackorders	Bool	False	This is an auto-generated column
UseConfigEnableQtyInc	Bool	False	This is an auto-generated column
UseConfigManageStock	Bool	False	This is an auto-generated column
UseConfigMaxSaleQty	Bool	False	This is an auto-generated column
UseConfigMinQty	Bool	False	This is an auto-generated column
UseConfigMinSaleQty	Int	False	This is an auto-generated column
UseConfigNotifyStockQty	Bool	False	This is an auto-generated column
UseConfigQtyIncrements	Bool	False	This is an auto-generated column
StockItem	String	False	This is an auto-generated column
StockStatus	Int	False	This is an auto-generated column

Pseudo-Columns

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


Name	Type	Description
ItemId_p	String	This is an auto-generated column
ProductSku_p	String	This is an auto-generated column

OrderComments

OrderComments is an auto generated table

Columns


Name	Type	ReadOnly	Description
Comment	String	False	Comment.
CreatedAt	Datetime	False	Created-at timestamp.
EntityId [KEY]	Int	False	Order status history ID.
EntityName	String	False	Entity name.
ExtensionAttributes	String	False	This is an auto-generated column
IsCustomerNotified	Int	False	Is-customer-notified flag value.
IsVisibleOnFront	Int	False	Is-visible-on-storefront flag value.
ParentId	Int	False	Parent ID.
Status	String	False	Status.

Pseudo-Columns

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


Name	Type	Description
Id_p	Int	The order ID.

OrderItems

OrderItems is an auto generated table

Select

The Sync App will use the Magento API to filter the results by ItemId while the rest of the filter is executed client side within the Sync App.

The following examples demonstrate the types of queries processed on the server.

Retrieve information about all order items:
```
SELECT * FROM OrderItems
```
Filter by ItemId to get detailed information about an order item:
```
SELECT * FROM OrderItems WHERE ItemId = '3'
```

You can turn off client-side execution by setting SupportEnhancedSQL to false, in which case any search criteria that refers to any other columns will cause an error.

Columns


Name	Type	ReadOnly	Description
AdditionalData	String	False	Additional data.
AmountRefunded	String	False	Amount refunded.
AppliedRuleIds	String	False	Applied rule IDs.
BaseAmountRefunded	String	False	Base amount refunded.
BaseCost	String	False	Base cost.
BaseDiscountAmount	String	False	Base discount amount.
BaseDiscountInvoiced	String	False	Base discount invoiced.
BaseDiscountRefunded	String	False	Base discount refunded.
BaseDiscountTaxCompensationAmount	String	False	Base discount tax compensation amount.
BaseDiscountTaxCompensationInvoiced	String	False	Base discount tax compensation invoiced.
BaseDiscountTaxCompensationRefunded	String	False	Base discount tax compensation refunded.
BaseOriginalPrice	String	False	Base original price.
BasePrice	String	False	Base price.
BasePriceInclTax	String	False	Base price including tax.
BaseRowInvoiced	String	False	Base row invoiced.
BaseRowTotal	String	False	Base row total.
BaseRowTotalInclTax	String	False	Base row total including tax.
BaseTaxAmount	String	False	Base tax amount.
BaseTaxBeforeDiscount	String	False	Base tax before discount.
BaseTaxInvoiced	String	False	Base tax invoiced.
BaseTaxRefunded	String	False	Base tax refunded.
BaseWeeeTaxAppliedAmount	String	False	Base WEEE tax applied amount.
BaseWeeeTaxAppliedRowAmnt	String	False	Base WEEE tax applied row amount.
BaseWeeeTaxDisposition	String	False	Base WEEE tax disposition.
BaseWeeeTaxRowDisposition	String	False	Base WEEE tax row disposition.
CreatedAt	Datetime	False	Created-at timestamp.
Description	String	False	Description.
DiscountAmount	String	False	Discount amount.
DiscountInvoiced	String	False	Discount invoiced.
DiscountPercent	String	False	Discount percent.
DiscountRefunded	String	False	Discount refunded.
DiscountTaxCompensationAmount	String	False	Discount tax compensation amount.
DiscountTaxCompensationCanceled	String	False	Discount tax compensation canceled.
DiscountTaxCompensationInvoiced	String	False	Discount tax compensation invoiced.
DiscountTaxCompensationRefunded	String	False	Discount tax compensation refunded.
ExtensionAttributes	String	False	This is an auto-generated column
ExtOrderItemId	String	False	External order item ID.
FreeShipping	Int	False	Free-shipping flag value.
IsQtyDecimal	Int	False	Is-quantity-decimal flag value.
IsVirtual	Int	False	Is-virtual flag value.
ItemId [KEY]	Int	False	Item ID.
LockedDoInvoice	Int	False	Locked DO invoice flag value.
LockedDoShip	Int	False	Locked DO ship flag value.
Name	String	False	Name.
NoDiscount	Int	False	No-discount flag value.
OrderId	Int	False	Order ID.
OriginalPrice	String	False	Original price.
ParentItem	String	False	This is an auto-generated column
ParentItemId	Int	False	Parent item ID.
Price	String	False	Price.
PriceInclTax	String	False	Price including tax.
ProductId	Int	False	Product ID.
ProductOption	String	False	This is an auto-generated column
ProductType	String	False	Product type.
QtyBackordered	String	False	Quantity backordered.
QtyCanceled	String	False	Quantity canceled.
QtyInvoiced	String	False	Quantity invoiced.
QtyOrdered	String	False	Quantity ordered.
QtyRefunded	String	False	Quantity refunded.
QtyShipped	String	False	Quantity shipped.
QuoteItemId	Int	False	Quote item ID.
RowInvoiced	String	False	Row invoiced.
RowTotal	String	False	Row total.
RowTotalInclTax	String	False	Row total including tax.
RowWeight	String	False	Row weight.
Sku	String	False	SKU.
StoreId	Int	False	Store ID.
TaxAmount	String	False	Tax amount.
TaxBeforeDiscount	String	False	Tax before discount.
TaxCanceled	String	False	Tax canceled.
TaxInvoiced	String	False	Tax invoiced.
TaxPercent	String	False	Tax percent.
TaxRefunded	String	False	Tax refunded.
UpdatedAt	Datetime	False	Updated-at timestamp.
WeeeTaxApplied	String	False	WEEE tax applied.
WeeeTaxAppliedAmount	String	False	WEEE tax applied amount.
WeeeTaxAppliedRowAmount	String	False	WEEE tax applied row amount.
WeeeTaxDisposition	String	False	WEEE tax disposition.
WeeeTaxRowDisposition	String	False	WEEE tax row disposition.
Weight	String	False	Weight.

Pseudo-Columns

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


Name	Type	Description
Id_p	Int	The order item ID.

Orders

Orders is an auto generated table

Select

The Orders table supports server-side processing for all columns in the WHERE clause. Most of these columns support server-side processing for the >, >=, <, <=, =, IN, NOT IN and LIKE operators.

The following examples show the types of queries processed server side.

Retrieve all orders from your Magento server:
```
SELECT * FROM Orders
```

Retrieve a single order:

SELECT * FROM Orders WHERE EntityId = '1'

Filter by status:
```
SELECT * FROM Orders WHERE GroupId = 1
```

Filter by created date:

SELECT * FROM Orders WHERE CreatedAt > '2017-08-01'

Example query with multiple filters:

SELECT * FROM Orders WHERE EntityId IN (1,2) AND CustomerFirstname LIKE '%i%' AND OrderCurrencyCode='USD' LIMIT 50

Insert

You can insert items into an order using an Insert statement. The 'Items' column can be specified using either the temporary table called 'OrderItems#Temp' or as a simple string aggregate. 'Payment' aggregate column is required for Insert and Update operations on this table.

Using the temporary table:

INSERT INTO OrderItems#Temp (BasePrice, Sku) VALUES (299.99, '8915A40K4')
INSERT INTO OrderItems#Temp (BasePrice, Sku) VALUES (100, '7115AP0Z8')
INSERT INTO Orders (GrandTotal, Items, Payment) VALUES (399.99, OrderItems#Temp, '{...your payment aggregate here...}')

Using a text aggregate:

INSERT INTO Orders (GrandTotal, Items, Payment) VALUES (399.99, '{...Items aggregate here...}', '{...Payment aggregate here...}')

You can turn off client-side execution by setting SupportEnhancedSQL to false, in which case any search criteria that refers to any other columns or operators will cause an error.

Columns


Name	Type	ReadOnly	Description
AdjustmentNegative	String	False	Negative adjustment value.
AdjustmentPositive	String	False	Positive adjustment value.
AppliedRuleIds	String	False	Applied rule IDs.
BaseAdjustmentNegative	String	False	Base negative adjustment value.
BaseAdjustmentPositive	String	False	Base positive adjustment value.
BaseCurrencyCode	String	False	Base currency code.
BaseDiscountAmount	String	False	Base discount amount.
BaseDiscountCanceled	String	False	Base discount canceled.
BaseDiscountInvoiced	String	False	Base discount invoiced.
BaseDiscountRefunded	String	False	Base discount refunded.
BaseDiscountTaxCompensationAmount	String	False	Base discount tax compensation amount.
BaseDiscountTaxCompensationInvoiced	String	False	Base discount tax compensation invoiced.
BaseDiscountTaxCompensationRefunded	String	False	Base discount tax compensation refunded.
BaseGrandTotal	String	False	Base grand total.
BaseShippingAmount	String	False	Base shipping amount.
BaseShippingCanceled	String	False	Base shipping canceled.
BaseShippingDiscountAmount	String	False	Base shipping discount amount.
BaseShippingDiscountTaxCompensationAmnt	String	False	Base shipping discount tax compensation amount.
BaseShippingInclTax	String	False	Base shipping including tax.
BaseShippingInvoiced	String	False	Base shipping invoiced.
BaseShippingRefunded	String	False	Base shipping refunded.
BaseShippingTaxAmount	String	False	Base shipping tax amount.
BaseShippingTaxRefunded	String	False	Base shipping tax refunded.
BaseSubtotal	String	False	Base subtotal.
BaseSubtotalCanceled	String	False	Base subtotal canceled.
BaseSubtotalInclTax	String	False	Base subtotal including tax.
BaseSubtotalInvoiced	String	False	Base subtotal invoiced.
BaseSubtotalRefunded	String	False	Base subtotal refunded.
BaseTaxAmount	String	False	Base tax amount.
BaseTaxCanceled	String	False	Base tax canceled.
BaseTaxInvoiced	String	False	Base tax invoiced.
BaseTaxRefunded	String	False	Base tax refunded.
BaseToGlobalRate	String	False	Base-to-global rate.
BaseToOrderRate	String	False	Base-to-order rate.
BaseTotalCanceled	String	False	Base total canceled.
BaseTotalDue	String	False	Base total due.
BaseTotalInvoiced	String	False	Base total invoiced.
BaseTotalInvoicedCost	String	False	Base total invoiced cost.
BaseTotalOfflineRefunded	String	False	Base total offline refunded.
BaseTotalOnlineRefunded	String	False	Base total online refunded.
BaseTotalPaid	String	False	Base total paid.
BaseTotalQtyOrdered	String	False	Base total quantity ordered.
BaseTotalRefunded	String	False	Base total refunded.
BillingAddress	String	False	This is an auto-generated column
BillingAddressId	Int	False	Billing address ID.
CanShipPartially	Int	False	Can-ship-partially flag value.
CanShipPartiallyItem	Int	False	Can-ship-partially-item flag value.
CouponCode	String	False	Coupon code.
CreatedAt	Datetime	False	Created-at timestamp.
CustomerDob	String	False	Customer date-of-birth (DOB).
CustomerEmail	String	False	Customer email address.
CustomerFirstname	String	False	Customer first name.
CustomerGender	Int	False	Customer gender.
CustomerGroupId	Int	False	Customer group ID.
CustomerId	Int	False	Customer ID.
CustomerIsGuest	Int	False	Customer-is-guest flag value.
CustomerLastname	String	False	Customer last name.
CustomerMiddlename	String	False	Customer middle name.
CustomerNote	String	False	Customer note.
CustomerNoteNotify	Int	False	Customer-note-notify flag value.
CustomerPrefix	String	False	Customer prefix.
CustomerSuffix	String	False	Customer suffix.
CustomerTaxvat	String	False	Customer value-added tax (VAT).
DiscountAmount	String	False	Discount amount.
DiscountCanceled	String	False	Discount canceled.
DiscountDescription	String	False	Discount description.
DiscountInvoiced	String	False	Discount invoiced.
DiscountRefunded	String	False	Discount refunded amount.
DiscountTaxCompensationAmount	String	False	Discount tax compensation amount.
DiscountTaxCompensationInvoiced	String	False	Discount tax compensation invoiced amount.
DiscountTaxCompensationRefunded	String	False	Discount tax compensation refunded amount.
EditIncrement	Int	False	Edit increment value.
EmailSent	Int	False	Email-sent flag value.
EntityId	Int	False	Order ID.
ExtCustomerId	String	False	External customer ID.
ExtensionAttributes	String	False	This is an auto-generated column
ExtOrderId	String	False	External order ID.
ForcedShipmentWithInvoice	Int	False	Forced-shipment-with-invoice flag value.
GlobalCurrencyCode	String	False	Global currency code.
GrandTotal	String	False	Grand total.
HoldBeforeState	String	False	Hold before state.
HoldBeforeStatus	String	False	Hold before status.
IncrementId	String	False	Increment ID.
IsVirtual	Int	False	Is-virtual flag value.
OrderCurrencyCode	String	False	Order currency code.
OriginalIncrementId	String	False	Original increment ID.
Payment	String	False	This is an auto-generated column
PaymentAuthExpiration	Int	False	Payment authorization expiration date.
PaymentAuthorizationAmount	String	False	Payment authorization amount.
ProtectCode	String	False	Protect code.
QuoteAddressId	Int	False	Quote address ID.
QuoteId	Int	False	Quote ID.
RelationChildId	String	False	Relation child ID.
RelationChildRealId	String	False	Relation child real ID.
RelationParentId	String	False	Relation parent ID.
RelationParentRealId	String	False	Relation parent real ID.
RemoteIp	String	False	Remote IP address.
ShippingAmount	String	False	Shipping amount.
ShippingCanceled	String	False	Shipping canceled amount.
ShippingDescription	String	False	Shipping description.
ShippingDiscountAmount	String	False	Shipping discount amount.
ShippingDiscountTaxCompensationAmount	String	False	Shipping discount tax compensation amount.
ShippingInclTax	String	False	Shipping including tax amount.
ShippingInvoiced	String	False	Shipping invoiced amount.
ShippingRefunded	String	False	Shipping refunded amount.
ShippingTaxAmount	String	False	Shipping tax amount.
ShippingTaxRefunded	String	False	Shipping tax refunded amount.
State	String	False	State.
Status	String	False	Status.
StatusHistories	String	False	Array of status histories.
StoreCurrencyCode	String	False	Store currency code.
StoreId	Int	False	Store ID.
StoreName	String	False	Store name.
StoreToBaseRate	String	False	Store-to-base rate.
StoreToOrderRate	String	False	Store-to-order rate.
Subtotal	String	False	Subtotal.
SubtotalCanceled	String	False	Subtotal canceled amount.
SubtotalInclTax	String	False	Subtotal including tax amount.
SubtotalInvoiced	String	False	Subtotal invoiced amount.
SubtotalRefunded	String	False	Subtotal refunded amount.
TaxAmount	String	False	Tax amount.
TaxCanceled	String	False	Tax canceled amount.
TaxInvoiced	String	False	Tax invoiced amount.
TaxRefunded	String	False	Tax refunded amount.
TotalCanceled	String	False	Total canceled.
TotalDue	String	False	Total due.
TotalInvoiced	String	False	Total invoiced amount.
TotalItemCount	Int	False	Total item count.
TotalOfflineRefunded	String	False	Total offline refunded amount.
TotalOnlineRefunded	String	False	Total online refunded amount.
TotalPaid	String	False	Total paid.
TotalQtyOrdered	String	False	Total quantity ordered.
TotalRefunded	String	False	Total amount refunded.
UpdatedAt	Datetime	False	Updated-at timestamp.
Weight	String	False	Weight.
XForwardedFor	String	False	X-Forwarded-For field value.

Pseudo-Columns

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


Name	Type	Description
Id_p	Int	The order ID.

PaymentMethods

PaymentMethods is an auto generated table

Columns


Name	Type	ReadOnly	Description
Code [KEY]	String	False	Payment method code
Title	String	False	Payment method title

Pseudo-Columns

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


Name	Type	Description
CartId_p	Int	The cart ID.

PaymentSelectedMethods

PaymentSelectedMethods is an auto generated table

Columns


Name	Type	ReadOnly	Description
AdditionalData	String	False	Payment additional details
ExtensionAttributes	String	False	This is an auto-generated column
Method [KEY]	String	False	Payment method code
PoNumber	String	False	Purchase order number

Pseudo-Columns

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


Name	Type	Description
CartId_p	Int	The cart ID.

ProductAttributeGroup

ProductAttributeGroup is an auto generated table

Columns


Name	Type	ReadOnly	Description
AttributeGroupId [KEY]	String	False	Id
AttributeGroupName	String	False	Name
AttributeSetId	Int	False	Attribute set id
ExtensionAttributes	String	False	This is an auto-generated column

Pseudo-Columns

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


Name	Type	Description
GroupId_p	Int	This is an auto-generated column
AttributeSetId_p	String	This is an auto-generated column

ProductAttributeOptions

ProductAttributeOptions is an auto generated table

Columns


Name	Type	ReadOnly	Description
IsDefault	Bool	False	Default
Label [KEY]	String	False	Option label
SortOrder	Int	False	Option order
StoreLabels	String	False	Option label for store scopes
Value	String	False	Option value

Pseudo-Columns

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


Name	Type	Description
AttributeCode_p	String	This is an auto-generated column

ProductAttributes

ProductAttributes is an auto generated table

Columns


Name	Type	ReadOnly	Description
ApplyTo	String	False	Apply to value for the element
AttributeCode	String	False	Code of the attribute.
AttributeId [KEY]	Int	False	Id of the attribute.
BackendModel	String	False	Backend model
BackendType	String	False	Backend type.
DefaultFrontendLabel	String	False	Frontend label for default store
DefaultValue	String	False	Default value for the element.
EntityTypeId	String	False	Entity type id
ExtensionAttributes	String	False	This is an auto-generated column
FrontendClass	String	False	Frontend class of attribute
FrontendInput	String	False	HTML for input element.
FrontendLabels	String	False	Frontend label for each store
IsComparable	String	False	The attribute can be compared on the frontend
IsFilterable	Bool	False	It used in layered navigation
IsFilterableInGrid	Bool	False	It is filterable in catalog product grid
IsFilterableInSearch	Bool	False	It is used in search results layered navigation
IsHtmlAllowedOnFront	Bool	False	The HTML tags are allowed on the frontend
IsRequired	Bool	False	Attribute is required.
IsSearchable	String	False	The attribute can be used in Quick Search
IsUnique	String	False	This is a unique attribute
IsUsedForPromoRules	String	False	The attribute can be used for promo rules
IsUsedInGrid	Bool	False	It is used in catalog product grid
IsUserDefined	Bool	False	Current attribute has been defined by a user.
IsVisible	Bool	False	Attribute is visible on frontend.
IsVisibleInAdvancedSearch	String	False	The attribute can be used in Advanced Search
IsVisibleInGrid	Bool	False	It is visible in catalog product grid
IsVisibleOnFront	String	False	The attribute is visible on the frontend
IsWysiwygEnabled	Bool	False	WYSIWYG flag
Note	String	False	The note attribute for the element.
Options	String	False	Options of the attribute (key => value pairs for select)
Position	Int	False	Position
Scope	String	False	Attribute scope
SourceModel	String	False	Source model
UsedForSortBy	Bool	False	It is used for sorting in product listing
UsedInProductListing	String	False	The attribute can be used in product listing
ValidationRules	String	False	Validation rules.

Pseudo-Columns

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


Name	Type	Description
AttributeSetId_p	String	This is an auto-generated column

ProductCategories

ProductCategories is an auto generated table

Select

The CategoryId_p column can be used to filter data within this table. The CategoryId_p can be used only with the equals (=) operator.

The Sync App will use the Magento API to filter the results by CategoryId_p while the rest of the filter is executed client side within the Sync App.

The following examples show the types of queries processed server side.

Retrieve all product categories:
```
SELECT * FROM ProductCategories
```
Retrieve detailed information about a single product category:
```
SELECT * FROM ProductCategories WHERE Id = 1
```

You can turn off client-side execution by setting SupportEnhancedSQL to false, in which case any search criteria that refers to any other columns will cause an error.

Insert

The Name and IsActive columns are required to create a new category.

INSERT INTO ProductCategories(Name, IsActive, Position) VALUES ('New category', '1', '0')

Update

To update a category, you must set the Id column.

UPDATE ProductCategories SET Name = 'New category', IsActive = 1 WHERE Id = 1

Delete

Product categories can be deleted by providing the Id column.

DELETE FROM ProductCategories WHERE Id = 1

Columns


Name	Type	ReadOnly	Description
Id [KEY]	Int	False	This is an auto-generated column
AvailableSortBy	String	False	This is an auto-generated column
Children	String	False	This is an auto-generated column
CreatedAt	Datetime	False	This is an auto-generated column
ExtensionAttributes	String	False	This is an auto-generated column
IncludeInMenu	Bool	False	This is an auto-generated column
IsActive	Bool	False	Whether category is active
Level	Int	False	Category level
Name	String	False	Category name
ParentId	Int	False	Parent category ID
Path	String	False	This is an auto-generated column
Position	Int	False	Category position
UpdatedAt	Datetime	False	This is an auto-generated column
ChildrenData	String	False	This is an auto-generated column
ProductCount	Int	False	Product count

Pseudo-Columns

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


Name	Type	Description
CategoryId_p	Int	This is an auto-generated column
Id_p	String	This is an auto-generated column

ProductCustomOption

ProductCustomOption is an auto generated table

Columns


Name	Type	ReadOnly	Description
ExtensionAttributes	String	False	This is an auto-generated column
FileExtension	String	False	This is an auto-generated column
ImageSizeX	Int	False	This is an auto-generated column
ImageSizeY	Int	False	This is an auto-generated column
IsRequire	Bool	False	Is require
MaxCharacters	Int	False	This is an auto-generated column
OptionId [KEY]	Int	False	Option id
Price	String	False	Price
PriceType	String	False	Price type
ProductSku	String	False	Product SKU
Sku	String	False	Sku
SortOrder	Int	False	Sort order
Title	String	False	Option title
Type	String	False	Option type
Values	String	False	This is an auto-generated column

Pseudo-Columns

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


Name	Type	Description
OptionId_p	String	This is an auto-generated column
Sku_p	String	This is an auto-generated column

ProductMedia

ProductMedia is an auto generated table

Select

You must specify the Sku_p column in the WHERE clause to retrieve results from ProductMedia. Sku_p can be used only with the equals (=) operator.

The Sync App will use the Magento API to filter the results by Sku_p while the rest of the filter is executed client side within the Sync App. For example, the following query is processed server side:

SELECT * FROM [ProductMedia] WHERE Sku = 'sjl-8082'

You can turn off client-side execution by setting SupportEnhancedSQL to false, in which case any search criteria that refers to any other columns will cause an error.

Update

To update a ProductMedia record, you must set Sku and EntryId (refers to the Id column).

UPDATE ProductMedia SET Label = 'lbl new' WHERE EntryId = '1' AND Sku = 'sjl-8082'

Delete

Product media can be deleted by providing Sku_p and EntryId_p (refers to the Id column).

DELETE FROM ProductMedia WHERE EntryId = 1 AND Sky = 'sjl-8082'

Columns


Name	Type	ReadOnly	Description
Id [KEY]	Int	False	Gallery entry ID
Content	String	False	This is an auto-generated column
Disabled	Bool	False	If gallery entry is hidden from product page
ExtensionAttributes	String	False	This is an auto-generated column
File	String	False	File path
Label	String	False	Gallery entry alternative text
MediaType	String	False	Media type
Position	Int	False	Gallery entry position (sort order)
Types	String	False	Gallery entry image types (thumbnail, image, small_image etc)

Pseudo-Columns

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


Name	Type	Description
Sku_p	String	This is an auto-generated column
EntryId_p	Int	This is an auto-generated column

Products

Products is an auto generated table

Select

Custom Attributes will be dynamically retrieved as columns when querying this table. The Products table supports server-side processing for all columns in the WHERE clause. Most of these columns support server-side processing for the >, >=, <, <=, =, IN, NOT IN and LIKE operators.

The Sync App will use the Magento API to filter the results with these operators while the rest of the filter is executed client side within the provider. You can turn off client-side execution by setting SupportEnhancedSQL to false in which case any search criteria that invokes other operators will cause an error.

The following examples show the types of queries processed server side.

Retrieve all products from your Magento server:
```
SELECT * FROM Products
```

Retrieve a single product:

SELECT * FROM Products WHERE Sku = 'sjl-8082'

Filter by status:
```
SELECT * FROM Products WHERE Status = 1
```

Filter by created date:

SELECT * FROM Products WHERE CreatedAt > '2017-08-01'

Example query with multiple filters:

SELECT * FROM Products WHERE Id IN (250,260) AND Name LIKE '%d%' AND Visibility = 4 LIMIT 50

You can turn off client-side execution by setting SupportEnhancedSQL to false, in which case any search criteria that refers to any other columns will cause an error.

Insert

To create a new product, Name, AttributeSetId, and Sku are required.

INSERT INTO Products(Sku, AttributeSetId, Name) VALUES ('sjl-1999', '4', 'insert prod')

Update

To update a product, you must set the Sku and Price columns.

UPDATE Products SET Price = '88', CustomAttribute1='ValidValue' WHERE Sku = 'sjl-1999'

Delete

Products can be deleted by providing the Sku column.

DELETE FROM Products WHERE Sku = 'sjl-1999'

Columns


Name	Type	ReadOnly	Description
Id	Int	False	Id
AttributeSetId	Int	False	Attribute set id
CreatedAt	Datetime	False	Created date
ExtensionAttributes	String	False	This is an auto-generated column
MediaGalleryEntries	String	False	Media gallery entries
Name	String	False	Name
Options	String	False	List of product options
Price	String	False	Price
ProductLinks	String	False	Product links info
Sku [KEY]	String	False	Sku
Status	Int	False	Status
TierPrices	String	False	List of product tier prices
TypeId	String	False	Type id
UpdatedAt	Datetime	False	Updated date
Visibility	Int	False	Visibility
Weight	String	False	Weight
CustomAttribute1	String	False	A custom attribute created for the Products. The custom fields will be listed dynamically.
CustomAttribute2	String	False	A custom attribute created for the Products. The custom fields will be listed dynamically.

Pseudo-Columns

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


Name	Type	Description
Sku_p	String	This is an auto-generated column

QuoteCart

QuoteCart is an auto generated table

Columns


Name	Type	ReadOnly	Description
Id [KEY]	Int	False	Cart/quote ID.
BillingAddress	String	False	This is an auto-generated column
ConvertedAt	String	False	Cart conversion date and time. Otherwise, null.
CreatedAt	Datetime	False	Cart creation date and time. Otherwise, null.
Currency	String	False	This is an auto-generated column
Customer	String	False	This is an auto-generated column
CustomerIsGuest	Bool	False	For guest customers, false for logged in customers
CustomerNote	String	False	Notice text
CustomerNoteNotify	Bool	False	Customer notification flag
CustomerTaxClassId	Int	False	Customer tax class ID.
ExtensionAttributes	String	False	This is an auto-generated column
IsActive	Bool	False	Active status flag value. Otherwise, null.
IsVirtual	Bool	False	Virtual flag value. Otherwise, null.
ItemsCount	Int	False	Number of different items or products in the cart. Otherwise, null.
ItemsQty	String	False	Total quantity of all cart items. Otherwise, null.
OrigOrderId	Int	False	Original order ID. Otherwise, null.
ReservedOrderId	Int	False	Reserved order ID. Otherwise, null.
StoreId	Int	False	Store identifier
UpdatedAt	Datetime	False	Cart last update date and time. Otherwise, null.

Pseudo-Columns

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


Name	Type	Description
CartId_p	Int	This is an auto-generated column

QuoteCartItem

QuoteCartItem is an auto generated table

Columns


Name	Type	ReadOnly	Description
ExtensionAttributes	String	False	This is an auto-generated column
ItemId	Int	False	Item ID. Otherwise, null.
Name	String	False	Product name. Otherwise, null.
Price	String	False	Product price. Otherwise, null.
ProductOption	String	False	This is an auto-generated column
ProductType	String	False	Product type. Otherwise, null.
Qty	String	False	Product quantity.
QuoteId [KEY]	String	False	Quote id.
Sku	String	False	Product SKU. Otherwise, null.

Pseudo-Columns

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


Name	Type	Description
ItemId_p	String	This is an auto-generated column
CartId_p	Int	The cart ID.
QuoteId_p	String	This is an auto-generated column

QuoteCartTotal

QuoteCartTotal is an auto generated table

Columns


Name	Type	ReadOnly	Description
BaseCurrencyCode	String	False	Base currency code
BaseDiscountAmount	String	False	Discount amount in base currency
BaseGrandTotal	String	False	Grand total in base currency
BaseShippingAmount	String	False	Shipping amount in base currency
BaseShippingDiscountAmount	String	False	Shipping discount amount in base currency
BaseShippingInclTax	String	False	Shipping including tax in base currency
BaseShippingTaxAmount	String	False	Shipping tax amount in base currency
BaseSubtotal	String	False	Subtotal in base currency
BaseSubtotalInclTax	String	False	Subtotal including tax in base currency
BaseSubtotalWithDiscount	String	False	Subtotal in base currency with applied discount
BaseTaxAmount	String	False	Tax amount in base currency
CouponCode	String	False	Applied coupon code
DiscountAmount	String	False	Discount amount in quote currency
ExtensionAttributes	String	False	This is an auto-generated column
GrandTotal	String	False	Grand total in quote currency
ItemsQty	Int	False	Items qty
QuoteCurrencyCode	String	False	Quote currency code
ShippingAmount	String	False	Shipping amount in quote currency
ShippingDiscountAmount	String	False	Shipping discount amount in quote currency
ShippingInclTax	String	False	Shipping including tax in quote currency
ShippingTaxAmount	String	False	Shipping tax amount in quote currency
Subtotal	String	False	Subtotal in quote currency
SubtotalInclTax	String	False	Subtotal including tax in quote currency
SubtotalWithDiscount	String	False	Subtotal in quote currency with applied discount
TaxAmount	String	False	Tax amount in quote currency
TotalSegments	String	False	Dynamically calculated totals
WeeeTaxAppliedAmount	String	False	Item weee tax applied amount in quote currency.

Pseudo-Columns

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


Name	Type	Description
CartId_p	Int	The cart ID.

QuoteGuestCart

QuoteGuestCart is an auto generated table

Columns


Name	Type	ReadOnly	Description
Id [KEY]	Int	False	Cart/quote ID.
BillingAddress	String	False	This is an auto-generated column
ConvertedAt	String	False	Cart conversion date and time. Otherwise, null.
CreatedAt	Datetime	False	Cart creation date and time. Otherwise, null.
Currency	String	False	This is an auto-generated column
Customer	String	False	This is an auto-generated column
CustomerIsGuest	Bool	False	For guest customers, false for logged in customers
CustomerNote	String	False	Notice text
CustomerNoteNotify	Bool	False	Customer notification flag
CustomerTaxClassId	Int	False	Customer tax class ID.
ExtensionAttributes	String	False	This is an auto-generated column
IsActive	Bool	False	Active status flag value. Otherwise, null.
IsVirtual	Bool	False	Virtual flag value. Otherwise, null.
ItemsCount	Int	False	Number of different items or products in the cart. Otherwise, null.
ItemsQty	String	False	Total quantity of all cart items. Otherwise, null.
OrigOrderId	Int	False	Original order ID. Otherwise, null.
ReservedOrderId	Int	False	Reserved order ID. Otherwise, null.
StoreId	Int	False	Store identifier
UpdatedAt	Datetime	False	Cart last update date and time. Otherwise, null.

Pseudo-Columns

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


Name	Type	Description
CartId_p	String	This is an auto-generated column

QuoteGuestCartItem

QuoteGuestCartItem is an auto generated table

Columns


Name	Type	ReadOnly	Description
ExtensionAttributes	String	False	This is an auto-generated column
ItemId	Int	False	Item ID. Otherwise, null.
Name	String	False	Product name. Otherwise, null.
Price	String	False	Product price. Otherwise, null.
ProductOption	String	False	This is an auto-generated column
ProductType	String	False	Product type. Otherwise, null.
Qty	String	False	Product quantity.
QuoteId [KEY]	String	False	Quote id.
Sku	String	False	Product SKU. Otherwise, null.

Pseudo-Columns

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


Name	Type	Description
CartId_p	String	This is an auto-generated column
ItemId_p	String	This is an auto-generated column

QuoteGuestCartTotal

QuoteGuestCartTotal is an auto generated table

Columns


Name	Type	ReadOnly	Description
BaseCurrencyCode	String	False	Base currency code
BaseDiscountAmount	String	False	Discount amount in base currency
BaseGrandTotal	String	False	Grand total in base currency
BaseShippingAmount	String	False	Shipping amount in base currency
BaseShippingDiscountAmount	String	False	Shipping discount amount in base currency
BaseShippingInclTax	String	False	Shipping including tax in base currency
BaseShippingTaxAmount	String	False	Shipping tax amount in base currency
BaseSubtotal	String	False	Subtotal in base currency
BaseSubtotalInclTax	String	False	Subtotal including tax in base currency
BaseSubtotalWithDiscount	String	False	Subtotal in base currency with applied discount
BaseTaxAmount	String	False	Tax amount in base currency
CouponCode	String	False	Applied coupon code
DiscountAmount	String	False	Discount amount in quote currency
ExtensionAttributes	String	False	This is an auto-generated column
GrandTotal	String	False	Grand total in quote currency
ItemsQty	Int	False	Items qty
QuoteCurrencyCode	String	False	Quote currency code
ShippingAmount	String	False	Shipping amount in quote currency
ShippingDiscountAmount	String	False	Shipping discount amount in quote currency
ShippingInclTax	String	False	Shipping including tax in quote currency
ShippingTaxAmount	String	False	Shipping tax amount in quote currency
Subtotal	String	False	Subtotal in quote currency
SubtotalInclTax	String	False	Subtotal including tax in quote currency
SubtotalWithDiscount	String	False	Subtotal in quote currency with applied discount
TaxAmount	String	False	Tax amount in quote currency
TotalSegments	String	False	Dynamically calculated totals
WeeeTaxAppliedAmount	String	False	Item weee tax applied amount in quote currency.

Pseudo-Columns

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


Name	Type	Description
CartId_p	String	The cart ID.

SalesCreditmemo

SalesCreditmemo is an auto generated table

Columns


Name	Type	ReadOnly	Description
Adjustment	String	False	Credit memo adjustment.
AdjustmentNegative	String	False	Credit memo negative adjustment.
AdjustmentPositive	String	False	Credit memo positive adjustment.
BaseAdjustment	String	False	Credit memo base adjustment.
BaseAdjustmentNegative	String	False	Credit memo negative base adjustment.
BaseAdjustmentPositive	String	False	Credit memo positive base adjustment.
BaseCurrencyCode	String	False	Credit memo base currency code.
BaseDiscountAmount	String	False	Credit memo base discount amount.
BaseDiscountTaxCompensationAmount	String	False	Credit memo base discount tax compensation amount.
BaseGrandTotal	String	False	Credit memo base grand total.
BaseShippingAmount	String	False	Credit memo base shipping amount.
BaseShippingDiscountTaxCompensationAmnt	String	False	Credit memo base shipping discount tax compensation amount.
BaseShippingInclTax	String	False	Credit memo base shipping including tax.
BaseShippingTaxAmount	String	False	Credit memo base shipping tax amount.
BaseSubtotal	String	False	Credit memo base subtotal.
BaseSubtotalInclTax	String	False	Credit memo base subtotal including tax.
BaseTaxAmount	String	False	Credit memo base tax amount.
BaseToGlobalRate	String	False	Credit memo base-to-global rate.
BaseToOrderRate	String	False	Credit memo base-to-order rate.
BillingAddressId	Int	False	Credit memo billing address ID.
Comments	String	False	Array of any credit memo comments. Otherwise, null.
CreatedAt	Datetime	False	Credit memo created-at timestamp.
CreditmemoStatus	Int	False	Credit memo status.
DiscountAmount	String	False	Credit memo discount amount.
DiscountDescription	String	False	Credit memo discount description.
DiscountTaxCompensationAmount	String	False	Credit memo discount tax compensation amount.
EmailSent	Int	False	Credit memo email sent flag value.
EntityId [KEY]	Int	False	Credit memo ID.
ExtensionAttributes	String	False	This is an auto-generated column
GlobalCurrencyCode	String	False	Credit memo global currency code.
GrandTotal	String	False	Credit memo grand total.
IncrementId	String	False	Credit memo increment ID.
InvoiceId	Int	False	Credit memo invoice ID.
OrderCurrencyCode	String	False	Credit memo order currency code.
OrderId	Int	False	Credit memo order ID.
ShippingAddressId	Int	False	Credit memo shipping address ID.
ShippingAmount	String	False	Credit memo shipping amount.
ShippingDiscountTaxCompensationAmount	String	False	Credit memo shipping discount tax compensation amount.
ShippingInclTax	String	False	Credit memo shipping including tax.
ShippingTaxAmount	String	False	Credit memo shipping tax amount.
State	Int	False	Credit memo state.
StoreCurrencyCode	String	False	Credit memo store currency code.
StoreId	Int	False	Credit memo store ID.
StoreToBaseRate	String	False	Credit memo store-to-base rate.
StoreToOrderRate	String	False	Credit memo store-to-order rate.
Subtotal	String	False	Credit memo subtotal.
SubtotalInclTax	String	False	Credit memo subtotal including tax.
TaxAmount	String	False	Credit memo tax amount.
TransactionId	String	False	Credit memo transaction ID.
UpdatedAt	Datetime	False	Credit memo updated-at timestamp.

Pseudo-Columns

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


Name	Type	Description
Id_p	Int	The credit memo ID.

SalesCreditmemoComments

SalesCreditmemoComments is an auto generated table

Columns


Name	Type	ReadOnly	Description
Comment	String	False	Comment.
CreatedAt	Datetime	False	Created-at timestamp.
EntityId [KEY]	Int	False	Credit memo ID.
ExtensionAttributes	String	False	This is an auto-generated column
IsCustomerNotified	Int	False	Is-customer-notified flag value.
IsVisibleOnFront	Int	False	Is-visible-on-storefront flag value.
ParentId	Int	False	Parent ID.

Pseudo-Columns

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


Name	Type	Description
Id_p	Int	The credit memo ID.

SalesInvoice

SalesInvoice is an auto generated table

Columns


Name	Type	ReadOnly	Description
BaseCurrencyCode	String	False	Base currency code.
BaseDiscountAmount	String	False	Base discount amount.
BaseDiscountTaxCompensationAmount	String	False	Base discount tax compensation amount.
BaseGrandTotal	String	False	Base grand total.
BaseShippingAmount	String	False	Base shipping amount.
BaseShippingDiscountTaxCompensationAmnt	String	False	Base shipping discount tax compensation amount.
BaseShippingInclTax	String	False	Base shipping including tax.
BaseShippingTaxAmount	String	False	Base shipping tax amount.
BaseSubtotal	String	False	Base subtotal.
BaseSubtotalInclTax	String	False	Base subtotal including tax.
BaseTaxAmount	String	False	Base tax amount.
BaseToGlobalRate	String	False	Base-to-global rate.
BaseToOrderRate	String	False	Base-to-order rate.
BaseTotalRefunded	String	False	Base total refunded.
BillingAddressId	Int	False	Billing address ID.
CanVoidFlag	Int	False	Can void flag value.
Comments	String	False	Array of any invoice comments. Otherwise, null.
CreatedAt	Datetime	False	Created-at timestamp.
DiscountAmount	String	False	Discount amount.
DiscountDescription	String	False	Discount description.
DiscountTaxCompensationAmount	String	False	Discount tax compensation amount.
EmailSent	Int	False	Email-sent flag value.
EntityId [KEY]	Int	False	Invoice ID.
ExtensionAttributes	String	False	This is an auto-generated column
GlobalCurrencyCode	String	False	Global currency code.
GrandTotal	String	False	Grand total.
IncrementId	String	False	Increment ID.
IsUsedForRefund	Int	False	Is-used-for-refund flag value.
OrderCurrencyCode	String	False	Order currency code.
OrderId	Int	False	Order ID.
ShippingAddressId	Int	False	Shipping address ID.
ShippingAmount	String	False	Shipping amount.
ShippingDiscountTaxCompensationAmount	String	False	Shipping discount tax compensation amount.
ShippingInclTax	String	False	Shipping including tax.
ShippingTaxAmount	String	False	Shipping tax amount.
State	Int	False	State.
StoreCurrencyCode	String	False	Store currency code.
StoreId	Int	False	Store ID.
StoreToBaseRate	String	False	Store-to-base rate.
StoreToOrderRate	String	False	Store-to-order rate.
Subtotal	String	False	Subtotal.
SubtotalInclTax	String	False	Subtotal including tax.
TaxAmount	String	False	Tax amount.
TotalQty	String	False	Total quantity.
TransactionId	String	False	Transaction ID.
UpdatedAt	Datetime	False	Updated-at timestamp.

Pseudo-Columns

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


Name	Type	Description
Id_p	Int	The invoice ID.

SalesInvoiceComments

SalesInvoiceComments is an auto generated table

Columns


Name	Type	ReadOnly	Description
Comment	String	False	Comment.
CreatedAt	Datetime	False	Created-at timestamp.
EntityId [KEY]	Int	False	Invoice ID.
ExtensionAttributes	String	False	This is an auto-generated column
IsCustomerNotified	Int	False	Is-customer-notified flag value.
IsVisibleOnFront	Int	False	Is-visible-on-storefront flag value.
ParentId	Int	False	Parent ID.

Pseudo-Columns

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


Name	Type	Description
Id_p	Int	The invoice ID.

SalesRule

SalesRule is an auto generated table

Columns


Name	Type	ReadOnly	Description
ActionCondition	String	False	This is an auto-generated column
ApplyToShipping	Bool	False	The rule applies to shipping
Condition	String	False	This is an auto-generated column
CouponType	String	False	Coupon type
CustomerGroupIds	String	False	Ids of customer groups that the rule applies to
Description	String	False	Description
DiscountAmount	String	False	Discount amount
DiscountQty	String	False	Maximum qty discount is applied
DiscountStep	Int	False	Discount step
ExtensionAttributes	String	False	This is an auto-generated column
FromDate	String	False	The start date when the coupon is active
IsActive	Bool	False	The coupon is active
IsAdvanced	Bool	False	Is this field needed
IsRss	Bool	False	Whether the rule is in RSS
Name	String	False	Rule name
ProductIds	String	False	Product ids
RuleId [KEY]	Int	False	Rule id
SimpleAction	String	False	Simple action of the rule
SimpleFreeShipping	String	False	To grant free shipping
SortOrder	Int	False	Sort order
StopRulesProcessing	Bool	False	To stop rule processing
StoreLabels	String	False	Display label
TimesUsed	Int	False	How many times the rule has been used
ToDate	String	False	The end date when the coupon is active
UseAutoGeneration	Bool	False	To auto generate coupon
UsesPerCoupon	Int	False	Limit of uses per coupon
UsesPerCustomer	Int	False	Number of uses per customer
WebsiteIds	String	False	A list of websites the rule applies to

Pseudo-Columns

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


Name	Type	Description
RuleId_p	Int	This is an auto-generated column

SalesRuleCoupon

SalesRuleCoupon is an auto generated table

Columns


Name	Type	ReadOnly	Description
Code	String	False	Coupon code
CouponId [KEY]	Int	False	Coupon id
CreatedAt	Datetime	False	When the coupon is created
ExpirationDate	String	False	Expiration date
ExtensionAttributes	String	False	This is an auto-generated column
IsPrimary	Bool	False	The coupon is primary coupon for the rule that it's associated with
RuleId	Int	False	The id of the rule associated with the coupon
TimesUsed	Int	False	The number of times the coupon has been used
Type	Int	False	Of coupon
UsageLimit	Int	False	Usage limit
UsagePerCustomer	Int	False	Usage limit per customer

Pseudo-Columns

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


Name	Type	Description
CouponId_p	Int	This is an auto-generated column

SalesShipment

SalesShipment is an auto generated table

Columns


Name	Type	ReadOnly	Description
BillingAddressId	Int	False	Billing address ID.
Comments	String	False	Array of comments.
CreatedAt	Datetime	False	Created-at timestamp.
CustomerId	Int	False	Customer ID.
EmailSent	Int	False	Email-sent flag value.
EntityId [KEY]	Int	False	Shipment ID.
ExtensionAttributes	String	False	This is an auto-generated column
IncrementId	String	False	Increment ID.
OrderId	Int	False	Order ID.
Packages	String	False	Array of packages, if any. Otherwise, null.
ShipmentStatus	Int	False	Shipment status.
ShippingAddressId	Int	False	Shipping address ID.
ShippingLabel	String	False	Shipping label.
StoreId	Int	False	Store ID.
TotalQty	String	False	Total quantity.
TotalWeight	String	False	Total weight.
Tracks	String	False	Array of tracks.
UpdatedAt	Datetime	False	Updated-at timestamp.

Pseudo-Columns

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


Name	Type	Description
Id_p	Int	The shipment ID.

SalesShipmentComments

SalesShipmentComments is an auto generated table

Columns


Name	Type	ReadOnly	Description
Comment	String	False	Comment.
CreatedAt	Datetime	False	Created-at timestamp.
EntityId [KEY]	Int	False	Shipment comment ID.
ExtensionAttributes	String	False	This is an auto-generated column
IsCustomerNotified	Int	False	Is-customer-notified flag value.
IsVisibleOnFront	Int	False	Is-visible-on-storefront flag value.
ParentId	Int	False	Parent ID.

Pseudo-Columns

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


Name	Type	Description
Id_p	Int	The shipment ID.

SalesTransaction

SalesTransaction is an auto generated table

Columns


Name	Type	ReadOnly	Description
AdditionalInformation	String	False	Array of additional information. Otherwise, null.
ChildTransactions	String	False	Array of child transactions.
CreatedAt	Datetime	False	Created-at timestamp.
ExtensionAttributes	String	False	This is an auto-generated column
IsClosed	Int	False	Is-closed flag value.
OrderId	Int	False	Order ID.
ParentId	Int	False	The parent ID for the transaction. Otherwise, null.
ParentTxnId	String	False	Parent transaction business ID.
PaymentId	Int	False	Payment ID.
TransactionId [KEY]	Int	False	Transaction ID.
TxnId	String	False	Transaction business ID.
TxnType	String	False	Transaction type.

Pseudo-Columns

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


Name	Type	Description
Id_p	Int	The transaction ID.

ShippingMethods

ShippingMethods is an auto generated table

Columns


Name	Type	ReadOnly	Description
Amount	String	False	Shipping amount in store currency.
Available	Bool	False	The value of the availability flag for the current shipping method.
BaseAmount	String	False	Shipping amount in base currency.
CarrierCode	String	False	Shipping carrier code.
CarrierTitle	String	False	Shipping carrier title. Otherwise, null.
ErrorMessage	String	False	Shipping Error message.
ExtensionAttributes	String	False	This is an auto-generated column
MethodCode [KEY]	String	False	Shipping method code.
MethodTitle	String	False	Shipping method title. Otherwise, null.
PriceExclTax	String	False	Shipping price excl tax.
PriceInclTax	String	False	Shipping price incl tax.

Pseudo-Columns

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


Name	Type	Description
CartId_p	Int	The shopping cart ID.

StoreGroup

StoreGroup is an auto generated table

Columns


Name	Type	ReadOnly	Description
Id [KEY]	Int	False	This is an auto-generated column
DefaultStoreId	Int	False	This is an auto-generated column
ExtensionAttributes	String	False	This is an auto-generated column
Name	String	False	This is an auto-generated column
RootCategoryId	Int	False	This is an auto-generated column
WebsiteId	Int	False	This is an auto-generated column

Stores

Stores is an auto generated table

Columns


Name	Type	ReadOnly	Description
Id [KEY]	Int	False	This is an auto-generated column
Code	String	False	This is an auto-generated column
ExtensionAttributes	String	False	This is an auto-generated column
Name	String	False	Store name
StoreGroupId	Int	False	This is an auto-generated column
WebsiteId	Int	False	This is an auto-generated column

StoreWebsite

StoreWebsite is an auto generated table

Columns


Name	Type	ReadOnly	Description
Id [KEY]	Int	False	This is an auto-generated column
Code	String	False	This is an auto-generated column
DefaultGroupId	Int	False	This is an auto-generated column
ExtensionAttributes	String	False	This is an auto-generated column
Name	String	False	Website name

TaxClass

TaxClass is an auto generated table

Columns


Name	Type	ReadOnly	Description
ClassId [KEY]	Int	False	Tax class ID.
ClassName	String	False	Tax class name.
ClassType	String	False	Tax class type.
ExtensionAttributes	String	False	This is an auto-generated column

Pseudo-Columns

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


Name	Type	Description
ClassId_p	String	This is an auto-generated column
TaxClassId_p	Int	This is an auto-generated column

TaxRate

TaxRate is an auto generated table

Columns


Name	Type	ReadOnly	Description
Id [KEY]	Int	False	Id
Code	String	False	Tax rate code
ExtensionAttributes	String	False	This is an auto-generated column
Rate	String	False	Tax rate in percentage
RegionName	String	False	Region name
TaxCountryId	String	False	Country id
TaxPostcode	String	False	Postcode
TaxRegionId	Int	False	Region id
Titles	String	False	Tax rate titles
ZipFrom	Int	False	Zip range from
ZipIsRange	Int	False	Zip is range
ZipTo	Int	False	Zip range to

TaxRule

TaxRule is an auto generated table

Columns


Name	Type	ReadOnly	Description
Id [KEY]	Int	False	Id
CalculateSubtotal	Bool	False	Calculate subtotal.
Code	String	False	Tax rule code
CustomerTaxClassIds	String	False	Customer tax class id
ExtensionAttributes	String	False	This is an auto-generated column
Position	Int	False	Sort order.
Priority	Int	False	Priority
ProductTaxClassIds	String	False	Product tax class id
TaxRateIds	String	False	Tax rate ids

ビュー

ビューは、カラムと疑似カラムで構成されます。ビューは、データを示すという点でテーブルに似ていますが、ビューでは更新はサポートされません。通常、ビューとして表されるエンティティは、読み取り専用のエンティティです。多くの場合、これらのデータはストアドプロシージャを使用することで更新できます（その機能がデータソースに適用できる場合）。

ビューに対しては、通常のテーブルと同じようにクエリを実行でき、このときに返されるデータも同様です。

ビューとして公開されるクエリなどの動的ビューや、project_team ワークアイテムの特定の組み合わせを検索するためのビューがサポートされています。

Magento Connector for CData Sync ビュー


Name	Description
BillingAddresses	BillingAddresses is an auto generated table

BillingAddresses

BillingAddresses is an auto generated table

Columns


Name	Type	Description
Id [KEY]	Int	Id
City	String	City name
Company	String	Company
CountryId	String	Country id
CustomerAddressId	Int	Customer address id
CustomerId	Int	Customer id
Email	String	Billing/shipping email
ExtensionAttributes	String	This is an auto-generated column
Fax	String	Fax number
Firstname	String	First name
Lastname	String	Last name
Middlename	String	Middle name
Postcode	String	Postcode
Prefix	String	Prefix
Region	String	Region name
RegionCode	String	Region code
RegionId	Int	Region id
SameAsBilling	Int	Same as billing flag
SaveInAddressBook	Int	Save in address book flag
Street	String	Street
Suffix	String	Suffix
Telephone	String	Telephone number
VatId	String	Vat id
CartId	Int	The ID of the Cart for which you want to retrieve the BillingAddresses for.

接続文字列オプション

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

接続を確立する方法について詳しくは、接続の確立を参照してください。

Authentication

プロパティ	説明
AuthScheme	The type of authentication to use when connecting to Magento 2.x.
URL	Set the URL to the HTTP or HTTPS endpoint of your Magento system. For example, https://magentohost/. We should not append magento2 as suffix in the url if you are connecting to cloud instance.
User	Username of the currently authenticated user. Used to connect to Magento 2.x servers only.
Password	Password of the currently authenticated User . Used to connect to Magento 2.x servers.
AccessToken	The Magento Access Token.
StoreCode	Specifies the code of the store against which the API requests are executed.

SSL

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

Firewall

プロパティ	説明
FirewallType	プロキシベースのファイアウォールで使われるプロトコル。
FirewallServer	プロキシベースのファイアウォールの名前もしくはIP アドレス。
FirewallPort	プロキシベースのファイアウォールのTCP ポート。
FirewallUser	プロキシベースのファイアウォールに認証するために使うユーザー名。
FirewallPassword	プロキシベースのファイアウォールへの認証に使われるパスワード。

Proxy

プロパティ	説明
ProxyAutoDetect	これは、システムプロキシ設定を使用するかどうかを示します。これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。
ProxyServer	HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。
ProxyPort	ProxyServer プロキシが起動しているTCP ポート。
ProxyAuthScheme	ProxyServer プロキシへの認証で使われる認証タイプ。
ProxyUser	ProxyServer プロキシへの認証に使われるユーザー名。
ProxyPassword	ProxyServer プロキシへの認証に使われるパスワード。
ProxySSLType	ProxyServer プロキシへの接続時に使用するSSL タイプ。
ProxyExceptions	ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。

Logging

プロパティ	説明
LogModules	ログファイルに含めるコアモジュール。

Schema

プロパティ	説明
Location	テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。
BrowsableSchemas	このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
Tables	このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。
Views	使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。

Miscellaneous

プロパティ	説明
GenerateSchemaFiles	スキーマを生成して保存するユーザーの好みのタイミングを示します。
IncludeCustomAttributes	A boolean indicating if you would like to include custom attributes in the column listing.
MaxRows	クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。
Other	これらの隠しプロパティは特定のユースケースでのみ使用されます。
Pagesize	The maximum number of results to return per page from Magento2.
PseudoColumns	このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
RowScanDepth	Scan Magento Product entities to determine unique columns.
Timeout	タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
TypeDetectionScheme	Enables scanning Magento Product entities to determine unique columns.
UserDefinedViews	カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。
UseSimpleNames	テーブルとカラムに簡略名を使用するかどうかを決定するboolean。

Authentication

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

プロパティ	説明
AuthScheme	The type of authentication to use when connecting to Magento 2.x.
URL	Set the URL to the HTTP or HTTPS endpoint of your Magento system. For example, https://magentohost/. We should not append magento2 as suffix in the url if you are connecting to cloud instance.
User	Username of the currently authenticated user. Used to connect to Magento 2.x servers only.
Password	Password of the currently authenticated User . Used to connect to Magento 2.x servers.
AccessToken	The Magento Access Token.
StoreCode	Specifies the code of the store against which the API requests are executed.

AuthScheme

The type of authentication to use when connecting to Magento 2.x.

解説

Auto: Lets the driver decide automatically based on the other connection properties you have set.
Basic: Set this to use BASIC user / password authentication.
Token: Set this to perform Authentication using a Magento Access Token.

URL

Set the URL to the HTTP or HTTPS endpoint of your Magento system. For example, https://magentohost/. We should not append magento2 as suffix in the url if you are connecting to cloud instance.

解説

Set the URL to the HTTP or HTTPS endpoint of your Magento system. For example, https://magentohost/. See the Getting Started section of the help documentation for connection guides to Magento 2.

User

Username of the currently authenticated user. Used to connect to Magento 2.x servers only.

解説

Username of the currently authenticated user. Used to connect to Magento 2.x servers only. See the Establishing a Connection section under Getting Started for more information on authenticating to different versions of Magento.

If you are accessing Magento as a customer, these credentials correspond to your customer account. To create an account, select Account > Register from the Magento home page.

To allow administrator users to connect:

Assign an admin role to a user by selecting System > Web Services > REST-Roles and click Admin Role.
Select Permissions > Users and select the user.

Password

Password of the currently authenticated User . Used to connect to Magento 2.x servers.

解説

Password of the currently authenticated User. Used only to connect to Magento 2.x servers.

AccessToken

The Magento Access Token.

解説

The Magento Access Token used to authenticate the requests. The Access Token can be either Integration, Admin or Customer type.

StoreCode

Specifies the code of the store against which the API requests are executed.

解説

The store code identifies a store in the Magento system. Set the value "all" to execute the API requests on every store in the system. This value only applies to the CMS and Product related tables.

SSL

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

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

SSLServerCert

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

解説

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

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

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

Firewall

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

プロパティ	説明
FirewallType	プロキシベースのファイアウォールで使われるプロトコル。
FirewallServer	プロキシベースのファイアウォールの名前もしくはIP アドレス。
FirewallPort	プロキシベースのファイアウォールのTCP ポート。
FirewallUser	プロキシベースのファイアウォールに認証するために使うユーザー名。
FirewallPassword	プロキシベースのファイアウォールへの認証に使われるパスワード。

FirewallType

プロキシベースのファイアウォールで使われるプロトコル。

解説

このプロパティは、Sync App がFirewallServer プロキシ経由でトンネルトラフィックを使うためのプロトコルを指定します。デフォルトでは、Sync App はシステムプロキシに接続します。この動作を無効化し次のプロキシタイプのどれかで接続するには、ProxyAutoDetect をfalse に設定します。


タイプ	デフォルトポート	説明
TUNNEL	80	これが設定されている場合、Sync App はMagento への接続を開き、プロキシを経由して通信が行われます。
SOCKS4	1080	これが設定されている場合、Sync App はデータをFirewallServer およびFirewallPort で指定されたSOCS 4 プロキシ経由で送信し、接続リクエストが許容されるかどうかを決定します。
SOCKS5	1080	これが設定されている場合、Sync App はデータをFirewallServer およびFirewallPort で指定されたSOCS 5 プロキシ経由で送信します。プロキシに認証が必要な場合には、FirewallUser およびFirewallPassword をプロキシが認識する認証情報に設定します。

HTTP プロキシへの接続には、ProxyServer およびProxyPort ポートを使ってください。HTTP プロキシへの認証には、ProxyAuthScheme、ProxyUser、およびProxyPassword を使ってください。

FirewallServer

プロキシベースのファイアウォールの名前もしくはIP アドレス。

解説

ファイアウォールトラバーサルを許容するために設定するIP アドレス、DNS 名、もしくはプロキシホスト名を指定するプロパティです。プロトコルはFirewallType で指定されます。このプロパティとFirewallServer を使って、SOCKS 経由での接続、もしくはトンネリングが可能です。HTTP プロキシへの接続には、ProxyServer を使用します。

Sync App はデフォルトでシステムプロキシを使うので注意してください。他のプロキシを使う場合には、ProxyAutoDetect をfalse に設定してください。

FirewallPort

プロキシベースのファイアウォールのTCP ポート。

解説

ファイアウォールトラバーサルを許容するために設定するプロキシベースのファイアウォールのTCP ポート。名前もしくはIP アドレスを指定するには、FirewallServer を使います。FirewallType でプロトコルを指定します。

FirewallUser

プロキシベースのファイアウォールに認証するために使うユーザー名。

解説

FirewallUser およびFirewallPassword プロパティは、FirewallType により指定された認証方式に則り、FirewallServer、およびFirewallPort で指定されたプロキシに対しての認証に使われます。

FirewallPassword

プロキシベースのファイアウォールへの認証に使われるパスワード。

解説

このプロパティは、FirewallType により指定された認証メソッドに則り、FirewallServer およびFirewallPort で指定されたプロキシに渡されます。

Proxy

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

プロパティ	説明
ProxyAutoDetect	これは、システムプロキシ設定を使用するかどうかを示します。これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。
ProxyServer	HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。
ProxyPort	ProxyServer プロキシが起動しているTCP ポート。
ProxyAuthScheme	ProxyServer プロキシへの認証で使われる認証タイプ。
ProxyUser	ProxyServer プロキシへの認証に使われるユーザー名。
ProxyPassword	ProxyServer プロキシへの認証に使われるパスワード。
ProxySSLType	ProxyServer プロキシへの接続時に使用するSSL タイプ。
ProxyExceptions	ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。

ProxyAutoDetect

これは、システムプロキシ設定を使用するかどうかを示します。これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。

解説

これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。

HTTP プロキシへの接続には、ProxyServer を参照してください。SOCKS やトンネリングなどの他のプロキシには、FirewallType を参照してください。

ProxyServer

HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。

解説

HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。HTTP プロキシへの認証には、Sync App はHTTP、Windows(NTLM)、もしくはKerberos 認証タイプを使用することができます。

SOCKS プロキシを経由して接続する、もしくは接続をトンネルするには、FirewallType を参照してください。

デフォルトで、Sync App はsystem プロキシを使います。他のプロキシを使う場合には、ProxyAutoDetect をfalse に設定します。

ProxyPort

ProxyServer プロキシが起動しているTCP ポート。

解説

HTTP トラフィックをリダイレクトするHTTP プロキシが実行されているポート。ProxyServer でHTTP プロキシを指定します。その他のプロキシタイプについては、FirewallType を参照してください。

ProxyAuthScheme

ProxyServer プロキシへの認証で使われる認証タイプ。

解説

この値は、ProxyServer およびProxyPort で指定されるHTTP プロキシに認証するために使われる認証タイプを指定します。

Sync App は、デフォルトでsystem proxy settings を使い、追加での設定が不要です。他のプロキシへの接続をする場合には、ProxyServer およびProxyPort に加え、ProxyAutoDetect をfalse に設定します。認証するには、ProxyAuthScheme を設定し、必要な場合にはProxyUser およびProxyPassword を設定します。

認証タイプは、次のどれかになります。

BASIC： Sync App はHTTP BASIC 認証を行います。
DIGEST： Sync App はHTTP DIGEST 認証を行います。
NEGOTIATE： Sync App は認証において有効なプロトコルに応じて、NTLM もしくはKereros トークンを取得します。
PROPRIETARY： Sync App はNTLM もしくはKerberos トークンを発行しません。このトークンを、HTTP リクエストのAuthorization ヘッダーに含める必要があります。

SOCKS 5 認証のような他の認証タイプを使用するには、FirewallType を参照してください。

ProxyUser

ProxyServer プロキシへの認証に使われるユーザー名。

解説

ProxyUser および ProxyPassword オプションは、ProxyServer で指定されたHTTP プロキシに対して接続および認証するために使用されます。

ProxyAuthScheme で使用可能な認証タイプを選択することができます。HTTP 認証を使う場合、これをHTTP プロキシで識別可能なユーザーのユーザー名に設定します。Windows もしくはKerberos 認証を使用する場合、このプロパティを次の形式のどれかでユーザー名に設定します。

user@domain
domain\user

ProxyPassword

ProxyServer プロキシへの認証に使われるパスワード。

解説

このプロパティは、NTLM(Windows)、Kerberos、もしくはHTTP 認証をサポートするHTTP プロキシサーバーに認証するために使われます。HTTP プロキシを指定するためには、ProxyServer およびProxyPort を設定します。認証タイプを指定するためにはProxyAuthScheme を設定します。

HTTP 認証を使う場合、さらにHTTP プロキシにProxyUser およびProxyPassword を設定します。

NTLM 認証を使う場合、Windows パスワードにProxyUser およびProxyPassword を設定します。Kerberos 認証には、これらを入力する必要があります。

SOCKS 5 認証もしくは、トンネリングは、FirewallType を参照してください。

デフォルトで、Sync App はsystem プロキシを使います。他のプロキシに接続する場合には、これをfalse に設定します。

ProxySSLType

ProxyServer プロキシへの接続時に使用するSSL タイプ。

解説

このプロパティは、ProxyServer で指定されたHTTP プロキシへの接続にSSL を使用するかどうかを決定します。この値は、AUTO、ALWAYS、NEVER、TUNNEL のいずれかです。有効な値は次のとおりです。


AUTO	デフォルト設定。URL がHTTPS URL の場合、Sync App は、TUNNEL オプションを使います。URL がHTTP URL の場合、コンポーネントはNEVER オプションを使います。
ALWAYS	接続は、常にSSL 有効となります。
NEVER	接続は、SSL 有効になりません。
TUNNEL	接続は、トンネリングプロキシを経由します。プロキシサーバーがリモートホストへの接続を開き、プロキシを経由して通信が行われます。

ProxyExceptions

ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。

解説

ProxyServer は、このプロパティで定義されたアドレスを除くすべてのアドレスに使用されます。セミコロンを使用してエントリを区切ります。

Sync App は、追加設定なしにデフォルトでシステムのプロキシ設定を使います。この接続のプロキシ例外を明示的に構成するには、ProxyAutoDetect をfalse に設定して、ProxyServer およびProxyPort を設定する必要があります。認証するには、ProxyAuthScheme を設定し、必要な場合にはProxyUser およびProxyPassword を設定します。

Logging

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

プロパティ	説明
LogModules	ログファイルに含めるコアモジュール。

LogModules

ログファイルに含めるコアモジュール。

解説

指定された（';' で区切られた）モジュールのみがログファイルに含まれます。デフォルトではすべてのモジュールが含まれます。

概要はログページを参照してください。

Schema

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

プロパティ	説明
Location	テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。
BrowsableSchemas	このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
Tables	このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。
Views	使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。

Location

テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。

解説

Sync App のスキーマファイル（テーブルとビューの場合は.rsd ファイル、ストアドプロシージャの場合は.rsb ファイル）を含むディレクトリへのパス。このフォルダの場所は、実行ファイルの場所からの相対パスにすることができます。Location プロパティは、定義をカスタマイズしたり（例えば、カラム名を変更する、カラムを無視するなど）、新しいテーブル、ビュー、またはストアドプロシージャでデータモデルを拡張する場合にのみ必要です。

指定しない場合、デフォルトの場所は"%APPDATA%\\CData\\Magento Data Provider\\Schema" となり、%APPDATA% はユーザーのコンフィギュレーションディレクトリに設定されます：

BrowsableSchemas

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

解説

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

Tables

このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。

解説

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

このプロパティは、作業したいビューがすでにわかっていて、ビューが多すぎる場合に、ビューを自動的にリストする代わりに使用することもできます。

カンマ区切りのリストで使用したいテーブルを指定します。各テーブルは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。例えば、Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space` です。

複数のスキーマまたはカタログを持つデータソースに接続する場合は、複数のカタログやスキーマに存在するテーブル間の曖昧さを避けるため、最後の例のように、このプロパティにテーブルの完全修飾名を指定する必要があることに注意してください。

Views

使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。

解説

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

このプロパティは、作業したいビューがすでにわかっていて、ビューが多すぎる場合に、ビューを自動的にリストする代わりに使用することもできます。

カンマ区切りのリストで使用したいビューを指定します。各ビューは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。例えば、Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space` です。

複数のスキーマまたはカタログを持つデータソースに接続する場合は、複数のカタログやスキーマに存在するテーブル間の曖昧さを避けるため、最後の例のように、このプロパティにテーブルの完全修飾名を指定する必要があることに注意してください。

Miscellaneous

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

プロパティ	説明
GenerateSchemaFiles	スキーマを生成して保存するユーザーの好みのタイミングを示します。
IncludeCustomAttributes	A boolean indicating if you would like to include custom attributes in the column listing.
MaxRows	クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。
Other	これらの隠しプロパティは特定のユースケースでのみ使用されます。
Pagesize	The maximum number of results to return per page from Magento2.
PseudoColumns	このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
RowScanDepth	Scan Magento Product entities to determine unique columns.
Timeout	タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
TypeDetectionScheme	Enables scanning Magento Product entities to determine unique columns.
UserDefinedViews	カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。
UseSimpleNames	テーブルとカラムに簡略名を使用するかどうかを決定するboolean。

GenerateSchemaFiles

スキーマを生成して保存するユーザーの好みのタイミングを示します。

解説

このプロパティは、Location で指定されたパスの.rsd ファイルにスキーマをアウトプットします。

有効な設定は次のとおりです。

Never：スキーマファイルは生成されません。
OnUse：スキーマファイルがまだ存在していない場合に、初めてテーブルが参照されるときにスキーマファイルが生成されます。
OnStart：現在スキーマファイルを持たないあらゆるテーブルに対して、接続時にスキーマファイルが生成されます。
OnCreate：CREATE TABLE SQL クエリを実行すると、スキーマファイルが生成されます。

ファイルを再生成したい場合には、既存のファイルを削除する必要があることに注意してください。

SQL でスキーマを生成する

GenerateSchemaFiles をOnUse に設定すると、Sync App はSELECT クエリを実行したときにスキーマを生成します。スキーマはクエリのそれぞれの参照されたテーブルに対して生成されます。

GenerateSchemaFiles をOnCreate に設定すると、CREATE TABLE クエリが実行されたときにのみスキーマが生成されます。

接続時にスキーマを生成する

このプロパティのもう一つの使い方は、接続するときにデータベース内のすべてのテーブルのスキーマを取得することです。これには、GenerateSchemaFiles をOnStart に設定して接続します。

IncludeCustomAttributes

A boolean indicating if you would like to include custom attributes in the column listing.

解説

Setting this to true will cause custom attributes to be included in the column listing.

MaxRows

クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。

解説

クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。

Other

これらの隠しプロパティは特定のユースケースでのみ使用されます。

解説

以下にリストされているプロパティは、特定のユースケースで使用可能です。通常のドライバーのユースケースおよび機能では、これらのプロパティは必要ありません。

複数のプロパティをセミコロン区切りリストで指定します。

統合およびフォーマット


DefaultColumnSize	データソースがメタデータにカラムの長さを提供しない場合に、文字列フィールドのデフォルトの長さを設定します。デフォルト値は2000です。
ConvertDateTimeToGMT	日時の値を、マシンのローカルタイムではなくGMT グリニッジ標準時に変換するかどうかを決定します。
RecordToFile=filename	基底のソケットデータ転送を指定のファイルに記録します。

Pagesize

The maximum number of results to return per page from Magento2.

解説

The Pagesize property affects the maximum number of results to return per page from Magento2 schema.

PseudoColumns

このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。

解説

Entity Framework ではテーブルカラムでない疑似カラムに値を設定できないため、この設定はEntity Framework で特に便利です。この接続設定の値は、"Table1=Column1, Table1=Column2, Table2=Column3" の形式です。"*=*" のように"*" 文字を使用して、すべてのテーブルとすべてのカラムを含めることができます。

RowScanDepth

Scan Magento Product entities to determine unique columns.

解説

In the Magento APIs, Product entities can have different sets of associated attributes. For example, clothing Products will also have Gender, Size, and Sleeve_Length attributes in addition to the standard columns.

When TypeDetectionScheme is set to "RowScan", the RowScanDepth property determines the number of objects to scan to determine the unique columns.

Setting a high value may decrease performance. Setting a low value may prevent the Sync App from retrieving the relevant columns for the table.

Timeout

タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。

解説

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

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

TypeDetectionScheme

Enables scanning Magento Product entities to determine unique columns.

解説

In the Magento APIs, Product entities can have different sets of associated attributes. For example, clothing Products will also have Gender, Size, and Sleeve_Length attributes in addition to the standard columns.

To access these unique columns, set the following connection properties:


RowScan	Setting TypeDetectionScheme to RowScan will scan objects (rows) to heuristically determine additional columns when you connect. The RowScanDepth determines the number of objects to be scanned.
None	Setting TypeDetectionScheme to None will return only the standard columns.

UserDefinedViews

カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。

解説

ユーザー定義ビューは、UserDefinedViews.json というJSON 形式のコンフィギュレーションファイルで定義されています。Sync App は、このファイルで指定されたビューを自動的に検出します。

また、複数のビュー定義を持ち、UserDefinedViews 接続プロパティを使用して制御することも可能です。このプロパティを使用すると、指定されたビューのみがSync App によって検知されます。

このユーザー定義ビューのコンフィギュレーションファイルは、次のようにフォーマットされています。

各ルートエレメントはビューの名前を定義します。
各ルートエレメントには、query と呼ばれる子エレメントが含まれており、この子エレメントにはビューのカスタムSQL クエリが含まれています。

次に例を示します。

{
	"MyView": {
		"query": "SELECT * FROM Products WHERE MyColumn = 'value'"
	},
	"MyView2": {
		"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
	}
}

UserDefinedViews 接続プロパティを使用して、JSON コンフィギュレーションファイルの場所を指定します。次に例を示します。

"UserDefinedViews", "C:\\Users\\yourusername\\Desktop\\tmp\\UserDefinedViews.json"

UseSimpleNames

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

解説

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

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