CData Cloud offers access to Bcart across several standard services and protocols, in a cloud-hosted solution. Any application that can connect to a MySQL or SQL Server database can connect to Bcart through CData Cloud.
CData Cloud allows you to standardize and configure connections to Bcart as though it were any other OData endpoint, or standard SQL Server/MySQL database.
This page provides a guide to Establishing a Connection to Bcart in CData Cloud, as well as information on the available resources, and a reference to the available connection properties.
Establishing a Connection shows how to authenticate to Bcart and configure any necessary connection properties to create a database in CData Cloud
Accessing data from Bcart through the available standard services and CData Cloud administration is documented in further details in the CData Cloud Documentation.
Connect to Bcart by selecting the corresponding icon in the Database tab. Required properties are listed under Settings. The Advanced tab lists connection properties that are not typically required.
Personal Access Token is required for Bcart driver.
After logging in to Bcart API Management page, go to the Application Management, click Create New Token, enter the Name and slelect the necessary permissions. After that you can get the Personal Access Token.
PersonalAccessToken : Set the created Personal Access Token.
By default, the Cloud attempts to negotiate SSL/TLS by checking the server's certificate against the system's trusted certificate store.
To specify another certificate, see the SSLServerCert property for the available formats to do so.
To connect through the Windows system proxy, you do not need to set any additional connection properties. To connect to other proxies, set ProxyAutoDetect to false.
In addition, to authenticate to an HTTP proxy, set ProxyAuthScheme, ProxyUser, and ProxyPassword, in addition to ProxyServer and ProxyPort.
Set the following properties:
This section shows the available API objects and provides more information on executing SQL to Bcart APIs.
Tables describes the available tables. Tables are statically defined to model Customers, Orders, Products, and more.
Views describes the available views. Views are statically defined to model PriceGroups, ProductOptions, ShippingGroups, and more.
The Cloud models the data in Bcart as a list of tables in a relational database that can be queried using standard SQL statements.
Name | Description |
Bookmarks | Usage information for the operation Bookmarks.rsd. |
Categories | Usage information for the operation Categories.rsd. |
Customers | Usage information for the operation Customers.rsd. |
Logistics | Usage information for the operation Logistics.rsd. |
OrderProducts | Usage information for the operation OrderProducts.rsd. |
Orders | Usage information for the operation Orders.rsd. |
OrderStatuses | Usage information for the operation OrderStatuses.rsd. |
OtherAddresses | Usage information for the operation OtherAddresses.rsd. |
Points | Usage information for the operation Points.rsd. |
ProductFeatures | Usage information for the operation ProductFeatures.rsd. |
Products | Usage information for the operation Products.rsd. |
ProductSets | Usage information for the operation ProductSets.rsd. |
ProductStock | Usage information for the operation ProductStock.rsd. |
Returns data from Bookmarks table.
The Cloud will use the Bcart API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud.
SELECT * FROM Bookmarks WHERE Id = 12345 SELECT * FROM Bookmarks WHERE CustomerId IN (1, 10) SELECT * FROM Bookmarks WHERE UpdatedAt <= '2019-09-26 09:20:45'
To add a Bookmarks, specify CustomerId, ProductId and the non-read-only columns.
INSERT INTO Bookmarks (CustomerId, ProductId) VALUES (12345, 12345)
INSERT INTO Bookmarks#TEMP (CustomerId, ProductId) VALUES (12345, 12345) INSERT INTO Bookmarks#TEMP (CustomerId, ProductId) VALUES (12345, 12345) INSERT INTO Bookmarks (CustomerId, ProductId) SELECT CustomerId, ProductId FROM Bookmarks#TEMP
Bcart allows updates for CustomerId, ProductId and the non-read-only columns.
UPDATE Bookmarks SET CustomerId = 12345 WHERE Id = 12345
INSERT INTO Bookmarks#TEMP (Id, CustomerId, ProductId) VALUES (1, 12345, 12345) INSERT INTO Bookmarks#TEMP (Id, CustomerId, ProductId) VALUES (2, 12345, 12345) UPDATE Bookmarks (Id, CustomerId, ProductId) SELECT Id, CustomerId, ProductId FROM Bookmarks#TEMP
Delete is not supported for this table.
Name | Type | ReadOnly | Description |
Id [KEY] | Integer | True | |
CustomerId | Integer | False | |
ProductId | Integer | False | |
UpdatedAt | Datetime | False |
Returns data from Categories table.
The Cloud will use the Bcart API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud.
SELECT * FROM Categories WHERE Name = 'Sample Category' SELECT * FROM Categories WHERE Id IN (1, 10) SELECT * FROM Categories WHERE Priority <= 5
To add a Categories, specify Name and the non-read-only columns.
INSERT INTO Categories (Name) VALUES ('Sample Category')
INSERT INTO Categories#TEMP (Name) VALUES ('Sample Category 1') INSERT INTO Categories#TEMP (Name) VALUES ('Sample Category 2') INSERT INTO Categories (Name) SELECT Name FROM Categories#TEMP
Bcart allows updates for Name, Description and the non-read-only columns.
UPDATE Categories SET Name = 'Sample Category' WHERE Id = 2
INSERT INTO Categories#TEMP (Id, Name) VALUES (1, 'Sample Category 1') INSERT INTO Categories#TEMP (Id, Name) VALUES (2, 'Sample Category 2') UPDATE Categories (Id, Name) SELECT Id, Name FROM Categories#TEMP
Delete is not supported for this table.
Name | Type | ReadOnly | Description |
Id [KEY] | Integer | True | |
Name | String | False | |
Description | String | False | |
RvDescription | String | False | |
ParentCategoryId | Integer | False | |
HeaderImage | String | False | |
BannerImage | String | False | |
MenuImage | String | False | |
MetaTitle | String | False | |
MetaKeywords | String | False | |
MetaDescription | String | False | |
Priority | Integer | False | |
Flag | Integer | False |
Returns data from Customers table.
The Cloud will use the Bcart API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud.
SELECT * FROM Customers WHERE CompName = 'Sample Company' SELECT * FROM Customers WHERE ParentId IN (1, 10) SELECT * FROM Customers WHERE UpdatedAt <= '2019-09-26 09:20:45'
To add a Customers, specify TantoLastName, Zip, Pref, Address1, Address2, Password and the non-read-only columns.
INSERT INTO Customers (TantoLastName, Zip, Pref, Address1, Address2, Password) VALUES ('Tanto', '123-4567', 'Miyagi', 'Sendai', 'CData', 'PASSWPRD')
INSERT INTO Customers#TEMP (TantoLastName, Zip, Pref, Address1, Address2, Password) VALUES ('Tanto 1', '123-4567', 'Miyagi', 'Sendai', 'CData', 'PASSWPRD') INSERT INTO Customers#TEMP (TantoLastName, Zip, Pref, Address1, Address2, Password) VALUES ('Tanto 2', '123-4567', 'Miyagi', 'Sendai', 'CData', 'PASSWPRD') INSERT INTO Customers (Name, CategoryId) SELECT Name, CategoryId FROM Customers#TEMP
Bcart allows updates for TantoLastName, Zip and the non-read-only columns.
UPDATE Customers SET TantoLastName = 'Sample TantoLastName' WHERE Id = 2
INSERT INTO Customers#TEMP (Id, TantoLastName, Address1) VALUES (1, 'Sample TantoLastName 1', 'Sendai') INSERT INTO Customers#TEMP (Id, TantoLastName, Address1) VALUES (2, 'Sample TantoLastName 2', 'Sendai') UPDATE Customers (Id, TantoLastName, Address1) SELECT Id, TantoLastName, Address1 FROM Customers#TEMP
Delete is not supported for this table.
Name | Type | ReadOnly | Description |
Id [KEY] | Integer | True | |
ExtId | String | False | |
AgentId | String | False | |
AgentRate | String | False | |
ParentId | Integer | False | |
DestinationCode | String | False | |
CompName | String | False | |
CompNameKana | String | False | |
CeoLastName | String | False | |
CeoFirstName | String | False | |
CeoLastNameKana | String | False | |
CeoFirstNameKana | String | False | |
Department | String | False | |
TantoLastName | String | False | |
TantoFirstName | String | False | |
TantoLastNameKana | String | False | |
TantoFirstNameKana | String | False | |
Zip | String | False | |
Pref | String | False | |
Address1 | String | False | |
Address2 | String | False | |
Address3 | String | False | |
String | False | ||
EmailCc | String | False | |
Tel | String | False | |
MobilePhone | String | False | |
Fax | String | False | |
Url | String | False | |
Foundation | String | False | |
Sales | Integer | False | |
Job | String | False | |
Memo | String | False | |
Payment | String | False | |
SpecialShippingCost | String | False | |
Paid | String | True | |
SpecialView | Integer | False | |
MmFlag | Integer | False | |
Point | Integer | False | |
PriceGroupId | Integer | False | |
ViewGroupId | Integer | False | |
SalesmanId | String | False | |
AfId | String | False | |
CutoffDate | String | False | |
PaymentMonth | String | False | |
PaymentDate | String | False | |
DefaultOtherShippingId | Integer | False | |
DefaultPayment | String | False | |
HiddenPrice | Integer | False | |
Status | String | False | |
Password | String | False | |
CreatedAt | Datetime | False | |
UpdatedAt | Datetime | False |
Returns data from Logistics table.
The Cloud will use the Bcart API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud.
SELECT * FROM Logistics WHERE Name = 'Sample Product' SELECT * FROM Logistics WHERE ShippingGroupId IN (1, 10) SELECT * FROM Logistics WHERE ShipmentDate <= '2019-09-26 09:20:45'
Insert is not supported for this table.
Bcart allows updates for ShipmentCode, DeliveryCode and the non-read-only columns.
UPDATE Logistics ShipmentCode = '123' WHERE Id = 20000001
INSERT INTO Logistics#TEMP (Id, ShipmentCode, Name) VALUES (20000001, 'Sample ShipmentCode 1', 'Sample Name 1') INSERT INTO Logistics#TEMP (Id, ShipmentCode, Name) VALUES (20000002, 'Sample ShipmentCode 2', 'Sample Name 2') UPDATE Logistics (Id, ShipmentCode, Name) SELECT Id, ShipmentCode, Name FROM Logistics#TEMP
Delete is not supported for this table.
Name | Type | ReadOnly | Description |
Id [KEY] | Integer | True | |
ShipmentCode | String | False | |
DeliveryCode | String | False | |
DestinationCode | String | False | |
ShippingGroupId | Integer | False | |
CompName | String | False | |
Department | String | False | |
Name | String | False | |
Zip | String | False | |
Pref | String | False | |
Address1 | String | False | |
Address2 | String | False | |
Address3 | String | False | |
Tel | String | False | |
DueDate | Date | False | |
DueTime | String | False | |
Memo | String | False | |
ShipmentDate | Date | False | |
Status | String | False |
Returns data from OrderProducts table.
The Cloud will use the Bcart API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud.
SELECT * FROM OrderProducts WHERE ProductName = 'Sample Order Product' SELECT * FROM OrderProducts WHERE OrderId IN (1, 10) SELECT * FROM OrderProducts WHERE ShippingSize <= 10
Insert is not supported for this table.
Bcart allows updates for ProductName, MainNo and the non-read-only columns.
UPDATE OrderProducts SET ProductName = 'Sample Order Product' WHERE Id = 2
INSERT INTO OrderProducts#TEMP (Id, ProductName, MainNo) VALUES (1, 'Sample Order Product 1', '1') INSERT INTO OrderProducts#TEMP (Id, ProductName, MainNo) VALUES (2, 'Sample Order Product 2', '2') UPDATE OrderProducts (Id, ProductName, MainNo) SELECT Id, ProductName, MainNo FROM OrderProducts#TEMP
Delete is not supported for this table.
Name | Type | ReadOnly | Description |
Id [KEY] | Integer | True | |
OrderId | Integer | False | |
LogisticsId | Integer | False | |
ProductId | Integer | False | |
MainNo | String | False | |
ProductNo | String | False | |
JanCode | String | False | |
LocationNo | String | False | |
ProductName | String | False | |
ProductSetId | Integer | False | |
SetName | String | False | |
UnitPrice | Decimal | True | |
SetQuantity | Integer | True | |
SetUnit | String | False | |
OrderProCount | Integer | True | |
ShippingSize | Integer | False | |
TaxRate | String | True | |
TaxTypeId | Integer | True | |
TaxIncl | Integer | True | |
ItemType | String | True | |
Options | String | True |
Returns data from Orders table.
The Cloud will use the Bcart API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud.
SELECT * FROM Orders WHERE CustomerCompName = 'Sample Customer' SELECT * FROM Orders WHERE Id IN (1, 10) SELECT * FROM Orders WHERE OrderedAt <= '2019-09-26 09:20:45'
Insert is not supported for this table.
Bcart allows updates for CustomerCompName, Memo and the non-read-only columns.
UPDATE Orders SET CustomerCompName = 'Sample Customer' WHERE Id = 2
INSERT INTO Orders#TEMP (Id, CustomerCompName, Memo) VALUES (1, 'Sample Customer 1', 'Sample Memo') INSERT INTO Orders#TEMP (Id, CustomerCompName, Memo) VALUES (2, 'Sample Customer 2', 'Sample Memo') UPDATE Orders (Id, CustomerCompName, Memo) SELECT Id, CustomerCompName, Memo FROM Orders#TEMP
Delete is not supported for this table.
Name | Type | ReadOnly | Description |
Id [KEY] | Integer | True | |
Code | String | True | |
CustomerId | Integer | False | |
CustomerExtId | String | False | |
CustomerParentId | Integer | False | |
CustomerSalesmanId | String | False | |
CustomerCompName | String | False | |
CustomerDepartment | String | False | |
CustomerName | String | False | |
CustomerTel | String | False | |
CustomerMobilePhone | String | False | |
CustomerEmail | String | False | |
CustomerPriceGroupId | String | False | |
CustomerZip | String | False | |
CustomerPref | String | False | |
CustomerAddress1 | String | False | |
CustomerAddress2 | String | False | |
CustomerAddress3 | String | False | |
Payment | String | False | |
PaymentAt | Date | False | |
TotalPrice | Decimal | True | |
Tax | Decimal | True | |
TaxRate | String | True | |
CODCost | Decimal | True | |
ShippingCost | Decimal | True | |
FinalPrice | Decimal | True | |
UsePoint | Integer | True | |
GetPoint | Integer | True | |
OrderTotals | String | True | |
CustomerMessage | String | False | |
AdminMessage | String | False | |
Memo | String | False | |
Enquete1 | String | False | |
Enquete2 | String | False | |
Enquete3 | String | False | |
Enquete4 | String | False | |
Enquete5 | String | False | |
OrderedAt | Datetime | True | |
AffiliateId | String | True | |
EstimateId | String | False | |
Status | String | False |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
QualifiedInvoice | Integer |
Returns data from OrderStatuses table.
The Cloud will use the Bcart API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud.
SELECT * FROM OrderStatuses WHERE Label = 'Sample Product' SELECT * FROM OrderStatuses WHERE Id IN (1, 10) SELECT * FROM OrderStatuses WHERE SystemDefined <= 5
To add a OrderStatuses, specify Label column.
INSERT INTO OrderStatuses (Label) VALUES ('Sample Label')
INSERT INTO OrderStatuses#TEMP (Label) VALUES ('Sample Label 1') INSERT INTO OrderStatuses#TEMP (Label) VALUES ('Sample Label 2') INSERT INTO OrderStatuses (Label) SELECT Label FROM OrderStatuses#TEMP
Bcart allows updates for Label column.
UPDATE OrderStatuses SET Label = 'Sample Label' WHERE Id = 2
INSERT INTO OrderStatuses#TEMP (Id, Label) VALUES (1, 'Sample Label 1') INSERT INTO OrderStatuses#TEMP (Id, Label) VALUES (2, 'Sample Label 2') UPDATE OrderStatuses (Id, Label) SELECT Id, Label FROM OrderStatuses#TEMP
Delete is not supported for this table.
Name | Type | ReadOnly | Description |
Id [KEY] | String | True | |
Label | String | False | |
SystemDefined | Integer | True |
Returns data from OtherAddresses table.
The Cloud will use the Bcart API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud.
SELECT * FROM OtherAddresses WHERE Name = 'Sample Addresses' SELECT * FROM OtherAddresses WHERE Id IN (1, 10) SELECT * FROM OtherAddresses WHERE CustomerId <= 5
To add a OtherAddresses, specify Name, CustomerId and the non-read-only columns.
INSERT INTO OtherAddresses (Name, Zip, Pref, Address1, Address2, CustomerId) VALUES ('Sample Address', '123-4567', 'Miyagi', 'Sendai', 'CData', 9999)
INSERT INTO OtherAddresses#TEMP (Name, Zip, Pref, Address1, Address2, CustomerId) VALUES ('Sample Address 1', '123-4567', 'Miyagi', 'Sendai', 'CData', 9999) INSERT INTO OtherAddresses#TEMP (Name, Zip, Pref, Address1, Address2, CustomerId) VALUES ('Sample Address 2', '123-4567', 'Miyagi', 'Sendai', 'CData', 9999) INSERT INTO OtherAddresses (Name, Zip, Pref, Address1, Address2, CustomerId) SELECT Name, Zip, Pref, Address1, Address2, CustomerId FROM OtherAddresses#TEMP
Bcart allows updates for Name, Zip and the non-read-only columns.
UPDATE OtherAddresses SET Name = 'Sample Address' WHERE Id = 2
INSERT INTO OtherAddresses#TEMP (Id, Name) VALUES (1, 'Sample Address 1') INSERT INTO OtherAddresses#TEMP (Id, Name) VALUES (2, 'Sample Address 2') UPDATE OtherAddresses (Id, Name) SELECT Id, Name FROM OtherAddresses#TEMP
Delete is not supported for this table.
Name | Type | ReadOnly | Description |
Id [KEY] | Integer | True | |
CustomerId | Integer | False | |
DestinationCode | String | False | |
CompName | String | False | |
Department | String | False | |
Name | String | False | |
Zip | String | False | |
Pref | String | False | |
Address1 | String | False | |
Address2 | String | False | |
Address3 | String | False | |
Tel | String | False |
Returns data from Points table.
The Cloud will use the Bcart API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud.
SELECT * FROM Points WHERE Status = 'Sample Status' SELECT * FROM Points WHERE Id IN (1, 10) SELECT * FROM Points WHERE UpdatedAt <= '2019-09-26 09:20:45'
To add a Points, specify CustomerId, Point, Status and the non-read-only columns.
INSERT INTO Points (CustomerId, Point, Status) VALUES (12345, 10, 'Sample Status')
INSERT INTO Points#TEMP (CustomerId, Point, Status) VALUES (12345, 10, 'Sample Status') INSERT INTO Points#TEMP (CustomerId, Point, Status) VALUES (12346, 10, 'Sample Status') INSERT INTO Points (CustomerId, Point, Status) SELECT CustomerId, Point, Status FROM Points#TEMP
Bcart allows updates for CustomerId, Point and the non-read-only columns.
UPDATE Points SET Point = 10 WHERE Id = 2
INSERT INTO Points#TEMP (Id, Point) VALUES (1, 10) INSERT INTO Points#TEMP (Id, Point) VALUES (2, 20) UPDATE Points (Id, Point) SELECT Id, Point FROM Points#TEMP
Delete is not supported for this table.
Name | Type | ReadOnly | Description |
Id [KEY] | Integer | True | |
CustomerId | Integer | False | |
OrderId | Integer | False | |
SubjectId | Integer | False | |
Point | Integer | False | |
Status | String | False | |
ActivatedAt | Datetime | False | |
CreatedAt | Datetime | False | |
UpdatedAt | Datetime | False |
Returns data from ProductFeatures table.
The Cloud will use the Bcart API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud.
SELECT * FROM ProductFeatures WHERE Name = 'Sample ProductFeatures' SELECT * FROM ProductFeatures WHERE Id IN (1, 10) SELECT * FROM ProductFeatures WHERE Priority <= 5
To add a ProductFeatures, specify Name, Description and the non-read-only columns.
INSERT INTO ProductFeatures (Name, Description) VALUES ('Sample Product Features', 'Description')
INSERT INTO ProductFeatures#TEMP (Name, Description) VALUES ('Sample Product Features 1', 'Sample Description') INSERT INTO ProductFeatures#TEMP (Name, Description) VALUES ('Sample Product Features 2', 'Sample Description') INSERT INTO ProductFeatures (Name, Description) SELECT Name, Description FROM ProductFeatures#TEMP
Bcart allows updates for Name, Description and the non-read-only columns.
UPDATE ProductFeatures SET Name = 'Sample Product Features' WHERE Id = 2
INSERT INTO ProductFeatures#TEMP (Id, Name, Description) VALUES (1, 'Sample Product Features 1', 'Sample Description') INSERT INTO ProductFeatures#TEMP (Id, Name, Description) VALUES (2, 'Sample Product Features 2', 'Sample Description') UPDATE ProductFeatures (Id, Name, Description) SELECT Id, Name, Description FROM ProductFeatures#TEMP
Delete is not supported for this table.
Name | Type | ReadOnly | Description |
Id [KEY] | Integer | True | |
Name | String | False | |
RvDescription | String | False | |
Description | String | False | |
HeaderImage | String | False | |
BannerImage | String | False | |
MenuImage | String | False | |
MetaTitle | String | False | |
MetaKeywords | String | False | |
MetaDescription | String | False | |
Priority | Integer | False | |
Flag | Integer | False |
Returns data from Products table.
The Cloud will use the Bcart API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud.
SELECT * FROM Products WHERE Name = 'Sample Product' SELECT * FROM Products WHERE Id IN (1, 10) SELECT * FROM Products WHERE UpdatedAt <= '2019-09-26 09:20:45'
To add a Products, specify Name, CategoryId and the non-read-only columns.
INSERT INTO Products (Name, CategoryId) VALUES ('Sample Product', 2)
INSERT INTO Products#TEMP (Name, CategoryId) VALUES ('Sample Product 1', 2) INSERT INTO Products#TEMP (Name, CategoryId) VALUES ('Sample Product 2', 2) INSERT INTO Products (Name, CategoryId) SELECT Name, CategoryId FROM Products#TEMP
Bcart allows updates for Name, CategoryId and the non-read-only columns.
UPDATE Products SET Name = 'Sample Product' WHERE Id = 2
INSERT INTO Products#TEMP (Id, Name, CategoryId) VALUES (1, 'Sample Product 1', 2) INSERT INTO Products#TEMP (Id, Name, CategoryId) VALUES (2, 'Sample Product 2', 2) UPDATE Products (Id, Name, CategoryId) SELECT Id, Name, CategoryId FROM Products#TEMP
Delete is not supported for this table.
Name | Type | ReadOnly | Description |
Id [KEY] | Integer | True | |
MainNo | String | False | |
Name | String | False | |
CatchCopy | String | False | |
CategoryId | Integer | False | |
SubCategoryId | String | False | |
FeatureId1 | Integer | False | |
FeatureId2 | Integer | False | |
FeatureId3 | Integer | False | |
MadeIn | String | False | |
Size | String | False | |
Sozai | String | False | |
Caution | String | False | |
Tag | String | False | |
Description | String | False | |
MetaTitle | String | False | |
MetaKeywords | String | False | |
MetaDescription | String | False | |
Image | String | False | |
ViewGroupFilter | String | False | |
VisibleCustomerId | String | False | |
PrependText | String | False | |
AppendText | String | False | |
MiddleText | String | False | |
RvPrependText | String | False | |
RvAppendText | String | False | |
RvMiddleText | String | False | |
FileDownload | String | False | |
HanbaiStart | Datetime | False | |
HanbaiEnd | Datetime | False | |
RecommendProductId | String | False | |
ViewPattern | Integer | False | |
Priority | Integer | False | |
Flag | String | False | |
UpdatedAt | Datetime | False | |
SubImages1Image | String | False | |
SubImages1Caption | String | False | |
SubImages2Image | String | False | |
SubImages2Caption | String | False | |
SubImages3Image | String | False | |
SubImages3Caption | String | False | |
SubImages4Image | String | False | |
SubImages4Caption | String | False | |
SubImages5Image | String | False | |
SubImages5Caption | String | False | |
SubImages6Image | String | False | |
SubImages6Caption | String | False |
Returns data from ProductSets table.
The Cloud will use the Bcart API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud.
SELECT * FROM ProductSets WHERE Name = 'Sample ProductSets' SELECT * FROM ProductSets WHERE Id IN (1, 10) SELECT * FROM ProductSets WHERE UpdatedAt <= '2019-09-26 09:20:45'
To add a ProductSets, specify Name, ProductId, UnitPrice and the non-read-only columns.
INSERT INTO ProductSets (Name, ProductId, UnitPrice) VALUES ('Sample Product Set', 2, 1000)
INSERT INTO ProductSets#TEMP (Name, ProductId, UnitPrice) VALUES ('Sample Product Set 1', 2, 1000) INSERT INTO ProductSets#TEMP (Name, ProductId, UnitPrice) VALUES ('Sample Product Set 2', 2, 1000) INSERT INTO ProductSets (Name, ProductId, UnitPrice) SELECT Name, ProductId, UnitPrice FROM ProductSets#TEMP
Bcart allows updates for Name, ProductId, UnitPrice and the non-read-only columns.
UPDATE ProductSets SET Name = 'Sample Product Set' WHERE Id = 2
INSERT INTO ProductSets#TEMP (Id, Name, UnitPrice) VALUES (1, 'Sample Product Set 1', 2000) INSERT INTO ProductSets#TEMP (Id, Name, UnitPrice) VALUES (2, 'Sample Product Set 2', 3000) UPDATE ProductSets (Id, Name, UnitPrice) SELECT Id, Name, UnitPrice FROM ProductSets#TEMP
Delete is not supported for this table.
Name | Type | ReadOnly | Description |
Id [KEY] | Integer | True | |
ProductId | Integer | False | |
ProductNo | String | False | |
JanCode | String | False | |
LocationNo | String | False | |
JodaiType | String | False | |
Jodai | Integer | False | |
Name | String | False | |
UnitPrice | Decimal | False | |
MinOrder | Integer | False | |
MaxOrder | Integer | False | |
GroupPrice1Name | String | False | |
GroupPrice1Rate | String | False | |
GroupPrice1UnitPrice | Decimal | False | |
GroupPrice1FixedPrice | Decimal | False | |
GroupPrice1VolumeDiscount | String | False | |
GroupPrice2Name | String | False | |
GroupPrice2Rate | String | False | |
GroupPrice2UnitPrice | Decimal | False | |
GroupPrice2FixedPrice | Decimal | False | |
GroupPrice2VolumeDiscount | String | False | |
GroupPrice3Name | String | False | |
GroupPrice3Rate | String | False | |
GroupPrice3UnitPrice | Decimal | False | |
GroupPrice3FixedPrice | Decimal | False | |
GroupPrice3VolumeDiscount | String | False | |
GroupPrice4Name | String | False | |
GroupPrice4Rate | String | False | |
GroupPrice4UnitPrice | Decimal | False | |
GroupPrice4FixedPrice | Decimal | False | |
GroupPrice4VolumeDiscount | String | False | |
GroupPrice5Name | String | False | |
GroupPrice5Rate | String | False | |
GroupPrice5UnitPrice | Decimal | False | |
GroupPrice5FixedPrice | Decimal | False | |
GroupPrice5VolumeDiscount | String | False | |
GroupPrice6Name | String | False | |
GroupPrice6Rate | String | False | |
GroupPrice6UnitPrice | Decimal | False | |
GroupPrice6FixedPrice | Decimal | False | |
GroupPrice6VolumeDiscount | String | False | |
GroupPrice7Name | String | False | |
GroupPrice7Rate | String | False | |
GroupPrice7UnitPrice | Decimal | False | |
GroupPrice7FixedPrice | Decimal | False | |
GroupPrice7VolumeDiscount | String | False | |
GroupPrice8Name | String | False | |
GroupPrice8Rate | String | False | |
GroupPrice8UnitPrice | Decimal | False | |
GroupPrice8FixedPrice | Decimal | False | |
GroupPrice8VolumeDiscount | String | False | |
GroupPrice9Name | String | False | |
GroupPrice9Rate | String | False | |
GroupPrice9UnitPrice | Decimal | False | |
GroupPrice9FixedPrice | Decimal | False | |
GroupPrice9VolumeDiscount | String | False | |
GroupPrice10Name | String | False | |
GroupPrice10Rate | String | False | |
GroupPrice10UnitPrice | Decimal | False | |
GroupPrice10FixedPrice | Decimal | False | |
GroupPrice10VolumeDiscount | String | False | |
GroupPriceNName | String | False | |
GroupPriceNRate | String | False | |
GroupPriceNUnitPrice | Decimal | False | |
GroupPriceNFixedPrice | Decimal | False | |
GroupPriceNVolumeDiscount | String | False | |
SpecialPrice | String | False | |
VolumeDiscount | String | False | |
Quantity | Integer | False | |
Unit | String | False | |
Description | String | False | |
Stock | Integer | False | |
StockFlag | Integer | False | |
StockParent | String | False | |
StockViewId | Integer | False | |
StockFew | Integer | False | |
ViewGroupFilter | String | False | |
VisibleCustomerId | String | False | |
OptionIds | String | False | |
ShippingGroupId | Integer | False | |
ShippingSize | Integer | False | |
Priority | Integer | False | |
SetFlag | String | False | |
TaxTypeId | Integer | False | |
UpdatedAt | Datetime | False |
Returns data from ProductStock table.
The Cloud will use the Bcart API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud.
SELECT * FROM ProductStock WHERE Name = 'Sample Stock' SELECT * FROM ProductStock WHERE Id IN (1, 10) SELECT * FROM ProductStock WHERE Stock <= 10
Insert is not supported for this table.
Bcart allows updates for Stock, StockFlag and the non-read-only columns.
UPDATE ProductStock SET Stock = 15 WHERE ProductNo = 2
If need update the number of stocks by relative value, Specify relative value by StockRelativeUpdateValue.
The following query reduces the number of stocks by two.
UPDATE ProductStock SET StockRelativeUpdateValue = -1 WHERE ProductNo = 2
INSERT INTO ProductStock#TEMP (ProductNo, Stock) VALUES ('A001', 2) INSERT INTO ProductStock#TEMP (ProductNo, Stock) VALUES ('A002', 3) UPDATE ProductStock (ProductNo, Stock) SELECT ProductNo, Stock FROM ProductStock#TEMP
Delete is not supported for this table.
Name | Type | ReadOnly | Description |
Id | Integer | True | |
ProductId | Integer | True | |
ProductNo [KEY] | String | True | |
Name | String | True | |
Stock | Integer | False | |
StockFlag | Integer | False | |
StockParent | String | False |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
StockRelativeUpdateValue | String |
Views are similar to tables in the way that data is represented; however, views are read-only.
Queries can be executed against a view as if it were a normal table.
Name | Description |
PriceGroups | Usage information for the operation PriceGroups.rsd. |
ProductOptions | Usage information for the operation ProductOptions.rsd. |
ShippingGroups | Usage information for the operation ShippingGroups.rsd. |
ViewGroups | Usage information for the operation ViewGroups.rsd. |
Returns data from PriceGroups table.
The Cloud will use the Bcart API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud.
SELECT * FROM PriceGroups WHERE Name = 'Sample PriceGroups' SELECT * FROM PriceGroups WHERE Id IN (1, 10) SELECT * FROM PriceGroups WHERE Id <= '10'
Name | Type | Description |
Id [KEY] | String | |
Name | String | |
Rate | String |
Returns data from ProductOptions table.
The Cloud will use the Bcart API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud.
SELECT * FROM ProductOptions WHERE Name = 'Sample ProductOptions' SELECT * FROM ProductOptions WHERE Id IN (1, 10) SELECT * FROM ProductOptions WHERE UpdatedAt <= '2019-09-26 09:20:45'
Name | Type | Description |
Id [KEY] | Integer | |
Name | String | |
IsActive | Integer | |
InputType | String | |
InputChoices | String | |
InputRulesType | String | |
InputRulesLimitType | String | |
InputRulesLimitMin | String | |
InputRulesLimitMax | String | |
Unit | String | |
IsDescriptionHtml | Integer | |
Description | String | |
Required | Boolean | |
SortPriority | Integer | |
CreatedAt | Datetime | |
UpdatedAt | Datetime |
Returns data from ShippingGroups table.
The Cloud will use the Bcart API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud.
SELECT * FROM ShippingGroups WHERE Name = 'Sample ShippingGroups' SELECT * FROM ShippingGroups WHERE Id IN (1, 10) SELECT * FROM ShippingGroups WHERE CostFreePrice <= 10
Name | Type | Description |
Id [KEY] | Integer | |
Name | String | |
Description | String | |
Company | Integer | |
ShippingOtherFlag | String | |
CodCost | String | |
CodCostMaxPrice | String | |
CodCostMaxCost | String | |
CodFlag | Integer | |
TaxIncluded | Integer | |
TaxRounding | String | |
TaxCodIncluded | Integer | |
TaxCodRounding | String | |
DueDateFlag | Integer | |
DueDateStartDay | String | |
DueDateIncrement | String | |
DueDateCarryoverHourFlag | Integer | |
DueDateCarryoverHour | String | |
DueDateCarryoverHolidayFlag | Integer | |
DueDateDescription | String | |
DueHourFlag | Integer | |
DueHour | String | |
DueHourDescription | String | |
OtherFlag | Integer | |
CodeUrl | String | |
CostFreeFlag | Integer | |
CostFreePrice | Decimal | |
Cost | String | |
CostText | String |
Returns data from ViewGroups table.
The Cloud will use the Bcart API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud.
SELECT * FROM ViewGroups WHERE Name = 'Sample ViewGroups' SELECT * FROM ViewGroups WHERE Id IN (1, 10) SELECT * FROM ViewGroups WHERE Id <= 10
Name | Type | Description |
Id [KEY] | Integer | |
Name | String |
You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.
The following tables return database metadata for Bcart:
The following tables return information about how to connect to and query the data source:
The following table returns query statistics for data modification queries:
Lists the available databases.
The following query retrieves all databases determined by the connection string:
SELECT * FROM sys_catalogs
Name | Type | Description |
CatalogName | String | The database name. |
Lists the available schemas.
The following query retrieves all available schemas:
SELECT * FROM sys_schemas
Name | Type | Description |
CatalogName | String | The database name. |
SchemaName | String | The schema name. |
Lists the available tables.
The following query retrieves the available tables and views:
SELECT * FROM sys_tables
Name | Type | Description |
CatalogName | String | The database containing the table or view. |
SchemaName | String | The schema containing the table or view. |
TableName | String | The name of the table or view. |
TableType | String | The table type (table or view). |
Description | String | A description of the table or view. |
IsUpdateable | Boolean | Whether the table can be updated. |
Describes the columns of the available tables and views.
The following query returns the columns and data types for the Products table:
SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Products'
Name | Type | Description |
CatalogName | String | The name of the database containing the table or view. |
SchemaName | String | The schema containing the table or view. |
TableName | String | The name of the table or view containing the column. |
ColumnName | String | The column name. |
DataTypeName | String | The data type name. |
DataType | Int32 | An integer indicating the data type. This value is determined at run time based on the environment. |
Length | Int32 | The storage size of the column. |
DisplaySize | Int32 | The designated column's normal maximum width in characters. |
NumericPrecision | Int32 | The maximum number of digits in numeric data. The column length in characters for character and date-time data. |
NumericScale | Int32 | The column scale or number of digits to the right of the decimal point. |
IsNullable | Boolean | Whether the column can contain null. |
Description | String | A brief description of the column. |
Ordinal | Int32 | The sequence number of the column. |
IsAutoIncrement | String | Whether the column value is assigned in fixed increments. |
IsGeneratedColumn | String | Whether the column is generated. |
IsHidden | Boolean | Whether the column is hidden. |
IsArray | Boolean | Whether the column is an array. |
IsReadOnly | Boolean | Whether the column is read-only. |
IsKey | Boolean | Indicates whether a field returned from sys_tablecolumns is the primary key of the table. |
Lists the available stored procedures.
The following query retrieves the available stored procedures:
SELECT * FROM sys_procedures
Name | Type | Description |
CatalogName | String | The database containing the stored procedure. |
SchemaName | String | The schema containing the stored procedure. |
ProcedureName | String | The name of the stored procedure. |
Description | String | A description of the stored procedure. |
ProcedureType | String | The type of the procedure, such as PROCEDURE or FUNCTION. |
Describes stored procedure parameters.
The following query returns information about all of the input parameters for the SelectEntries stored procedure:
SELECT * FROM sys_procedureparameters WHERE ProcedureName='SelectEntries' AND Direction=1 OR Direction=2
Name | Type | Description |
CatalogName | String | The name of the database containing the stored procedure. |
SchemaName | String | The name of the schema containing the stored procedure. |
ProcedureName | String | The name of the stored procedure containing the parameter. |
ColumnName | String | The name of the stored procedure parameter. |
Direction | Int32 | An integer corresponding to the type of the parameter: input (1), input/output (2), or output(4). input/output type parameters can be both input and output parameters. |
DataTypeName | String | The name of the data type. |
DataType | Int32 | An integer indicating the data type. This value is determined at run time based on the environment. |
Length | Int32 | The number of characters allowed for character data. The number of digits allowed for numeric data. |
NumericPrecision | Int32 | The maximum precision for numeric data. The column length in characters for character and date-time data. |
NumericScale | Int32 | The number of digits to the right of the decimal point in numeric data. |
IsNullable | Boolean | Whether the parameter can contain null. |
IsRequired | Boolean | Whether the parameter is required for execution of the procedure. |
IsArray | Boolean | Whether the parameter is an array. |
Description | String | The description of the parameter. |
Ordinal | Int32 | The index of the parameter. |
Describes the primary and foreign keys.
The following query retrieves the primary key for the Products table:
SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Products'
Name | Type | Description |
CatalogName | String | The name of the database containing the key. |
SchemaName | String | The name of the schema containing the key. |
TableName | String | The name of the table containing the key. |
ColumnName | String | The name of the key column. |
IsKey | Boolean | Whether the column is a primary key in the table referenced in the TableName field. |
IsForeignKey | Boolean | Whether the column is a foreign key referenced in the TableName field. |
PrimaryKeyName | String | The name of the primary key. |
ForeignKeyName | String | The name of the foreign key. |
ReferencedCatalogName | String | The database containing the primary key. |
ReferencedSchemaName | String | The schema containing the primary key. |
ReferencedTableName | String | The table containing the primary key. |
ReferencedColumnName | String | The column name of the primary key. |
Describes the foreign keys.
The following query retrieves all foreign keys which refer to other tables:
SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
Name | Type | Description |
CatalogName | String | The name of the database containing the key. |
SchemaName | String | The name of the schema containing the key. |
TableName | String | The name of the table containing the key. |
ColumnName | String | The name of the key column. |
PrimaryKeyName | String | The name of the primary key. |
ForeignKeyName | String | The name of the foreign key. |
ReferencedCatalogName | String | The database containing the primary key. |
ReferencedSchemaName | String | The schema containing the primary key. |
ReferencedTableName | String | The table containing the primary key. |
ReferencedColumnName | String | The column name of the primary key. |
ForeignKeyType | String | Designates whether the foreign key is an import (points to other tables) or export (referenced from other tables) key. |
Describes the primary keys.
The following query retrieves the primary keys from all tables and views:
SELECT * FROM sys_primarykeys
Name | Type | Description |
CatalogName | String | The name of the database containing the key. |
SchemaName | String | The name of the schema containing the key. |
TableName | String | The name of the table containing the key. |
ColumnName | String | The name of the key column. |
KeySeq | String | The sequence number of the primary key. |
KeyName | String | The name of the primary key. |
Describes the available indexes. By filtering on indexes, you can write more selective queries with faster query response times.
The following query retrieves all indexes that are not primary keys:
SELECT * FROM sys_indexes WHERE IsPrimary='false'
Name | Type | Description |
CatalogName | String | The name of the database containing the index. |
SchemaName | String | The name of the schema containing the index. |
TableName | String | The name of the table containing the index. |
IndexName | String | The index name. |
ColumnName | String | The name of the column associated with the index. |
IsUnique | Boolean | True if the index is unique. False otherwise. |
IsPrimary | Boolean | True if the index is a primary key. False otherwise. |
Type | Int16 | An integer value corresponding to the index type: statistic (0), clustered (1), hashed (2), or other (3). |
SortOrder | String | The sort order: A for ascending or D for descending. |
OrdinalPosition | Int16 | The sequence number of the column in the index. |
Returns information on the available connection properties and those set in the connection string.
When querying this table, the config connection string should be used:
jdbc:cdata:bcart:config:
This connection string enables you to query this table without a valid connection.
The following query retrieves all connection properties that have been set in the connection string or set through a default value:
SELECT * FROM sys_connection_props WHERE Value <> ''
Name | Type | Description |
Name | String | The name of the connection property. |
ShortDescription | String | A brief description. |
Type | String | The data type of the connection property. |
Default | String | The default value if one is not explicitly set. |
Values | String | A comma-separated list of possible values. A validation error is thrown if another value is specified. |
Value | String | The value you set or a preconfigured default. |
Required | Boolean | Whether the property is required to connect. |
Category | String | The category of the connection property. |
IsSessionProperty | String | Whether the property is a session property, used to save information about the current connection. |
Sensitivity | String | The sensitivity level of the property. This informs whether the property is obfuscated in logging and authentication forms. |
PropertyName | String | A camel-cased truncated form of the connection property name. |
Ordinal | Int32 | The index of the parameter. |
CatOrdinal | Int32 | The index of the parameter category. |
Hierarchy | String | Shows dependent properties associated that need to be set alongside this one. |
Visible | Boolean | Informs whether the property is visible in the connection UI. |
ETC | String | Various miscellaneous information about the property. |
Describes the SELECT query processing that the Cloud can offload to the data source.
See SQL Compliance for SQL syntax details.
Below is an example data set of SQL capabilities. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.
Name | Description | Possible Values |
AGGREGATE_FUNCTIONS | Supported aggregation functions. | AVG, COUNT, MAX, MIN, SUM, DISTINCT |
COUNT | Whether COUNT function is supported. | YES, NO |
IDENTIFIER_QUOTE_OPEN_CHAR | The opening character used to escape an identifier. | [ |
IDENTIFIER_QUOTE_CLOSE_CHAR | The closing character used to escape an identifier. | ] |
SUPPORTED_OPERATORS | A list of supported SQL operators. | =, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR |
GROUP_BY | Whether GROUP BY is supported, and, if so, the degree of support. | NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE |
OJ_CAPABILITIES | The supported varieties of outer joins supported. | NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS |
OUTER_JOINS | Whether outer joins are supported. | YES, NO |
SUBQUERIES | Whether subqueries are supported, and, if so, the degree of support. | NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED |
STRING_FUNCTIONS | Supported string functions. | LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE |
NUMERIC_FUNCTIONS | Supported numeric functions. | ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE |
TIMEDATE_FUNCTIONS | Supported date/time functions. | NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT |
REPLICATION_SKIP_TABLES | Indicates tables skipped during replication. | |
REPLICATION_TIMECHECK_COLUMNS | A string array containing a list of columns which will be used to check for (in the given order) to use as a modified column during replication. | |
IDENTIFIER_PATTERN | String value indicating what string is valid for an identifier. | |
SUPPORT_TRANSACTION | Indicates if the provider supports transactions such as commit and rollback. | YES, NO |
DIALECT | Indicates the SQL dialect to use. | |
KEY_PROPERTIES | Indicates the properties which identify the uniform database. | |
SUPPORTS_MULTIPLE_SCHEMAS | Indicates if multiple schemas may exist for the provider. | YES, NO |
SUPPORTS_MULTIPLE_CATALOGS | Indicates if multiple catalogs may exist for the provider. | YES, NO |
DATASYNCVERSION | The CData Data Sync version needed to access this driver. | Standard, Starter, Professional, Enterprise |
DATASYNCCATEGORY | The CData Data Sync category of this driver. | Source, Destination, Cloud Destination |
SUPPORTSENHANCEDSQL | Whether enhanced SQL functionality beyond what is offered by the API is supported. | TRUE, FALSE |
SUPPORTS_BATCH_OPERATIONS | Whether batch operations are supported. | YES, NO |
SQL_CAP | All supported SQL capabilities for this driver. | SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX |
PREFERRED_CACHE_OPTIONS | A string value specifies the preferred cacheOptions. | |
ENABLE_EF_ADVANCED_QUERY | Indicates if the driver directly supports advanced queries coming from Entity Framework. If not, queries will be handled client side. | YES, NO |
PSEUDO_COLUMNS | A string array indicating the available pseudo columns. | |
MERGE_ALWAYS | If the value is true, The Merge Mode is forcibly executed in Data Sync. | TRUE, FALSE |
REPLICATION_MIN_DATE_QUERY | A select query to return the replicate start datetime. | |
REPLICATION_MIN_FUNCTION | Allows a provider to specify the formula name to use for executing a server side min. | |
REPLICATION_START_DATE | Allows a provider to specify a replicate startdate. | |
REPLICATION_MAX_DATE_QUERY | A select query to return the replicate end datetime. | |
REPLICATION_MAX_FUNCTION | Allows a provider to specify the formula name to use for executing a server side max. | |
IGNORE_INTERVALS_ON_INITIAL_REPLICATE | A list of tables which will skip dividing the replicate into chunks on the initial replicate. | |
CHECKCACHE_USE_PARENTID | Indicates whether the CheckCache statement should be done against the parent key column. | TRUE, FALSE |
CREATE_SCHEMA_PROCEDURES | Indicates stored procedures that can be used for generating schema files. |
The following query retrieves the operators that can be used in the WHERE clause:
SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'
Note that individual tables may have different limitations or requirements on the WHERE clause; refer to the Data Model section for more information.
Name | Type | Description |
NAME | String | A component of SQL syntax, or a capability that can be processed on the server. |
VALUE | String | Detail on the supported SQL or SQL syntax. |
Returns information about attempted modifications.
The following query retrieves the Ids of the modified rows in a batch operation:
SELECT * FROM sys_identity
Name | Type | Description |
Id | String | The database-generated Id returned from a data modification operation. |
Batch | String | An identifier for the batch. 1 for a single operation. |
Operation | String | The result of the operation in the batch: INSERTED, UPDATED, or DELETED. |
Message | String | SUCCESS or an error message if the update in the batch failed. |
The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.
For more information on establishing a connection, see Establishing a Connection.
Property | Description |
PersonalAccessToken | The Personal Access Token allows you to make requests to the Bcart API. |
Property | Description |
SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
Property | Description |
Verbosity | The verbosity level that determines the amount of detail included in the log file. |
Property | Description |
BrowsableSchemas | This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC. |
Property | Description |
IncludeCustomFields | Set this to true if you want to retrieve custom fields from each table. |
MaxRows | Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses. |
PseudoColumns | This property indicates whether or not to include pseudo columns as columns to the table. |
Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
UseDisplayNames | If set to true, Display name of custom field will be used for each column name. |
This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.
Property | Description |
PersonalAccessToken | The Personal Access Token allows you to make requests to the Bcart API. |
The Personal Access Token allows you to make requests to the Bcart API.
string
""
After logging in to Bcart API Management page, go to the Application Management, click Create New Token, enter the Name and slelect the necessary permissions. After that you can get the Personal Access Token.
This section provides a complete list of the SSL properties you can configure in the connection string for this provider.
Property | Description |
SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
The certificate to be accepted from the server when connecting using TLS/SSL.
string
""
If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.
This property can take the following forms:
Description | Example |
A full PEM Certificate (example shortened for brevity) | -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE----- |
A path to a local file containing the certificate | C:\cert.cer |
The public key (example shortened for brevity) | -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY----- |
The MD5 Thumbprint (hex values can also be either space or colon separated) | ecadbdda5a1529c58a1e9e09828d70e4 |
The SHA1 Thumbprint (hex values can also be either space or colon separated) | 34a929226ae0819f2ec14b4a3d904f801cbb150d |
If not specified, any certificate trusted by the machine is accepted.
Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.
This section provides a complete list of the Logging properties you can configure in the connection string for this provider.
Property | Description |
Verbosity | The verbosity level that determines the amount of detail included in the log file. |
The verbosity level that determines the amount of detail included in the log file.
string
"1"
The verbosity level determines the amount of detail that the Cloud reports to the Logfile. Verbosity levels from 1 to 5 are supported. These are detailed in the Logging page.
This section provides a complete list of the Schema properties you can configure in the connection string for this provider.
Property | Description |
BrowsableSchemas | This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC. |
This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
string
""
Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.
This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.
Property | Description |
IncludeCustomFields | Set this to true if you want to retrieve custom fields from each table. |
MaxRows | Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses. |
PseudoColumns | This property indicates whether or not to include pseudo columns as columns to the table. |
Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
UseDisplayNames | If set to true, Display name of custom field will be used for each column name. |
Set this to true if you want to retrieve custom fields from each table.
bool
false
Set this to true if you want to retrieve custom fields from each table.
Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
int
-1
Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
This property indicates whether or not to include pseudo columns as columns to the table.
string
""
This setting is particularly helpful in Entity Framework, which does not allow you to set a value for a pseudo column unless it is a table column. The value of this connection setting is of the format "Table1=Column1, Table1=Column2, Table2=Column3". You can use the "*" character to include all tables and all columns; for example, "*=*".
The value in seconds until the timeout error is thrown, canceling the operation.
int
60
If Timeout = 0, operations do not time out. The operations run until they complete successfully or until they encounter an error condition.
If Timeout expires and the operation is not yet complete, the Cloud throws an exception.
If set to true, Display name of custom field will be used for each column name.
bool
false
If set to true, Display name of custom field will be used for each column name.