Ready to get started?

Learn more about the CData ODBC Driver for Xero or download a free trial:

Download Now

Connect to Xero Data as a Federated Tables in MySQL

Use the SQL Gateway and the ODBC Driver to set up federated tables for Xero data in MySQL .

You can use the SQL Gateway to configure a MySQL remoting service and set up federated tables for Xero data. The service is a daemon process that provides a MySQL interface to the CData ODBC Driver for Xero: After you have started the service, you can create a server and tables using the FEDERATED Storage Engine in MySQL. You can then work with Xero data just as you would local MySQL tables.

Connect to Xero Data

If you have not already done so, provide values for the required connection properties in the data source name (DSN). You can use the built-in Microsoft ODBC Data Source Administrator to configure the DSN. This is also the last step of the driver installation. See the "Getting Started" chapter in the help documentation for a guide to using the Microsoft ODBC Data Source Administrator to create and configure a DSN.

To connect, set the Schema connection property in addition to any authentication values. Xero offers authentication for private applications, public applications, and partner applications. You will need to set the XeroAppAuthentication property to PUBLIC, PRIVATE, or PARTNER, depending on the type of application configured. To connect from a private application, you will additionally need to set the OAuthAccessToken, OAuthClientId, OAuthClientSecret, CertificateStoreType, CertificateStore, and CertificateStorePassword.

To connect from a public or partner application, you can use the embedded OAuthClientId, OAuthClientSecret, and CallbackURL, or you can register an app to obtain your own OAuth values.

See the "Getting Started" chapter of the help documentation for a guide to authenticating to Xero.

Configure the SQL Gateway

See the SQL Gateway Overview to set up connectivity to Xero data as a virtual MySQL database. You will configure a MySQL remoting service that listens for MySQL requests from clients. The service can be configured in the SQL Gateway UI.

Create a FEDERATED Server and Tables for Xero Data

After you have configured and started the service, create a FEDERATED server to simplify the process of creating FEDERATED tables:

Create a FEDERATED Server

The following statement will create a FEDERATED server based on the ODBC Driver for Xero. Note that the username and password of the FEDERATED server must match a user account you defined on the Users tab of the SQL Gateway.

CREATE SERVER fedXero
FOREIGN DATA WRAPPER mysql
OPTIONS (USER 'sql_gateway_user', PASSWORD 'sql_gateway_passwd', HOST 'sql_gateway_host', PORT ####, DATABASE 'CData Xero Sys');

Create a FEDERATED Table

To create a FEDERATED table using our newly created server, use the CONNECTION keyword and pass the name of the FEDERATED server and the remote table (Items). Refer to the following template for the statement to create a FEDERATED table:

CREATE TABLE fed_items (
  ...,
  name  TYPE(LEN),
  quantityonhand  TYPE(LEN),
  ...,
)
ENGINE=FEDERATED
DEFAULT CHARSET=latin1
CONNECTION='fedXero/items';

NOTE: The table schema for the FEDERATED table must match the remote table schema exactly. You can always connect directly to the MySQL remoting service using any MySQL client and run a SHOW CREATE TABLE query to get the table schema.

Execute Queries

You can now execute queries to the Xero FEDERATED tables from any tool that can connect to MySQL, which is particularly useful if you need to JOIN data from a local table with data from Xero. Refer to the following example:

SELECT 
  fed_items.name, 
  local_table.custom_field 
FROM 
  local_table 
JOIN 
  fed_items 
ON 
  local_table.foreign_name = fed_items.name;