eBay Analytics Connection Details
Introduction
Connector Version
This documentation is based on version 23.0.9039 of the connector.
Get Started
eBay Analytics Version Support
The connector leverages the EbayAnalytics API to enable bidirectional access to EbayAnalytics.
Establish a Connection
Connect to eBay Analytics
You can establish a connection and authenticate to the eBay Analytics only via the OAuth 2 authentication method. The eBay Analytics API requires an access token created with the authorization code grant flow to authorize the requests.
Authenticate to eBay Analytics
eBay Analytics supports OAuth authentication only. AuthScheme
must be set to OAuth
in all OAuth flows.
Desktop Applications
You must create a custom OAuth application to authenticate via a desktop application. See Creating a Custom OAuth App for more information.
Get and Refresh the OAuth Access Token
After setting the following, you are ready to connect:
InitiateOAuth
: Set this toGETANDREFRESH
. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting theOAuthAccessToken
.OAuthClientId
: Set this to the App Id(client Id) assigned when you registered your application.OAuthClientSecret
: Set this to the Cert ID (client secret) assigned when you registered your application.RuName
: Set this to the Redirect URL name of the OAuth application in the 'Application access' section.CallbackURL
(Optional): Set this to a local Redirect URL (ex.http://localhost:33333
) in case your OAuth application'sauth accepted URL
is set tohttps://oauth.cdata.com/oauth/
or to the actual one in case you are using another redirect URL.- (Optional)
UseSandbox
: Set this to True if you are connecting to the Sandbox environment
When you connect, the connector opens eBay Analytics's OAuth endpoint in your default browser. Log in and grant permissions to the application. The connector then completes the OAuth process:
- Extracts the access token from the callback URL and authenticates requests.
- Obtains a new access token when the old one expires.
- Saves OAuth values in
OAuthSettingsLocation
. These values persist across connections.
Create a Custom OAuth App
eBay Analytics supports the OAuth 2.0 Authentication method. To perform this authentication, you need to first join the eBay Developers Program.
Register an OAuth Application and get your OAuth credentials
You can follow the procedure below to obtain the OAuth client credentials, the OAuthClientId
, OAuthClientSecret
and the RuName
.
-
In the
developers program Home
, select theApplication access keys
option from the dropdown list of the "Hi YourAccountName" menu bar button. -
On the
Application Keys
page. create an OAuth application and request a pair of OAuth credentials for either your Production environment or for your Sandbox one. -
After generating and saving your App ID (Client ID) and your Cert ID (Client Secret), click
User Tokens
next to your App ID (Client ID) of the keyset you want to use.- Use production keys if you are getting analytics data from your real eBay store.
- Use sandbox keys if you are looking to get analytics data from the eBay testing environment.
-
Click
Get a Token from eBay via Your Application
and in the expanded section make sure that you selectOAuth enabled
and setYour auth accepted URL
to your preferred Callback URL. Here you should also retrieve and save theRuName
(redirect_uri).Note that eBay Analytics requires a secure Redirect URI (https). For Desktop applications you can set this to
https://oauth.cdata.com/oauth/
and optionally, theCallbackURL
connection property to a local Redirect URL (for example,http://localhost:33333
).
After following these steps, save the OAuthClientId
, OAuthClientSecret
and RuName
with the configured CallbackURL
.
Important Notes
Configuration Files and Their Paths
- All references to adding configuration files and their paths refer to files and locations on the Jitterbit agent where the connector is installed. These paths are to be adjusted as appropriate depending on the agent and the operating system. If multiple agents are used in an agent group, identical files will be required on each agent.
Advanced Features
This section details a selection of advanced features of the eBay Analytics connector.
User Defined Views
The connector allows you to define virtual tables, called user defined views, whose contents are decided by a pre-configured query. These views are useful when you cannot directly control queries being issued to the drivers. See User Defined Views for an overview of creating and configuring custom views.
SSL Configuration
Use SSL Configuration to adjust how connector handles TLS/SSL certificate negotiations. You can choose from various certificate formats; see the SSLServerCert
property under "Connection String Options" for more information.
Proxy
To configure the connector using private agent proxy settings, select the Use Proxy Settings
checkbox on the connection configuration screen.
Query Processing
The connector offloads as much of the SELECT statement processing as possible to eBay Analytics and then processes the rest of the query in memory (client-side).
See Query Processing for more information.
User Defined Views
The eBay Analytics connector allows you to define a virtual table whose contents are decided by a pre-configured query. These are called User Defined Views, which are useful in situations where you cannot directly control the query being issued to the driver, e.g. when using the driver from Jitterbit. The User Defined Views can be used to define predicates that are always applied. If you specify additional predicates in the query to the view, they are combined with the query already defined as part of the view.
There are two ways to create user defined views:
- Create a JSON-formatted configuration file defining the views you want.
- DDL statements.
Define Views Using a Configuration File
User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json
. The connector automatically detects the views specified in this file.
You can also have multiple view definitions and control them using the UserDefinedViews
connection property. When you use this property, only the specified views are seen by the connector.
This User Defined View configuration file is formatted as follows:
- Each root element defines the name of a view.
- Each root element contains a child element, called
query
, which contains the custom SQL query for the view.
For example:
{
"MyView": {
"query": "SELECT * FROM TrafficReportByListing WHERE MyColumn = 'value'"
},
"MyView2": {
"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
}
}
Use the UserDefinedViews
connection property to specify the location of your JSON configuration file. For example:
"UserDefinedViews", "C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json"
Define Views Using DDL Statements
The connector is also capable of creating and altering the schema via DDL Statements such as CREATE LOCAL VIEW, ALTER LOCAL VIEW, and DROP LOCAL VIEW.
Create a View
To create a new view using DDL statements, provide the view name and query as follows:
CREATE LOCAL VIEW [MyViewName] AS SELECT * FROM Customers LIMIT 20;
If no JSON file exists, the above code creates one. The view is then created in the JSON configuration file and is now discoverable. The JSON file location is specified by the UserDefinedViews
connection property.
Alter a View
To alter an existing view, provide the name of an existing view alongside the new query you would like to use instead:
ALTER LOCAL VIEW [MyViewName] AS SELECT * FROM Customers WHERE TimeModified > '3/1/2020';
The view is then updated in the JSON configuration file.
Drop a View
To drop an existing view, provide the name of an existing schema alongside the new query you would like to use instead.
DROP LOCAL VIEW [MyViewName]
This removes the view from the JSON configuration file. It can no longer be queried.
Schema for User Defined Views
User Defined Views are exposed in the UserViews
schema by default. This is done to avoid the view's name clashing with an actual entity in the data model. You can change the name of the schema used for UserViews by setting the UserViewsSchemaName
property.
Work with User Defined Views
For example, a SQL statement with a User Defined View called UserViews.RCustomers
only lists customers in Raleigh:
SELECT * FROM Customers WHERE City = 'Raleigh';
An example of a query to the driver:
SELECT * FROM UserViews.RCustomers WHERE Status = 'Active';
Resulting in the effective query to the source:
SELECT * FROM Customers WHERE City = 'Raleigh' AND Status = 'Active';
That is a very simple example of a query to a User Defined View that is effectively a combination of the view query and the view definition. It is possible to compose these queries in much more complex patterns. All SQL operations are allowed in both queries and are combined when appropriate.
SSL Configuration
Customize the SSL Configuration
By default, the connector 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.
Data Model
Overview
This section shows the available API resources and provides more information on executing SQL to eBay Analytics APIs.
Key Features
- The connector models eBay Analytics reports as relational views, allowing you to write SQL to query eBay Analytics data.
- Stored procedures allow you to execute operations to eBay Analytics.
- Live connectivity to these objects means any changes to your eBay Analytics account are immediately reflected when using the connector.
Views
Views describes the available views. Views are statically defined to model CustomerServiceMetricByCategory, CustomerServiceMetricByShippingRegion, SellerStandardsProfile, TrafficReportByDay and TrafficReportByListing.
Stored Procedures
Stored Procedures are function-like interfaces to eBay Analytics. Stored procedures allow you to execute operations to eBay Analytics. The eBay Analytics supports only stored procedures related to authentication.
Views
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.
eBay Analytics Connector Views
Name | Description |
---|---|
CustomerServiceMetricByCategory | Returns a seller's performance and rating for the customer service metric by the primary proudct categories. |
CustomerServiceMetricByShippingRegion | Returns a seller's performance and rating for the customer service metric by the established shipping corridors. |
SellerStandardsProfile | Returns the standards profiles for the associated seller. |
TrafficReportByDay | Returns a report that details the user traffic received by a seller's listings per day. |
TrafficReportByListing | Returns a report that details the user traffic received by a seller's listings per listing. |
CustomerServiceMetricByCategory
Returns a seller's performance and rating for the customer service metric by the primary proudct categories.
Select
The connector will use the eBay Analytics API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the connector.
To query the CustomerServiceMetricByCategory view, a value for the EvaluationType
and MarketplaceId
columns should be specified.
-
In case, the MarketplaceId is not specified, the value set in the
MarketplaceId
connection property will be used instead by default.The MarketplaceId is server side filterable and supports only the operator: =.
Supported MarketplaceId values are: EBAY_AU, EBAY_CA, EBAY_FR, EBAY_DE, EBAY_GB, EBAY_IT, EBAY_ES and EBAY_US.
-
In case, the EvaluationType is not specified, the eBay Analytics will generate a report based on the data for the CURRENT period.
The EvaluationType is server side filterable and supports only the operator: =.
Supported EvaluationType values are: CURRENT and PROJECTED.
The example query below will return CustomerServiceMetricByCategory data for the CURRENT Evaluation Type period and for the Marketplace specified in the MarketplaceId
connection property.
SELECT * FROM CustomerServiceMetricByCategory
The example query below will return CustomerServiceMetricByCategory data for the PROJECTED Evaluation Type period and for the US Marketplace.
SELECT * FROM CustomerServiceMetricByCategory WHERE EvaluationType = 'PROJECTED' AND MarketplaceId = 'EBAY_US'
Note
Querying this view will return results only if the below conditions are met.
- The seller has a valid transaction on the specified marketplace (
MarketplaceId
) during the past 12 months. - If the 'CURRENT' EvaluationType is specified, the seller must have been active on the specified marketplace (
MarketplaceId
) for a complete benchmarking period (eBay evaluation period, usually one month).
Columns
Name | Type | Description |
---|---|---|
CategoryId | String | The primary category ID in which the items being rated were listed. |
CategoryName | String | The primary category name in which the items being rated were listed. |
TransactionCount | Integer | The total number of transactions completed in the seller group for the MetricType in the given dimension during the associated evaluationCycle. |
Count | Integer | The total number of transactions the seller completed that meet the criteria of the MetricType for the given dimension that occurred during the evaluationCycle. |
DistributionsBasis | String | The overarching basis by which an array of seller data is grouped. Along with DistributionsData, they expand the total number of transactions in Count column grouped by a certain basis. |
DistributionsData | String | Expands the Count column data via an aggregated list of name/value pairs, where the name indicates the distribution being rated and the value indicates the count of seller transactions that meet the distribution criteria. |
Rate | Double | The rate of the customer service MetricType in the given dimension during the associated evaluationCycle. Specifically, it is the TransactionCount divided by the Count value. |
BenchmarkBasis | String | The basis by which the benchmark is calculated for the MetricType. |
BenchmarkRating | String | The seller's rating for the ServiceMetric. It represents the relative deviation between the seller's Rate metric value and the benchmark value for the specified ServiceMetric. |
BenchmarkAverage | Double | The average value for the group, as defined by the specified BenchmarkBasis. When BenchmarkBasis is 'PEER_BENCHMARK', this is the benchmark value to which the seller's metric value is compared to determine the BenchmarkRating for the ServiceMetric. |
BenchmarkAdjustment | String | The reason why the rating given to the seller was adjusted. |
EvaluationDate | Datetime | Date and time at which the seller was evaluated for this customer service metric rating. |
EvaluationType | String | This field specifies the transaction lookback period used for the evaluation. Supported values are: CURRENT, PROJECTED. |
StartDate | Datetime | The start date and time of the transaction lookback range. |
EndDate | Datetime | End date and time of the transaction lookback range. |
MarketplaceId | String | The eBay marketplace ID of the marketplace upon which the customer service metric evaluation is based. |
MetricType | String | The type of customer service metric. |
CustomerServiceMetricByShippingRegion
Returns a seller's performance and rating for the customer service metric by the established shipping corridors.
Select
The connector will use the eBay Analytics API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the connector.
To query the CustomerServiceMetricByShippingRegion view, a value for the EvaluationType
and MarketplaceId
columns should be specified.
-
In case, the MarketplaceId is not specified, the value set in the
MarketplaceId
connection property will be used instead by default.The MarketplaceId is server side filterable and supports only the operator: =.
Supported MarketplaceId values are: EBAY_AU, EBAY_CA, EBAY_FR, EBAY_DE, EBAY_GB, EBAY_IT, EBAY_ES and EBAY_US.
-
In case, the EvaluationType is not specified, the eBay Analytics will generate a report based on the data for the CURRENT period.
The EvaluationType is server side filterable and supports only the operator: =.
Supported EvaluationType values are: CURRENT and PROJECTED.
The example query below will return CustomerServiceMetricByShippingRegion data for the CURRENT Evaluation Type period and for the Marketplace specified in the MarketplaceId
connection property.
SELECT * FROM CustomerServiceMetricByShippingRegion
The example query below will return CustomerServiceMetricByShippingRegion data for the PROJECTED Evaluation Type period and for the German Marketplace.
SELECT * FROM CustomerServiceMetricByShippingRegion WHERE EvaluationType = 'PROJECTED' AND MarketplaceId = 'EBAY_DE'
Note
Querying this view will return results only if the below conditions are met.
- The seller has a valid transaction on the specified marketplace (
MarketplaceId
) during the past 12 months. - If the 'CURRENT' EvaluationType is specified, the seller must have been active on the specified marketplace (
MarketplaceId
) for a complete benchmarking period (eBay evaluation period, usually one month).
Columns
Name | Type | Description |
---|---|---|
ShippingRegionId | String | The ID of the established shipping corridor. |
ShippingRegionName | String | The Name of the established shipping corridor. |
TransactionCount | Integer | The total number of transactions completed in the seller group for the MetricType in the given dimension during the associated evaluationCycle. |
Count | Integer | The total number of transactions the seller completed that meet the criteria of the MetricType for the given dimension that occurred during the evaluationCycle. |
DistributionsBasis | String | The overarching basis by which an array of seller data is grouped. Along with DistributionsData, they expand the total number of transactions in Count column grouped by a certain basis. |
DistributionsData | String | Expands the Count column data via an aggregated list of name/value pairs, where the name indicates the distribution being rated and the value indicates the count of seller transactions that meet the distribution criteria. |
Rate | Double | The rate of the customer service MetricType in the given dimension during the associated evaluationCycle. Specifically, it is the TransactionCount divided by the Count value. |
BenchmarkBasis | String | The basis by which the benchmark is calculated for the MetricType. |
BenchmarkRating | String | The seller's rating for the ServiceMetric. It represents the relative deviation between the seller's Rate metric value and the benchmark value for the specified ServiceMetric. |
BenchmarkAverage | Double | The average value for the group, as defined by the specified BenchmarkBasis. When BenchmarkBasis is 'PEER_BENCHMARK', this is the benchmark value to which the seller's metric value is compared to determine the BenchmarkRating for the ServiceMetric. |
BenchmarkAdjustment | String | The reason why the rating given to the seller was adjusted. |
EvaluationDate | Datetime | Date and time at which the seller was evaluated for this customer service metric rating. |
EvaluationType | String | This field specifies the transaction lookback period used for the evaluation. Supported values are: CURRENT, PROJECTED. |
StartDate | Datetime | The start date and time of the transaction lookback range. |
EndDate | Datetime | End date and time of the transaction lookback range. |
MarketplaceId | String | The eBay marketplace ID of the marketplace upon which the customer service metric evaluation is based. |
MetricType | String | The type of customer service metric. |
SellerStandardsProfile
Returns the standards profiles for the associated seller.
Select
The connector will use the eBay Analytics API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the connector.
The Program
and Cycle
columns support server side filtering only when specified at the same time and only for the = operator.
- Supported values for the Program column are: PROGRAM_DE, PROGRAM_UK, PROGRAM_US and PROGRAM_GLOBAL.
- Supported values for the Cycle column are: CURRENT and PROJECTED.
For example, the query below is processed server side and it returns the SellerStandardsProfile report data for the Current cycle based on the US Program standards.
SELECT * FROM SellerStandardsProfile WHERE Cycle = 'CURRENT' AND Program = 'PROGRAM_US'
The other example query below, will return the SellerStandardsProfile for every available program standards region and for both cycles, Current and PROJECTED.
SELECT * FROM SellerStandardsProfile
Columns
Name | Type | Description |
---|---|---|
Program | String | The program used to generate the profile data. Values can be PROGRAM_DE, PROGRAM_UK, PROGRAM_US, or PROGRAM_GLOBAL. |
DefaultProgram | Boolean | Boolean indicating if this is the default program for the seller. |
StandardsLevel | String | The overall standards level of the seller, one of TOP_RATED, ABOVE_STANDARD, or BELOW_STANDARD. |
EvaluationReason | String | Specifies how the overall seller level was calculated. |
Cycle | String | The cycle type, either CURRENT or PROJECTED. CURRENT means the profile's metrics values are from the most recent official eBay monthly standards evaluation. PROJECTED means the profile values were determined when the profile was requested. |
EvaluationDate | Datetime | The date and time at which the standard compliance values were determined for the profile. |
EvaluationMonth | String | The month in which the currently effective seller level was computed. The value is always formatted as YYYY-MM. If the cycle is CURRENT, this value is the month and year the of the last eBay compliance evaluation. If this is for a PROJECTED cycle, the value is the month and year of the next scheduled evaluation. |
MinimumDaysOnSite | Integer | Minimum days on site. |
Transactions | Integer | The total Transactions count. |
SalesAmount | Decimal | The total Sales amount. |
TransactionDefectRate | Decimal | Transaction defect rate. |
CasesClosedWithoutSellerResolution | Decimal | Total cases closed without seller resolution. |
LateShipmentRate | Decimal | Late shipment rate. |
TrackingUploadedOnTimeAndValidated | Decimal | Tracking uploaded on time and validated. |
BusinessSeller | Boolean | Business seller critera met. |
PowerSeller | Boolean | Power seller criteria met. |
MinimumDaysOnSiteLevel | String | The seller level for the MinimumDaysOnSite metric, which indicates how well the seller is doing in meeting eBay's standards for this metric. Possible values are TOP_RATED, ABOVE_STANDARD, and BELOW_STANDARD. |
TransactionsLevel | String | The seller level for the Transactions metric, which indicates how well the seller is doing in meeting eBay's standards for this metric. Possible values are TOP_RATED, ABOVE_STANDARD, and BELOW_STANDARD. |
SalesAmountLevel | String | The seller level for the SalesAmount metric, which indicates how well the seller is doing in meeting eBay's standards for this metric. Possible values are TOP_RATED, ABOVE_STANDARD, and BELOW_STANDARD. |
TransactionDefectRateLevel | String | The seller level for the TransactionDefectRate metric, which indicates how well the seller is doing in meeting eBay's standards for this metric. Possible values are TOP_RATED, ABOVE_STANDARD, and BELOW_STANDARD. |
CasesClosedWithoutSellerResolutionLevel | String | The seller level for the CasesClosedWithoutSellerResolution metric, which indicates how well the seller is doing in meeting eBay's standards for this metric. Possible values are TOP_RATED, ABOVE_STANDARD, and BELOW_STANDARD. |
LateShipmentRateLevel | String | The seller level for the LateShipmentRate metric, which indicates how well the seller is doing in meeting eBay's standards for this metric. Possible values are TOP_RATED, ABOVE_STANDARD, and BELOW_STANDARD. |
TrackingUploadedOnTimeAndValidatedLevel | String | The seller level for the TrackingUploadedOnTimeAndValidated metric, which indicates how well the seller is doing in meeting eBay's standards for this metric. Possible values are TOP_RATED, ABOVE_STANDARD, and BELOW_STANDARD. |
BusinessSellerLevel | String | The seller level for the BusinessSeller metric, which indicates how well the seller is doing in meeting eBay's standards for this metric. Possible values are TOP_RATED, ABOVE_STANDARD, and BELOW_STANDARD. |
PowerSellerLevel | String | The seller level for the PowerSeller metric, which indicates how well the seller is doing in meeting eBay's standards for this metric. Possible values are TOP_RATED, ABOVE_STANDARD, and BELOW_STANDARD. |
MinimumDaysOnSiteThresholdLowerBound | Integer | Specifies the lowest number value for the MinimumDaysOnSite metric can be and still qualify for the currently assigned seller level. |
TransactionsThresholdLowerBound | Integer | Specifies the lowest number value for the Transactions metric can be and still qualify for the currently assigned seller level. |
SalesAmountThresholdLowerBound | Decimal | Specifies the lowest number value for the SalesAmount metric can be and still qualify for the currently assigned seller level. |
TrackingUploadedOnTimeAndValidatedThresholdLowerBound | Decimal | Specifies the lowest number value for the TrackingUploadedOnTimeAndValidated metric can be and still qualify for the currently assigned seller level. |
BusinessSellerThresholdLowerBound | Boolean | Specifies the lowest number value for the BusinessSeller metric can be and still qualify for the currently assigned seller level. |
PowerSellerThresholdLowerBound | Boolean | Specifies the lowest number value for the PowerSeller metric can be and still qualify for the currently assigned seller level. |
TransactionsThresholdUpperBound | Integer | Specifies the highest number value for the Transactions metric can be and still qualify for the currently assigned seller level. |
SalesAmountThresholdUpperBound | Decimal | Specifies the highest number value for the SalesAmount metric can be and still qualify for the currently assigned seller level. |
TransactionDefectRateThresholdUpperBound | Decimal | Specifies the highest number value for the TransactionDefectRate metric can be and still qualify for the currently assigned seller level. |
CasesClosedWithoutSellerResolutionThresholdUpperBound | Decimal | Specifies the highest number value for the CasesClosedWithoutSellerResolution metric can be and still qualify for the currently assigned seller level. |
LateShipmentRateThresholdUpperBound | Decimal | Specifies the highest number value for the LateShipmentRate metric can be and still qualify for the currently assigned seller level. |
BusinessSellerThresholdUpperBound | Boolean | Specifies the highest number value for the BusinessSeller metric can be and still qualify for the currently assigned seller level. |
PowerSellerThresholdUpperBound | Boolean | Specifies the highest number value for the PowerSeller metric can be and still qualify for the currently assigned seller level. |
MinimumDaysOnSiteThresholdMetaData | String | An expression that indicates the inclusive and exclusive characteristics of the upper and lower threshold boundaries for the MinimumDaysOnSite metric. The expression consists of two values separated by a comma, which are bounded by either a parenthesis or a square bracket. The parenthesis excludes the adjacent value, while the square bracket includes it. |
TransactionsThresholdMetaData | String | An expression that indicates the inclusive and exclusive characteristics of the upper and lower threshold boundaries for the Transactions metric. The expression consists of two values separated by a comma, which are bounded by either a parenthesis or a square bracket. The parenthesis excludes the adjacent value, while the square bracket includes it. |
SalesAmountThresholdMetaData | String | An expression that indicates the inclusive and exclusive characteristics of the upper and lower threshold boundaries for the SalesAmount metric. The expression consists of two values separated by a comma, which are bounded by either a parenthesis or a square bracket. The parenthesis excludes the adjacent value, while the square bracket includes it. |
TransactionDefectRateThresholdMetaData | String | An expression that indicates the inclusive and exclusive characteristics of the upper and lower threshold boundaries for the TransactionDefectRate metric. The expression consists of two values separated by a comma, which are bounded by either a parenthesis or a square bracket. The parenthesis excludes the adjacent value, while the square bracket includes it. |
CasesClosedWithoutSellerResolutionThresholdMetaData | String | An expression that indicates the inclusive and exclusive characteristics of the upper and lower threshold boundaries for the CasesClosedWithoutSellerResolution metric. The expression consists of two values separated by a comma, which are bounded by either a parenthesis or a square bracket. The parenthesis excludes the adjacent value, while the square bracket includes it. |
LateShipmentRateThresholdMetaData | String | An expression that indicates the inclusive and exclusive characteristics of the upper and lower threshold boundaries for the LateShipmentRate metric. The expression consists of two values separated by a comma, which are bounded by either a parenthesis or a square bracket. The parenthesis excludes the adjacent value, while the square bracket includes it. |
TrackingUploadedOnTimeAndValidatedThresholdMetaData | String | An expression that indicates the inclusive and exclusive characteristics of the upper and lower threshold boundaries for the TrackingUploadedOnTimeAndValidated metric. The expression consists of two values separated by a comma, which are bounded by either a parenthesis or a square bracket. The parenthesis excludes the adjacent value, while the square bracket includes it. |
TransactionsLookbackStartDate | Datetime | The start date and time when the seller was evaluated for the Transactions metric. |
SalesAmountLookbackStartDate | Datetime | The start date and time when the seller was evaluated for the SalesAmount metric. |
TransactionDefectRateLookbackStartDate | Datetime | The start date and time when the seller was evaluated for the TransactionDefectRate metric. |
CasesClosedWithoutSellerResolutionLookbackStartDate | Datetime | The start date and time when the seller was evaluated for the CasesClosedWithoutSellerResolution metric. |
LateShipmentRateLookbackStartDate | Datetime | The start date and time when the seller was evaluated for the LateShipmentRate metric. |
TrackingUploadedOnTimeAndValidatedLookbackStartDate | Datetime | The start date and time when the seller was evaluated for the TrackingUploadedOnTimeAndValidated metric. |
TransactionsLookbackEndDate | Datetime | The end date and time when the seller was evaluated for the Transactions metric. |
SalesAmountLookbackEndDate | Datetime | The end date and time when the seller was evaluated for the SalesAmount metric. |
TransactionDefectRateLookbackEndDate | Datetime | The end date and time when the seller was evaluated for the TransactionDefectRate metric. |
CasesClosedWithoutSellerResolutionLookbackEndDate | Datetime | The end date and time when the seller was evaluated for the CasesClosedWithoutSellerResolution metric. |
LateShipmentRateLookbackEndDate | Datetime | The end date and time when the seller was evaluated for the LateShipmentRate metric. |
TrackingUploadedOnTimeAndValidatedLookbackEndDate | Datetime | The end date and time when the seller was evaluated for the TrackingUploadedOnTimeAndValidated metric. |
SalesAmountCurrency | String | The sales amount currency. |
TrafficReportByDay
Returns a report that details the user traffic received by a seller's listings per day.
Select
The connector will use the eBay Analytics API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the connector.
To query the TrafficReportByDay view, a value for the MarketplaceId
and the report date range via the columns ReportStartDate
and ReportEndDate
should be specified.
-
In case, the MarketplaceId is not specified, the value set in the
MarketplaceId
connection property will be used instead by default.The MarketplaceId is server side filterable and supports the operators: "=" and "IN".
Supported MarketplaceId values are: EBAY_DE, EBAY_GB, EBAY_AU and EBAY_US.
-
In case, the report range (ReportStartDate and ReportEndDate) is not specified or partly specified, the driver will return the data for the last 90 days or 90 days before or after the partly specified range depending on which date range parameter is missing.
The ReportStartDate and ReportEndDate columns are server side filterable and support only the operator: =.
-
Additionally the user can limit the report data to a listing or to a group of listings via the
ListingId
input.The ListingId is server side filterable and supports the operators: "=" and "IN".
The example query below will return TrafficReportByDay data for the Marketplace specified in the MarketplaceId
connection property and for the last 90 days.
SELECT * FROM TrafficReportByDay
The other example query below, will return TrafficReportByDay data for the specified listings in the US Marketplace within the defined date range.
SELECT * FROM TrafficReportByDay WHERE ListingId IN ('182227914336', '182283742135', '311698881010') AND MarketplaceId = 'EBAY_US' AND ReportStartDate = '2019-07-12' AND ReportEndDate = '2019-09-13'
Columns
Name | Type | Description |
---|---|---|
Day | Date | The Day (individual date) by which the metrics are grouped. |
ClickThroughRate | Double | The number of times an item displays on the search results page divided by the number of times buyers clicked through to its View Item page. |
ListingImpressionSearchResultsPage | Integer | The number of times the seller's listings displayed on the search results page. Note, the listing might not have been visible to the buyer due to its position on the page. |
ListingImpressionStore | Integer | The number of times the seller's listings displayed on the seller's store. Note, the listing might not have been visible to the buyer due to its position on the page. |
ListingImpressionTotal | Integer | The total number of times the seller's listings displayed on the search results page OR in the seller's store. The item is counted each time it displays on either page. However, the listing might not have been visible to the buyer due to its position on the page. This is a combination of: ListingImpressionSearchResultsPage + ListingImpressionStore. |
ListingViewsSourceDirect | Integer | The number of times a View Item page was directly accessed, such as when a buyer navigates to the page using a bookmark. |
ListingViewsSourceOffEbay | Integer | The number of times a View Item page was accessed via a site other than eBay, such as when a buyer clicks on a link to the listing from a search engine page. |
ListingViewsSourceOtherEbay | Integer | The number of times a View Item page was accessed from an eBay page that is not either the search results page or the seller's store. |
ListingViewsSourceSearchResultsPage | Integer | The number of times the item displayed on the search results page. |
ListingViewsSourceStore | Integer | The number of times a View Item page was accessed via the seller's store. |
ListingViewsTotal | Integer | Total number of listings viewed. This number sums: ListingViewsSourceDirect, ListingViewsSourceOffEbay, ListingViewsSourceOtherEbay, ListingViewsSourceSearchResultsPage, ListingViewsSourceStore. |
SalesConversionRate | Double | The number of completed transactions divided by the number of View Item page views. Equals: TransactionsCount/ListingViewsTotal. |
TotalImpressionTotal | Integer | The total number of times the seller's listings have displayed on any page or flow. It matches the value on the Seller Hub performance/traffic page. It includes the impressions from the ListingImpressionTotal metric plus any other impressions including those listings that display on pages other than search result and store. The item is counted each time it displays on either page. However, the listing might not have been visible to the buyer due to its position on the page. |
TransactionsCount | Integer | The total number of completed transactions. |
UsageStartDate | Datetime | The start date of the actual date range of the report data. |
UsageEndDate | Datetime | The end date of the actual date range of the report data. |
LastUpdatedDate | Datetime | The last time the data returned in the report was updated. |
ReportStartDate | Date | The requested start date of the date range used to calculate the report. |
ReportEndDate | Date | The requested end date of the date range used to calculate the report. If you specify an report end date that is beyond the lastUpdatedDate value, eBay returns a report that contains data only up to the LastUpdateDate. For this reason, the provided ReportStartDate and ReportEndDate values used to request the report might not match with the report's actual date range: ReportStartDate - ReportEndDate. |
Pseudo-Columns
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 |
---|---|---|
MarketplaceId | String | The eBay marketplace ID of the marketplace upon which the seller report is limited. |
ListingId | String | The ID of the Listing by which the metrics are grouped. You can get your ListingId-s from the TrafficReportByListing view. |
TrafficReportByListing
Returns a report that details the user traffic received by a seller's listings per listing.
Select
The connector will use the eBay Analytics API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the connector.
To query the TrafficReportByListing view, at least the report date range via the columns ReportStartDate
and ReportEndDate
should be specified.
-
In case, the report range (ReportStartDate and ReportEndDate) is not specified or partly specified, the driver will return the data for the last 90 days or 90 days before or after the partly specified range depending on which date range parameter is missing.
The ReportStartDate and ReportEndDate columns are server side filterable and support only the operator: =.
-
The MarketplaceId input is server side filterable and can be used to limit the report data only to the specified Marketplaces.
The MarketplaceId input supports the operators: "=" and "IN".
Supported MarketplaceId values are: EBAY_DE, EBAY_GB, EBAY_AU and EBAY_US.
-
Additionally the user can limit the report data to a listing or to a group of listings via the
ListingId
column.The ListingId column is server side filterable and supports the operators: "=" and "IN".
The example query below will return TrafficReportByListing data for every available Marketplace, including every Listing the last 90 days.
SELECT * FROM TrafficReportByListing
The other example query below, will return TrafficReportByListing data for the specified listings in the GB Marketplace within the defined date range.
SELECT * FROM TrafficReportByListing WHERE ReportStartDate = '2019-06-20' AND ReportEndDate = '2019-09-15' AND ListingId IN ('201294636968', '201450979387', '201461563488') AND MarketplaceId = 'EBAY_GB'
Columns
Name | Type | Description |
---|---|---|
ListingId | String | The ID of the Listing by which the metrics are grouped. |
ListingName | String | The Listing Name. |
ClickThroughRate | Double | The number of times an item displays on the search results page divided by the number of times buyers clicked through to its View Item page. |
ListingImpressionSearchResultsPage | Integer | The number of times the seller's listings displayed on the search results page. Note, the listing might not have been visible to the buyer due to its position on the page. |
ListingImpressionStore | Integer | The number of times the seller's listings displayed on the seller's store. Note, the listing might not have been visible to the buyer due to its position on the page. |
ListingImpressionTotal | Integer | The total number of times the seller's listings displayed on the search results page OR in the seller's store. The item is counted each time it displays on either page. However, the listing might not have been visible to the buyer due to its position on the page. This is a combination of: ListingImpressionSearchResultsPage + ListingImpressionStore. |
ListingViewsSourceDirect | Integer | The number of times a View Item page was directly accessed, such as when a buyer navigates to the page using a bookmark. |
ListingViewsSourceOffEbay | Integer | The number of times a View Item page was accessed via a site other than eBay, such as when a buyer clicks on a link to the listing from a search engine page. |
ListingViewsSourceOtherEbay | Integer | The number of times a View Item page was accessed from an eBay page that is not either the search results page or the seller's store. |
ListingViewsSourceSearchResultsPage | Integer | The number of times the item displayed on the search results page. |
ListingViewsSourceStore | Integer | The number of times a View Item page was accessed via the seller's store. |
ListingViewsTotal | Integer | Total number of listings viewed. This number sums: ListingViewsSourceDirect, ListingViewsSourceOffEbay, ListingViewsSourceOtherEbay, ListingViewsSourceSearchResultsPage, ListingViewsSourceStore. |
SalesConversionRate | Double | The number of completed transactions divided by the number of View Item page views. Equals: TransactionsCount/ListingViewsTotal. |
TotalImpressionTotal | Integer | The total number of times the seller's listings have displayed on any page or flow. It matches the value on the Seller Hub performance/traffic page. It includes the impressions from the ListingImpressionTotal metric plus any other impressions including those listings that display on pages other than search result and store. The item is counted each time it displays on either page. However, the listing might not have been visible to the buyer due to its position on the page. |
TransactionsCount | Integer | The total number of completed transactions. |
UsageStartDate | Datetime | The start date of the actual date range of the report data. |
UsageEndDate | Datetime | The end date of the actual date range of the report data. |
LastUpdatedDate | Datetime | The last time the data returned in the report was updated. |
ReportStartDate | Date | The requested start date of the date range used to calculate the report. |
ReportEndDate | Date | The requested end date of the date range used to calculate the report. If you specify an report end date that is beyond the lastUpdatedDate value, eBay returns a report that contains data only up to the LastUpdateDate. For this reason, the provided ReportStartDate and ReportEndDate values used to request the report might not match with the report's actual date range: ReportStartDate - ReportEndDate. |
Pseudo-Columns
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 |
---|---|---|
MarketplaceId | String | The eBay marketplace ID of the marketplace upon which the seller report is limited. |
Stored Procedures
Stored procedures are function-like interfaces that extend the functionality of the connector beyond simple SELECT operations with eBay Analytics.
Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from eBay Analytics, along with an indication of whether the procedure succeeded or failed.
eBay Analytics Connector Stored Procedures
Name | Description |
---|---|
GetOAuthAccessToken | Gets the OAuth access token from eBay. |
GetOAuthAuthorizationURL | Gets the eBay authorization URL. Access the URL returned in the output in an Internet browser. This requests the access token that can be used as part of the connection string to eBay Analytics. |
RefreshOAuthAccessToken | Refreshes the OAuth access token used for authentication with EBay. |
GetOAuthAccessToken
Gets the OAuth access token from eBay.
Input
Name | Type | Required | Description |
---|---|---|---|
Verifier | String | False | The verifier token returned by EBay after using the URL obtained with GetOAuthAuthorizationURL. |
CallbackUrl | String | False | The URL the user will be redirected to after authorizing your application. |
RuName | String | False | The Redirect URL name of the OAuth App in the 'Application access' section. |
Scope | String | False | The scope or permissions you are requesting. The default value is https://api.ebay.com/oauth/api_scope https://api.ebay.com/oauth/api_scope/sell.analytics.readonly. |
AuthMode | String | False | The type of authentication mode to use. Select App for getting authentication tokens via a desktop app. Select Web for getting authentication tokens via a Web app. The allowed values are APP, WEB. The default value is APP. |
State | String | False | An opaque value used by the client to maintain state between the request and callback. |
GrantType | String | False | The grant type for the OAuth flow. The allowed values are CODE, CLIENT. |
Result Set Columns
Name | Type | Description |
---|---|---|
OAuthAccessToken | String | The OAuth token. |
OAuthRefreshToken | String | The OAuth refresh token. |
ExpiresIn | String | The remaining lifetime for the access token in seconds. |
GetOAuthAuthorizationURL
Gets the eBay authorization URL. Access the URL returned in the output in an Internet browser. This requests the access token that can be used as part of the connection string to eBay Analytics.
Input
Name | Type | Required | Description |
---|---|---|---|
CallbackUrl | String | False | The URL that eBay will return to after the user has authorized your app. |
RuName | String | False | The Redirect URL name of the OAuth App in the 'Application access' section. |
State | String | False | An opaque value used by the client to maintain state between the request and callback. |
Scope | String | False | The scope or permissions you are requesting. The default value is https://api.ebay.com/oauth/api_scope https://api.ebay.com/oauth/api_scope/sell.analytics.readonly. |
Result Set Columns
Name | Type | Description |
---|---|---|
URL | String | The URL to be entered into a Web browser to obtain the verifier token, which you will need to submit back with the GetOAuthAccessToken stored procedure. |
RefreshOAuthAccessToken
Refreshes the OAuth access token used for authentication with EBay.
Input
Name | Type | Required | Description |
---|---|---|---|
OAuthRefreshToken | String | False | The refresh token used to get a new OAuth Access Token. |
Result Set Columns
Name | Type | Description |
---|---|---|
OAuthAccessToken | String | The authentication token returned from EBay. |
ExpiresIn | String | The remaining lifetime on the access token. |
System Tables
You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.
Schema Tables
The following tables return database metadata for eBay Analytics:
- sys_catalogs: Lists the available databases.
- sys_schemas: Lists the available schemas.
- sys_tables: Lists the available tables and views.
- sys_tablecolumns: Describes the columns of the available tables and views.
- sys_procedures: Describes the available stored procedures.
- sys_procedureparameters: Describes stored procedure parameters.
- sys_keycolumns: Describes the primary and foreign keys.
- sys_indexes: Describes the available indexes.
Data Source Tables
The following tables return information about how to connect to and query the data source:
- sys_connection_props: Returns information on the available connection properties.
- sys_sqlinfo: Describes the SELECT queries that the connector can offload to the data source.
Query Information Tables
The following table returns query statistics for data modification queries:
- sys_identity: Returns information about batch operations or single updates.
sys_catalogs
Lists the available databases.
The following query retrieves all databases determined by the connection string:
SELECT * FROM sys_catalogs
Columns
Name | Type | Description |
---|---|---|
CatalogName | String | The database name. |
sys_schemas
Lists the available schemas.
The following query retrieves all available schemas:
SELECT * FROM sys_schemas
Columns
Name | Type | Description |
---|---|---|
CatalogName | String | The database name. |
SchemaName | String | The schema name. |
sys_tables
Lists the available tables.
The following query retrieves the available tables and views:
SELECT * FROM sys_tables
Columns
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. |
sys_tablecolumns
Describes the columns of the available tables and views.
The following query returns the columns and data types for the TrafficReportByListing table:
SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='TrafficReportByListing'
Columns
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. |
sys_procedures
Lists the available stored procedures.
The following query retrieves the available stored procedures:
SELECT * FROM sys_procedures
Columns
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. |
sys_procedureparameters
Describes stored procedure parameters.
The following query returns information about all of the input parameters for the GetOAuthAccessToken stored procedure:
SELECT * FROM sys_procedureparameters WHERE ProcedureName='GetOAuthAccessToken' AND Direction=1 OR Direction=2
Columns
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. |
sys_keycolumns
Describes the primary and foreign keys.
The following query retrieves the primary key for the TrafficReportByListing table:
SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='TrafficReportByListing'
Columns
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. |
sys_foreignkeys
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'
Columns
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. |
sys_primarykeys
Describes the primary keys.
The following query retrieves the primary keys from all tables and views:
SELECT * FROM sys_primarykeys
Columns
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. |
sys_indexes
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'
Columns
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. |
sys_connection_props
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:ebayanalytics: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 <> ''
Columns
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. |
sys_sqlinfo
Describes the SELECT query processing that the connector can offload to the data source.
Discovering the Data Source's SELECT Capabilities
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 |
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 Data Sync version needed to access this driver. | Standard , Starter , Professional , Enterprise |
DATASYNCCATEGORY | The 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.
Columns
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. |
sys_identity
Returns information about attempted modifications.
The following query retrieves the Ids of the modified rows in a batch operation:
SELECT * FROM sys_identity
Columns
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. |
sys_information
Describes the available system information.
The following query retrieves all columns:
SELECT * FROM sys_information
Columns
Name | Type | Description |
---|---|---|
Product | String | The name of the product. |
Version | String | The version number of the product. |
Datasource | String | The name of the datasource the product connects to. |
NodeId | String | The unique identifier of the machine where the product is installed. |
HelpURL | String | The URL to the product's help documentation. |
License | String | The license information for the product. (If this information is not available, the field may be left blank or marked as 'N/A'.) |
Location | String | The file path location where the product's library is stored. |
Environment | String | The version of the environment or rumtine the product is currently running under. |
DataSyncVersion | String | The tier of Sync required to use this connector. |
DataSyncCategory | String | The category of Sync functionality (e.g., Source, Destination). |
Advanced Configurations Properties
The advanced configurations 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. Click the links for further details.
Property | Description |
---|---|
AuthScheme | The scheme used for authentication. Accepted entries are OAuth and OAuthClient. |
Property | Description |
---|---|
RuName | The Redirect URL name used for validation. |
UseSandbox | A boolean indicating if you are using a sandbox account. |
MarketplaceId | The identification number for the eBay Marketplace. |
Property | Description |
---|---|
InitiateOAuth | Set this property to initiate the process to obtain or refresh the OAuth access token when you connect. |
OAuthClientId | The client ID assigned when you register your application with an OAuth authorization server. |
OAuthClientSecret | The client secret assigned when you register your application with an OAuth authorization server. |
OAuthAccessToken | The access token for connecting using OAuth. |
OAuthSettingsLocation | The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH . Alternatively, you can hold this location in memory by specifying a value starting with 'memory://' . |
CallbackURL | The OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings. |
OAuthGrantType | The grant type for the OAuth flow. |
OAuthVerifier | The verifier code returned from the OAuth authorization URL. |
OAuthRefreshToken | The OAuth refresh token for the corresponding OAuth access token. |
OAuthExpiresIn | The lifetime in seconds of the OAuth AccessToken. |
OAuthTokenTimestamp | The Unix epoch timestamp in milliseconds when the current Access Token was created. |
Property | Description |
---|---|
SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
Property | Description |
---|---|
Location | A path to the directory that contains the schema files defining tables, views, and stored procedures. |
BrowsableSchemas | This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA, SchemaB, SchemaC. |
Tables | This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA, TableB, TableC. |
Views | Restricts the views reported to a subset of the available tables. For example, Views=ViewA, ViewB, ViewC. |
Property | Description |
---|---|
MaxRows | Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses. |
Other | These hidden properties are used only in specific use cases. |
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. |
UserDefinedViews | A filepath pointing to the JSON configuration file containing your custom views. |
Authentication
This section provides a complete list of authentication properties you can configure.
Property | Description |
---|---|
AuthScheme | The scheme used for authentication. Accepted entries are OAuth and OAuthClient. |
AuthScheme
The scheme used for authentication. Accepted entries are OAuth and OAuthClient.
Possible Values
OAuth
, OAuthClient
Data Type
string
Default Value
Auto
Remarks
- OAuth: Set to this to perform OAuth authentication with the code grant type.
- OAuthClient: Set to this to perform OAuth with the client credentials grant type.
Connection
This section provides a complete list of connection properties you can configure.
Property | Description |
---|---|
RuName | The Redirect URL name used for validation. |
UseSandbox | A boolean indicating if you are using a sandbox account. |
MarketplaceId | The identification number for the eBay Marketplace. |
RuName
The Redirect URL name used for validation.
Data Type
string
Default Value
""
Remarks
It is not necessary when refreshing the Access Token. This property is only needed when performing the Code grant type OAuth flow to get an Access Token. You can obtain this by clicking "User Tokens" from your developer account, clicking "Get a Token from eBay via Your Application", and then clicking "Add eBay Redirect URL".
UseSandbox
A boolean indicating if you are using a sandbox account.
Data Type
bool
Default Value
false
Remarks
A boolean indicating if you are using a sandbox account.
MarketplaceId
The identification number for the eBay Marketplace.
Possible Values
EBAY_DE
, EBAY_GB
, EBAY_AU
, EBAY_US
Data Type
string
Default Value
DEFAULT
Remarks
By default, it has no value assigned to it, this means that to query the reports: CustomerServiceMetricByCategory, CustomerServiceMetricByShippingRegion, TrafficReportByDay and TrafficReportByListing, you must specify the MarketplaceId/s in the query criteria.
You should note that each report is supported in distinct marketplaces, as outlined in the below.
- CustomerServiceMetricByCategory: Australia (EBAY_AU), Canada (EBAY_CA), France (EBAY_FR), Germany (EBAY_DE), Great Britain (EBAY_GB), Italy (EBAY_IT), Spain (EBAY_ES), United States (EBAY_US).
- CustomerServiceMetricByShippingRegion: Australia (EBAY_AU), Canada (EBAY_CA), France (EBAY_FR), Germany (EBAY_DE), Great Britain (EBAY_GB), Italy (EBAY_IT), Spain (EBAY_ES), United States (EBAY_US).
- TrafficReportByDay: Australia (EBAY_AU), Germany (EBAY_DE), Great Britain (EBAY_GB), United States (EBAY_US).
- TrafficReportByListing: Australia (EBAY_AU), Germany (EBAY_DE), Great Britain (EBAY_GB), United States (EBAY_US).
OAuth
This section provides a complete list of OAuth properties you can configure.
Property | Description |
---|---|
InitiateOAuth | Set this property to initiate the process to obtain or refresh the OAuth access token when you connect. |
OAuthClientId | The client ID assigned when you register your application with an OAuth authorization server. |
OAuthClientSecret | The client secret assigned when you register your application with an OAuth authorization server. |
OAuthAccessToken | The access token for connecting using OAuth. |
OAuthSettingsLocation | The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH . Alternatively, you can hold this location in memory by specifying a value starting with 'memory://' . |
CallbackURL | The OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings. |
OAuthGrantType | The grant type for the OAuth flow. |
OAuthVerifier | The verifier code returned from the OAuth authorization URL. |
OAuthRefreshToken | The OAuth refresh token for the corresponding OAuth access token. |
OAuthExpiresIn | The lifetime in seconds of the OAuth AccessToken. |
OAuthTokenTimestamp | The Unix epoch timestamp in milliseconds when the current Access Token was created. |
InitiateOAuth
Set this property to initiate the process to obtain or refresh the OAuth access token when you connect.
Possible Values
OFF
, GETANDREFRESH
, REFRESH
Data Type
string
Default Value
OFF
Remarks
The following options are available:
OFF
: Indicates that the OAuth flow will be handled entirely by the user. An OAuthAccessToken will be required to authenticate.GETANDREFRESH
: Indicates that the entire OAuth Flow will be handled by the connector. If no token currently exists, it will be obtained by prompting the user via the browser. If a token exists, it will be refreshed when applicable.REFRESH
: Indicates that the connector will only handle refreshing the OAuthAccessToken. The user will never be prompted by the connector to authenticate via the browser. The user must handle obtaining the OAuthAccessToken and OAuthRefreshToken initially.
OAuthClientId
The client ID assigned when you register your application with an OAuth authorization server.
Data Type
string
Default Value
""
Remarks
As part of registering an OAuth application, you will receive the OAuthClientId
value, sometimes also called a consumer key, and a client secret, the OAuthClientSecret.
OAuthClientSecret
The client secret assigned when you register your application with an OAuth authorization server.
Data Type
string
Default Value
""
Remarks
As part of registering an OAuth application, you will receive the OAuthClientId, also called a consumer key. You will also receive a client secret, also called a consumer secret. Set the client secret in the OAuthClientSecret
property.
OAuthAccessToken
The access token for connecting using OAuth.
Data Type
string
Default Value
""
Remarks
The OAuthAccessToken
property is used to connect using OAuth. The OAuthAccessToken
is retrieved from the OAuth server as part of the authentication process. It has a server-dependent timeout and can be reused between requests.
The access token is used in place of your user name and password. The access token protects your credentials by keeping them on the server.
OAuthSettingsLocation
The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH . Alternatively, you can hold this location in memory by specifying a value starting with 'memory://'
.
Data Type
string
Default Value
%APPDATA%\EbayAnalytics Data Provider\OAuthSettings.txt
Remarks
When InitiateOAuth is set to GETANDREFRESH
or REFRESH
, the connector saves OAuth values to avoid requiring the user to manually enter OAuth connection properties and to allow the credentials to be shared across connections or processes.
Instead of specifying a file path, you can use memory storage. Memory locations are specified by using a value starting with 'memory://'
followed by a unique identifier for that set of credentials (for example, memory://user1). The identifier can be anything you choose but should be unique to the user. Unlike file-based storage, where credentials persist across connections, memory storage loads the credentials into static memory, and the credentials are shared between connections using the same identifier for the life of the process. To persist credentials outside the current process, you must manually store the credentials prior to closing the connection. This enables you to set them in the connection when the process is started again. You can retrieve OAuth property values with a query to the sys_connection_props
system table. If there are multiple connections using the same credentials, the properties are read from the previously closed connection.
The default location is "%APPDATA%\EbayAnalytics Data Provider\OAuthSettings.txt" with %APPDATA%
set to the user's configuration directory. The default values are
- Windows: "
register://%DSN
" - Unix: "%AppData%..."
- Mac: "%AppData%..."
where DSN is the name of the current DSN used in the open connection.
The following table lists the value of %APPDATA%
by OS:
Platform | %APPDATA% |
---|---|
Windows | The value of the APPDATA environment variable |
Mac | ~/Library/Application Support |
Linux | ~/.config |
CallbackURL
The OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings.
Data Type
string
Default Value
http://localhost:33333
Remarks
During the authentication process, the OAuth authorization server redirects the user to this URL. This value must match the callback URL you specify in your app settings.
OAuthGrantType
The grant type for the OAuth flow.
Possible Values
CODE
, CLIENT
Data Type
string
Default Value
CLIENT
Remarks
The following options are available: CODE,CLIENT
OAuthVerifier
The verifier code returned from the OAuth authorization URL.
Data Type
string
Default Value
""
Remarks
The verifier code returned from the OAuth authorization URL. This can be used on systems where a browser cannot be launched such as headless systems.
Authentication on Headless Machines
See to obtain the OAuthVerifier
value.
Set OAuthSettingsLocation along with OAuthVerifier
. When you connect, the connector exchanges the OAuthVerifier
for the OAuth authentication tokens and saves them, encrypted, to the specified location. Set InitiateOAuth to GETANDREFRESH to automate the exchange.
Once the OAuth settings file has been generated, you can remove OAuthVerifier
from the connection properties and connect with OAuthSettingsLocation set.
To automatically refresh the OAuth token values, set OAuthSettingsLocation and additionally set InitiateOAuth to REFRESH.
OAuthRefreshToken
The OAuth refresh token for the corresponding OAuth access token.
Data Type
string
Default Value
""
Remarks
The OAuthRefreshToken
property is used to refresh the OAuthAccessToken when using OAuth authentication.
OAuthExpiresIn
The lifetime in seconds of the OAuth AccessToken.
Data Type
string
Default Value
""
Remarks
Pair with OAuthTokenTimestamp to determine when the AccessToken will expire.
OAuthTokenTimestamp
The Unix epoch timestamp in milliseconds when the current Access Token was created.
Data Type
string
Default Value
""
Remarks
Pair with OAuthExpiresIn to determine when the AccessToken will expire.
SSL
This section provides a complete list of SSL properties you can configure.
Property | Description |
---|---|
SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
SSLServerCert
The certificate to be accepted from the server when connecting using TLS/SSL.
Data Type
string
Default Value
""
Remarks
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.
Certificates are validated as trusted by the machine based on the System's trust store. The trust store used is the 'javax.net.ssl.trustStore' value specified for the system. If no value is specified for this property, Java's default trust store is used (for example, JAVA_HOME\lib\security\cacerts).
Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.
Schema
This section provides a complete list of schema properties you can configure.
Property | Description |
---|---|
Location | A path to the directory that contains the schema files defining tables, views, and stored procedures. |
BrowsableSchemas | This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA, SchemaB, SchemaC. |
Tables | This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA, TableB, TableC. |
Views | Restricts the views reported to a subset of the available tables. For example, Views=ViewA, ViewB, ViewC. |
Location
A path to the directory that contains the schema files defining tables, views, and stored procedures.
Data Type
string
Default Value
%APPDATA%\EbayAnalytics Data Provider\Schema
Remarks
The path to a directory which contains the schema files for the connector (.rsd files for tables and views, .rsb files for stored procedures). The folder location can be a relative path from the location of the executable. The Location
property is only needed if you want to customize definitions (for example, change a column name, ignore a column, and so on) or extend the data model with new tables, views, or stored procedures.
If left unspecified, the default location is "%APPDATA%\EbayAnalytics Data Provider\Schema" with %APPDATA%
being set to the user's configuration directory:
Platform | %APPDATA% |
---|---|
Windows | The value of the APPDATA environment variable |
Mac | ~/Library/Application Support |
Linux | ~/.config |
BrowsableSchemas
This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
Data Type
string
Default Value
""
Remarks
Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.
Tables
This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
Data Type
string
Default Value
""
Remarks
Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the connector.
This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.
Specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.
Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.
Views
Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.
Data Type
string
Default Value
""
Remarks
Listing the views from some databases can be expensive. Providing a list of views in the connection string improves the performance of the connector.
This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.
Specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.
Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.
Miscellaneous
This section provides a complete list of miscellaneous properties you can configure.
Property | Description |
---|---|
MaxRows | Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses. |
Other | These hidden properties are used only in specific use cases. |
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. |
UserDefinedViews | A filepath pointing to the JSON configuration file containing your custom views. |
MaxRows
Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
Data Type
int
Default Value
-1
Remarks
Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
Other
These hidden properties are used only in specific use cases.
Data Type
string
Default Value
""
Remarks
The properties listed below are available for specific use cases. Normal driver use cases and functionality should not require these properties.
Specify multiple properties in a semicolon-separated list.
Integration and Formatting
Property | Description |
---|---|
DefaultColumnSize | Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000. |
ConvertDateTimeToGMT | Determines whether to convert date-time values to GMT, instead of the local time of the machine. |
RecordToFile=filename | Records the underlying socket data transfer to the specified file. |
PseudoColumns
This property indicates whether or not to include pseudo columns as columns to the table.
Data Type
string
Default Value
""
Remarks
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, "*=*".
Timeout
The value in seconds until the timeout error is thrown, canceling the operation.
Data Type
int
Default Value
60
Remarks
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 connector throws an exception.
UserDefinedViews
A filepath pointing to the JSON configuration file containing your custom views.
Data Type
string
Default Value
""
Remarks
User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json
. The connector automatically detects the views specified in this file.
You can also have multiple view definitions and control them using the UserDefinedViews
connection property. When you use this property, only the specified views are seen by the connector.
This User Defined View configuration file is formatted as follows:
- Each root element defines the name of a view.
- Each root element contains a child element, called
query
, which contains the custom SQL query for the view.
For example:
{
"MyView": {
"query": "SELECT * FROM TrafficReportByListing WHERE MyColumn = 'value'"
},
"MyView2": {
"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
}
}
Use the UserDefinedViews
connection property to specify the location of your JSON configuration file. For example:
"UserDefinedViews", C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json
Note that the specified path is not embedded in quotation marks.