Ready to get started?

Learn more about CData Cloud Hub or sign up for a free trial:

Learn More

Connect to Microsoft CDS Data as a Federated Tables in MySQL

Use the CData Cloud Hub to set up federated tables for Microsoft CDS data in MySQL .

You can use the CData Cloud Hub to set up federated tables in MySQL for Microsoft CDS data. The Cloud Hub provides a MySQL interface for Microsoft CDS: After configuring a virtual MySQL database for Microsoft CDS, you can create a server and tables using the FEDERATED Storage Engine in MySQL. You can then work with Microsoft CDS data just as you would local MySQL tables.

The CData Cloud Hub provides a pure MySQL, cloud-to-cloud interface for Microsoft CDS, allowing you to easily query live Microsoft CDS data alongside existing MySQL data — all without replicating the data. Using optimized data processing out of the box, the CData Cloud Hub pushes all supported SQL operations (filters, JOINs, etc) directly to Microsoft CDS, leveraging server-side processing to quickly return Microsoft CDS data.

Create a Virtual MySQL Database for Microsoft CDS Data

CData Cloud Hub uses a straightforward, point-and-click interface to connect to data sources and generate APIs.

  1. Login to Cloud Hub and click Databases.
  2. Select "Microsoft CDS" from Available Data Sources.
  3. Enter the necessary authentication properties to connect to Microsoft CDS.

    You can connect without setting any connection properties for your user credentials. Below are the minimum connection properties required to connect.

    • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
    • OrganizationUrl: Set this to the organization URL you are connecting to, such as https://myorganization.crm.dynamics.com.
    • Tenant (optional): Set this if you wish to authenticate to a different tenant than your default. This is required to work with an organization not on your default Tenant.

    When you connect the Common Data Service OAuth endpoint opens in your default browser. Log in and grant permissions. The OAuth process completes automatically.

  4. Click Test Database.
  5. Click Privileges -> Add and add the new user (or an existing user) with the appropriate permissions.

With the virtual database created, you are ready to connect to Microsoft CDS data from any MySQL client.

Create a FEDERATED Server and Tables for Microsoft CDS 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 Cloud Hub. Note that the username and password of the FEDERATED server must match a user account you defined on the Cloud Hub.

CREATE SERVER fedCDS
FOREIGN DATA WRAPPER mysql
OPTIONS (USER 'cloud_hub_user', PASSWORD 'cloud_hub_passwd', HOST 'myinstance.cdatacloud.net', PORT 3306, DATABASE 'microsoftcdsdb');

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 (Accounts). Refer to the following template for the statement to create a FEDERATED table:

CREATE TABLE fed_accounts (
  ...,
  accountid  TYPE(LEN),
  name  TYPE(LEN),
  ...,
)
ENGINE=FEDERATED
DEFAULT CHARSET=utf8
CONNECTION='fedCDS/Accounts';

NOTE: The table schema for the FEDERATED table must match the remote table schema exactly. You can always connect directly to the Cloud Hub using any MySQL client and run SHOW COLUMNS FROM Accounts to get the table schema.

Execute Queries

You can now execute queries to the Microsoft CDS 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 Microsoft CDS. Refer to the following example:

SELECT 
  fed_accounts.accountid, 
  local_table.custom_field 
FROM 
  local_table 
JOIN 
  fed_accounts 
ON 
  local_table.foreign_accountid = fed_accounts.accountid;