Matillion ETL Data Model for Xero
When AutoCache is set, the driver automatically maintains a cache of your table's data in the database of your choice. By default, the driver incrementally updates the cache, retrieving only changes since the last SELECT query was run if the length of time since the last run has exceeded the CacheTolerance. After the cache is updated, the query is executed against the cached data. With CacheQueryResult additionally set, the driver updates the cache when you execute a SELECT query and returns the live results from the Xero data.
CacheQueryResult is a way to query Xero in real time while maintaining a cache for offline use. Set CacheQueryResult to update the cache whenever you execute a SELECT statement. When you execute a SELECT statement with AutoCache and CacheQueryResult set, the driver executes the query to the remote data and caches the results; rows that already exist are overwritten. That is, SELECT statements are used to create and refresh the cache, not to query it. Data manipulation commands are executed to the remote data as well.
To query the cached data, set the Offline property. If you need to query the cached data in an online connection, you can append #CACHE to the table name. For example:
SELECT * FROM [Items#CACHE]
When AutoCache is set, the driver caches to a simple, file-based cache. You can configure its location or cache to a different database with the following properties:
Possible values include True and False. When set to true, this makes some columns contain data that are otherwise NULL, but it will make reads from those tables slower than they are by default.
When set to false (the default), the only way to get extra details from those tables is to explicitly select single items:
SELECT * FROM ExpenseClaims WHERE ExpenseClaimId = '...'
When BatchSize is set to a value greater than 0, the batch operation will split the entire batch into separate batches of size BatchSize. The split batches will then be submitted to the server individually. This is useful when the server has limitations on the size of the request that can be submitted.
Setting BatchSize to 0 will submit the entire batch as specified.
The cache database is determined based on the CacheDriver and CacheConnection properties. Both properies are required to use the cache database. Examples of common cache database settings can be found below. For more information on setting the caching database's driver, refer to CacheDriver.
The connection string specified in the CacheConnection property is passed directly to the underlying CacheDriver. Consult the documentation for the specific JDBC driver for more information on the available properties. Make sure to include the JDBC driver in your application's classpath.
The driver simplifies caching to Derby, only requiring you to set the CacheLocation property to make a basic connection.
Alternatively, you can configure the connection to Derby manually using CacheProvider and CacheConnection.
Below is the Derby JDBC URL syntax:
jdbc:derby:[subsubprotocol:][databaseName][;attribute=value[;attribute=value] ... ]For example, to cache to an in-memory database, use the following:
To cache to SQLite, you can use the SQLite JDBC driver. Below is the syntax of the JDBC URL:
The installation includes the CData JDBC Driver for MySQL. Below is an example JDBC URL:
jdbc:mysql:User=root;Password=root;Server=localhost;Port=3306;Database=cacheBelow are typical connection properties:
The JDBC URL for the Microsoft JDBC Driver for SQL Server has the following syntax:
jdbc:sqlserver://[serverName[\instance][:port]][;database=databaseName][;property=value[;property=value] ... ]For example:
jdbc:sqlserver://localhost\sqlexpress:1433;integratedSecurity=trueBelow are typical SQL Server connection properties:
To use integrated security, you will also need to add sqljdbc_auth.dll to a folder on the Windows system path. This file is located in the auth subfolder of the Microsoft JDBC Driver for SQL Server installation. The bitness of the assembly must match the bitness of your JVM.
Below is the conventional JDBC URL syntax for the Oracle JDBC Thin driver:
jdbc:oracle:thin:scott/tiger@myhost:1521:orclBelow are typical connection properties:
Data Source: The connect descriptor that identifies the Oracle database. This can be a TNS connect descriptor, an Oracle Net Services name that resolves to a connect descriptor, or, after version 11g, an Easy Connect naming (the host name of the Oracle server with an optional port and service name).
Below is the JDBC URL syntax for the official PostgreSQL JDBC driver:
jdbc:postgresql:[//[host[:port]]/]database[[?option=value][[&option=value][&option=value] ... ]]For example, the following connection string connects to a database on the default host (localhost) and port (5432):
jdbc:postgresql:postgresBelow are typical connection properties:
You can cache to any database for which you have a JDBC driver, including CData JDBC drivers.
The cache database is determined based on the CacheDriver and CacheConnection properties. The CacheDriver is the name of the JDBC driver class that you would like to use to cache data.
Note that you must also add the CacheDriver JAR to the classpath.
The following examples show how to cache to several major databases. Refer to CacheConnection for more information on the JDBC URL syntax and typical connection properties.
The driver simplifies Derby configuration. Java DB is the Oracle distribution of Derby. The JAR is shipped in the JDK. You can find the JAR, derby.jar, in the db subfolder of the JDK installation. In most caching scenarios, you need to specify only the following, after adding derby.jar to the classpath.
jdbc:xero:CacheLocation='c:/Temp/cachedir';InitiateOAuth=GETANDREFRESH;To customize the Derby JDBC URL, use CacheDriver and CacheConnection. For example, to cache to an in-memory database, use a JDBC URL like the following:
Below is a JDBC URL for the SQLite JDBC driver:
Below is a JDBC URL for the included CData JDBC Driver for MySQL:
jdbc:xero:Cache Driver=cdata.jdbc.mysql.MySQLDriver;Cache Connection='jdbc:mysql:Server=localhost;Port=3306;Database=cache;User=root;Password=123456';InitiateOAuth=GETANDREFRESH;The CData JDBC Driver for MySQL is located in the lib subfolder of the CData JDBC Driver for Xero 2018 installation directory.
The following JDBC URL uses the Microsoft JDBC Driver for SQL Server:
jdbc:xero:Cache Driver=com.microsoft.sqlserver.jdbc.SQLServerDriver;Cache Connection='jdbc:sqlserver://localhost\sqlexpress:7437;user=sa;password=123456;databaseName=Cache';InitiateOAuth=GETANDREFRESH;
Below is a JDBC URL for the Oracle Thin Client:
The following JDBC URL uses the official PostgreSQL JDBC driver:
The CacheLocation is a simple, file-based cache. The driver uses Java DB, Oracle's distribution of the Derby database. To cache to Java DB, you will need to add the Java DB JAR to the classpath. The JAR, derby.jar, is shipped in the JDK and located in the db subfolder of the JDK installation.
CacheLocation defaults to the directory specified by the Location setting.
As you execute queries with this property set, table metadata in the Xero catalog are cached to the file store specified by CacheLocation if set or the user's home directory otherwise. A table's metadata will be retrieved only once, when the table is queried for the first time.
The driver automatically persists metadata in memory for up to two hours when you first discover the metadata for a table or view and therefore, CacheMetadata is generally not required. CacheMetadata becomes useful when metadata operations are expensive such as when you are working with large amounts of metadata or when you have many short-lived connections.
When CacheQueryResult and AutoCache are set, the rows returned from a SELECT query are cached in the cache database. The driver handles caching in a streaming fashion with each row being processed into the cache database from the original result set as you read the row from the returned ResultSet object. This ensures that the live data is not queried twice. Note that any rows you do not read from the returned ResultSet will not be updated in the cache.
The tolerance for stale data in the cache specified in seconds. This only applies when AutoCache is used. The driver will check with the data source for newer records after the tolerance interval has expired. Otherwise it will return the data directly from the cache.
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.
Leave this blank if you are using the driver's embedded credentials to connect as a public application.
You need to set this value in the following authentication flows:
|Callback Domain||Callback URL|
See Using OAuth Authentication for an authentication guide.
The name of the certificate store for the client certificate used in Xero private application authentication. Xero private application authentication uses SSL client authentication with digital certificates. You provide Xero with the public certificate and specify the private certificate when you connect.
See Using OAuth Authentication for an authentication guide.
The values of this connection property designate a platform-dependent certificate store or a file store.
The following are designations of the most common User and Machine certificate stores in Windows:
|MY||Contains personal certificates with their associated private keys.|
|CA||Contains certifying authority certificates.|
|ROOT||Contains root certificates.|
|SPC||Contains software publisher certificates.|
In Java, the certificate store normally is a file containing certificates and optional private keys.
When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., a PKCS12 certificate store).
If the provider is OpenSSL, the certificate store is a file containing a certificate and a private key. This property must be set to the name of the file.
To specify the private certificate, you need to set CertificateStore and the following additional properties:
If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.
The name of the certificate store for the client certificate used in Xero private application authentication. Xero private application authentication uses SSL client authentication with digital certificates.
The CertificateStoreType property can take one of the following values:
|User - default||For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: This store type is not available in Java.|
|Machine||For Windows, this specifies that the certificate store is a machine store. Note: this store type is not available in Java.|
|PFXFile||The certificate store is the name of a PFX (PKCS12) file containing certificates.|
|PFXBlob||The certificate store is a string (base-64-encoded) representing a certificate store in PFX (PKCS12) format.|
|JKSFile||The certificate store is the name of a Java key store (JKS) file containing certificates. Note: this store type is only available in Java.|
|JKSBlob||The certificate store is a string (base-64-encoded) representing a certificate store in Java key store (JKS) format. Note: this store type is only available in Java.|
|PEMKeyFile||The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.|
|PublicKeyFile||The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.|
|PublicKeyBlob||The certificate store is a string (base-64-encoded) that contains a PEM- or DER-encoded public key certificate.|
|SSHPublicKeyBlob||The certificate store is a string (base-64-encoded) that contains an SSH-style public key.|
|P7BFile||The certificate store is the name of a PKCS7 file containing certificates.|
|SSHPublicKeyFile||The certificate store is the name of a file that contains an SSH-style public key.|
|PPKFile||The certificate store is the name of a file that contains a PPK (PuTTY Private Key).|
|XMLFile||The certificate store is the name of a file that contains a certificate in XML format.|
|XMLBlob||The certificate store is a string that contains a certificate in XML format.|
To specify the private certificate, you may need to set the following properties in addition to CertificateStoreType:
The subject of the client certificate used in Xero private application authentication.
Xero private application authentication uses SSL client authentication with digital certificates.
When loading a certificate the subject is used to locate the certificate in the store.
The certificate subject is a comma-separated list of distinguished name fields and values. For instance "CN=www.server.com, OU=test, C=US, Eemail@example.com". Common fields and their meanings are displayed below.
|CN||Common Name. This is commonly a host name like www.server.com.|
Note: If a field value contains a comma it must be quoted.
To specify the private certificate, you need to set CertificateSubject and the following additional properties:
The maximum lifetime of a connection in seconds. Once the time has elapsed, the connection object is disposed. The default is 0 which indicates there is no limit to the connection lifetime.
When set to 'true', a connection will be made to Xero when the connection is opened. This property enables the 'Test Connection' feature available in various database tools.
This feature acts as a NOOP command as it is used to verify a connection can be made to Xero and nothing from this initial connection is maintained.
Setting this property to 'false' may provide performance improvements (depending upon the number of times a connection is opened).
This property specifies the IP address, DNS name, or host name of a proxy allowing traversal of a firewall. The protocol is specified by FirewallType: Use FirewallServer with this property to connect through SOCKS or do tunneling. Use ProxyServer to connect to an HTTP proxy.
Note that the driver uses the system proxy by default. To use a different proxy, set ProxyAutoDetect to false.
This property specifies the protocol that the driver will use to tunnel traffic through the FirewallServer proxy. Note that by default the driver connects to the system proxy; to disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.
|TUNNEL||80||When this is set, the driver opens a connection to Xero and traffic flows back and forth through the proxy.|
|SOCKS4||1080||When this is set, the driver sends data through the SOCKS 4 proxy specified by FirewallServer and FirewallPort and passes the FirewallUser value to the proxy, which determines if the connection request should be granted.|
|SOCKS5||1080||When this is set, the driver sends data through the SOCKS 5 proxy specified by FirewallServer and FirewallPort. If your proxy requires authentication, set FirewallUser and FirewallPassword to credentials the proxy recognizes.|
The FirewallUser and FirewallPassword properties are used to authenticate against the proxy specified in FirewallServer and FirewallPort, following the authentication method specified in FirewallType.
Possible values include True and False.
The following options are available:
The path to a directory which contains the schema files for the driver (.rsd files for tables and views, .rsb files for stored procedures). The Location property is only needed if you would like to customize definitions (e.g., change a column name, ignore a column, etc.) or extend the data model with new tables, views, or stored procedures.
The schema files are deployed alongside the driver assemblies. You must also ensure that Location points to the folder that contains the schema files. The folder location can be a relative path from the location of the executable.
For more control over what is written to the log file, take a look at Verbosity.
A string specifying the maximum size in bytes for a log file (ex: 10MB). When the limit is hit, a new log is created in the same folder with the date and time appended to the end. The default limit is 100MB. Values lower than 100kB will use 100kB as the value instead.
Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.
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 username and password. The access token protects your credentials by keeping them on the server.
The OAuthAccessTokenSecret property is used to connect and authenticate using OAuth. The OAuthAccessTokenSecret is retrieved from the OAuth server as part of the authentication process. It is used with the OAuthAccessToken and can be used for multiple requests until it times out.
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.
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.
The OAuthRefreshToken property is used to refresh the OAuthAccessToken when using OAuth authentication.
"%APPDATA%\\CData\\Xero Data Provider\\OAuthSettings.txt"
When InitiateOAuth is set to GETANDREFRESH or REFRESH, the driver saves OAuth values to avoid requiring the user to manually enter OAuth connection properties and allowing the credentials to be shared across connections or processes. The default OAuthSettingsLocation is a settings file located in the %AppData%\CData folder. Alternatively to specifying a file path, memory storage can be used instead. Memory locations are specified by using a value starting with 'memory://' followed by a unique identifier for that set of credentials (ex: memory://user1). The identifier can be anything you choose but should be unique to the user. Unlike with the file based storage, you must manually store the credentials when closing the connection with memory storage to be able to set them in the connection when the process is started again. The OAuth property values can be retrieved with a query to the sys_connection_props system table. If there are multiple connections using the same credentials, the properties should be read from the last connection to be closed.
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.
See the Getting Started section to obtain the OAuthVerifier value.
Set OAuthSettingsLocation along with OAuthVerifier. When you connect, the driver exchanges the OAuthVerifier for the OAuth authentication tokens and saves them, encrypted, to the specified file. Set InitiateOAuth to GETANDREFRESH automate the exchange.
Once the OAuth settings file has been generated, you can remove OAuthVerifier from the connection properties and connect with OAuthSettingsLocation set.
When Offline is set to TRUE, all queries execute against the cache as opposed to the live data source. In this mode, certain queries like INSERT, UPDATE, DELETE, and CACHE are not allowed.
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.
|CachePartial=True||Caches only a subset of columns, which you can specify in your query.|
|QueryPassthrough=True||Passes the specified query to the cache database instead of using the SQL parser of the driver.|
|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||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.|
The allowed idle time a connection can remain in the pool until the connection is closed. The default is 60 seconds.
The maximum connections in the pool. The default is 100. To disable this property, set the property value to 0 or less.
The minimum number of connections in the pool. The default is 1.
The max seconds to wait for a connection to become available. If a new connection request is waiting for an available connection and exceeds this time, an error is thrown. By default, new requests wait forever for an available connection.
Note that the driver will use the system proxy settings by default, without further configuration needed; if you want to connect to another proxy, you will need to set ProxyAutoDetect to false, in addition to ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.
The authentication type can be one of the following:
By default, the driver uses the system HTTP proxy. Set this to false if you want to connect to another proxy.
To connect to an HTTP proxy, see ProxyServer.
For other proxies, such as SOCKS or tunneling, see FirewallType.
The ProxyServer will be used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.
Note that the driver will use the system proxy settings by default, without further configuration needed; if you want to explicitly configure proxy exceptions for this connection, you will need to set ProxyAutoDetect to false, and configure ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.
This property is used to authenticate to an HTTP proxy server that supports NTLM (Windows), Kerberos, or HTTP authentication. To specify the HTTP proxy, you can set ProxyServer and ProxyPort. To specify the authentication type, set ProxyAuthScheme.
If you are using HTTP authentication, additionally set ProxyUser and ProxyPassword to HTTP proxy.
If you are using NTLM authentication, set ProxyUser and ProxyPassword to your Windows password. You may also need these to complete Kerberos authentication.
For SOCKS 5 authentication or tunneling, see FirewallType.
By default, the driver uses the system proxy. If you want to connect to another proxy, set ProxyAutoDetect to false.
The hostname or IP address of a proxy to route HTTP traffic through. The driver can use the HTTP, Windows (NTLM), or Kerberos authentication types to authenticate to an HTTP proxy.
If you need to connect through a SOCKS proxy or tunnel the connection, see FirewallType.
By default, the driver uses the system proxy. If you need to use another proxy, set ProxyAutoDetect to false.
This property determines when to use SSL for the connection to an HTTP proxy specified by ProxyServer. This value can be AUTO, ALWAYS, NEVER, or TUNNEL. The applicable values are the following:
|AUTO||Default setting. If the URL is an HTTPS URL, the driver will use the TUNNEL option. If the URL is an HTTP URL, the component will use the NEVER option.|
|ALWAYS||The connection is always SSL enabled.|
|NEVER||The connection is not SSL enabled.|
|TUNNEL||The connection is through a tunneling proxy: The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy.|
You can select one of the available authentication types in ProxyAuthScheme. If you are using HTTP authentication, set this to the username of a user recognized by the HTTP proxy. If you are using Windows or Kerberos authentication, set this property to a username in one of the following formats:
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; i.e., "*=*".
If this property is set to true, the driver will allow only SELECT queries. INSERT, UPDATE, DELETE, and stored procedure queries will cause an error to be thrown.
The RTK property may be used to license a build. Please see the included licensing file to see how to set this property. The runtime key is only available if you purchased an OEM license.
The driver supports the Accounting API and both the US and Australia versions of the Payroll API. Set the Schema connection property to Accounting, PayrollUS, or PayrollAUS to connect to one of the corresponding APIs.
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 will be rejected.
This property can take the forms:
|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 will be accepted. Use '*' to signify to accept all certificates (not recommended for security concerns).
When SupportEnhancedSQL is set to true, the driver offloads as much of the SELECT statement processing as possible to Xero and then processes the rest of the query in memory. In this way the driver can execute unsupported predicates, joins, and aggregation.
When SupportEnhancedSQL is set to false, the driver limits SQL execution to what is supported by the Xero API.
The driver determines which of the clauses are supported by the data source and then pushes them to the source to get the smallest superset of rows that would satisfy the query. It then filters the rest of the rows locally. The filter operation is streamed, which enables the driver to filter effectively for even very large datasets.
The driver uses various techniques to join in memory. The driver trades off memory utilization against the requirement of reading the same table more than once.
The driver retrieves all rows necessary to process the aggregation in memory.
If the property is set to true, handle SQL queries using a temporary database.
Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the driver.
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. For example: Tables=TableA,TableB,TableC
If the Timeout property is set to 0, operations do not time out: They run until they complete successfully or encounter an error condition.
If Timeout expires and the operation is not yet complete, the driver throws an exception.
Enables connection pooling. The default is false. See Connection Pooling for information on using connection pools.
The verbosity level determines the amount of detail that the driver reports to the Logfile. Verbosity levels from 1 to 5 are supported. These are described below:
|1||Setting Verbosity to 1 will log the query, the number of rows returned by it, the start of execution and the time taken, and any errors.|
|2||Setting Verbosity to 2 will log everything included in Verbosity 1, cache queries, and additional information about the request, if applicable, such as HTTP headers.|
|3||Setting Verbosity to 3 will additionally log the body of the request and the response.|
|4||Setting Verbosity to 4 will additionally log transport-level communication with the data source. This includes SSL negotiation.|
|5||Setting Verbosity to 5 will additionally log communication with the data source and additional details that may be helpful in troubleshooting problems. This includes interface commands.|
Listing the views from some databases can be expensive. Providing a list of views in the connection string improves the performance of the driver.
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. For example: For example: Views=ViewsA,ViewsB,ViewsC
Xero specifies three types of applications that can connect to Xero APIs: public, private, and partner. You can use the driver to connect as any of these application types.