Ready to get started?

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

Download Now

Connect to UPS Data as a Federated Tables in MySQL

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

You can use the SQL Gateway to configure a MySQL remoting service and set up federated tables for UPS data. The service is a daemon process that provides a MySQL interface to the CData ODBC Driver for UPS: 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 UPS data just as you would local MySQL tables.

Connect to UPS 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.

The driver uses five pieces of information in order to authenticate its actions with the UPS service.

  • Server: This controls the URL where the requests should be sent. Common testing options for this are: https://wwwcie.ups.com/ups.app/xml and https://wwwcie.ups.com/webservices
  • AccessKey: This is an identifier that is required to connect to a UPS Server. This value will be provided to you by UPS after registration.
  • UserId: This value is used for logging into UPS. This value is the one you chose to login with when registering for service with UPS.
  • Password: This value is used for logging into UPS. This value is the one you chose to login with when registering for service with UPS.
  • AccountNumber: This is a valid 6-digit or 10-digit UPS account number.
  • PrintLabelLocation: This property is required if one intends to use the GenerateLabels or GenerateReturnLabels stored procedures. This should be set to the folder location where generated labels should be stored.

Configure the SQL Gateway

See the SQL Gateway Overview to set up connectivity to UPS 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 UPS 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 UPS. 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 fedUPS
FOREIGN DATA WRAPPER mysql
OPTIONS (USER 'sql_gateway_user', PASSWORD 'sql_gateway_passwd', HOST 'sql_gateway_host', PORT ####, DATABASE 'CData UPS 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 (Senders). Refer to the following template for the statement to create a FEDERATED table:

CREATE TABLE fed_senders (
  ...,
  firstname  TYPE(LEN),
  phone  TYPE(LEN),
  ...,
)
ENGINE=FEDERATED
DEFAULT CHARSET=latin1
CONNECTION='fedUPS/senders';

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 UPS 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 UPS. Refer to the following example:

SELECT 
  fed_senders.firstname, 
  local_table.custom_field 
FROM 
  local_table 
JOIN 
  fed_senders 
ON 
  local_table.foreign_firstname = fed_senders.firstname;