Driver Setup

To set up the Simba DynamoDB ODBC Driver to connect to your data store, do the following:

  • Install the driver on the machine that you use to access the data. For more information, see Installing the Driver.
  • Configure the driver by creating a Data Source Name (DSN) that specifies the necessary connection properties. For more information, see Configuring the Driver.

Installing the Driver

On 64-bit Windows operating systems, you can execute 32- and 64-bit applications transparently. You must use the version of the driver matching the bitness of the client application accessing data in DynamoDB:

  • SimbaDynamoDBODBC32.msi for 32-bit applications
  • SimbaDynamoDBODBC64.msi for 64-bit applications

You can install both versions of the driver on the same machine.

You install the Simba DynamoDB ODBC Driver on client machines that access data stored in DynamoDB. Each machine that you install the driver on must meet the following minimum system requirements:

  • One of the following operating systems:
    • Windows Vista, 7, 8, or 10
    • Windows Server 2008 or later
  • 250 MB of available disk space

Important:

To install the driver, you must have Administrator privileges on the machine.

To install the Simba DynamoDB ODBC Driver:

  1. Depending on the bitness of your client application, double-click to run SimbaDynamoDBODBC32.msi or SimbaDynamoDBODBC64.msi.
  2. Click Next.
  3. Select the check box to accept the terms of the License Agreement if you agree, and then click Next.
  4. To change the installation location, click Change, then browse to the desired folder, and then click OK. To accept the installation location, click Next.
  5. Click Install.
  6. When the installation completes, click Finish.
  7. If you received a license file via e-mail, then copy the license file into the \lib subfolder in the installation folder you selected above.
  8. Note:

    To avoid security issues, you might need to save the license file on your local machine prior to copying the file into the \lib subfolder.

Configuring the Driver

To use the Simba DynamoDB ODBC Driver in a client application, you need to configure a Data Source Name (DSN) to connect to your data store.

Connections to the DynamoDB service on AWS require different DSN settings compared to connections to DynamoDB Local. Follow the procedure that corresponds to the type of data source you are connecting to:

Creating a DSN for Connecting to DynamoDB on AWS

To create a DSN for connecting to the DynamoDB service on AWS:

  1. Open the ODBC Administrator:
    • If you are using Windows 7 or earlier, click Start Windows Start button, then click All Programs, then click the Simba DynamoDB ODBC Driver program group corresponding to the bitness of the client application accessing data in DynamoDB, and then click ODBC Administrator.
    • If you are using Windows 8 or later, on the Start screen, type ODBC administrator, and then click the ODBC Administrator search result corresponding to the bitness of the client application accessing data in DynamoDB.
  2. Click the System DSN tab.
  3. Select Simba DynamoDB ODBC DSN in the list of DSNs, and then click Configure.
  4. In the Host field, type the URL (the endpoint) for the DynamoDB service.
  5. Make sure that the DynamoDB Local check box is cleared.
  6. In the Authentication area, in the Region field, type the AWS region to which you want to connect.
  7. Select IAM Credentials.
  8. In the Access Key field, type your access key ID for connecting to the DynamoDBservice.
  9. In the Secret Key field, type the secret access key corresponding to your access key ID.
  10. Encrypt your credentials by doing one of the following:
    • If the credentials should be used only by the current Windows user, select Current User Only.
    • If the credentials should be used by all users on the current Windows machine, select All Users of this Machine.
  11. If you are using temporary security credentials, select the Temporary Session Token check box and then copy and paste your session token into the field. Otherwise, leave the check box cleared.
  12. To create a schema file and configure the driver to use it when connecting to the data store, do the following:
    1. Click Schema Definition.
    2. Click Browse, then browse to the directory where you want to store the schema file, and then type a name for the file and click Save.
    3. Click Generate All.
    4. After the driver finishes generating the schema, click OK to close the Schema Definition dialog box. If you are prompted to confirm whether you want to close the dialog box without updating the database metadata, click Yes.
    5. In the Simba DynamoDB ODBC Driver DSN Setup dialog box, click Advanced Options.
    6. In the Advanced Options dialog box, select Local File and then specify the full path of the schema file.
    7. To save your settings and close the Advanced Options dialog box, click OK.
  13. To test the connection to your DynamoDB data store, click the Test button in the Simba DynamoDB ODBC Driver DSN Setup dialog box.
  14. The Test Results dialog box appears, displaying a message informing you if the connection succeeded or failed.

  15. Click OK to close the Test Results dialog box, and then click OK to save your DSN and close the Simba DynamoDB ODBC Driver DSN Setup dialog box.

Note:

For more information about configuring the Simba DynamoDB ODBC Driver, including how to configure different authentication methods and modify the schema defined for the DynamoDB data store, refer to the Simba DynamoDB ODBC Driver Installation and Configuration Guide.

Creating a DSN for Connecting to DynamoDB Local

To create a DSN for connecting to DynamoDB Local:

  1. Open the ODBC Administrator:
    • If you are using Windows 7 or earlier, click Start Windows Start button, then click All Programs, then click the Simba DynamoDB ODBC Driver program group corresponding to the bitness of the client application accessing data in DynamoDB, and then click ODBC Administrator.
    • If you are using Windows 8 or later, on the Start screen, type ODBC administrator, and then click the ODBC Administrator search result corresponding to the bitness of the client application accessing data in DynamoDB.
  2. Click the System DSN tab.
  3. Select Simba DynamoDB ODBC DSN in the list of DSNs, and then click Configure.
  4. In the Host field, type the IP address of the server.
  5. Select the DynamoDB Local check box.
  6. In the Port field, type the number of the port used by the server.
  7. Note:

    The default port number used by DynamoDB Local is 8000.

  8. To create a schema file and configure the driver to use it when connecting to the data store, do the following:
    1. Click Schema Definition.
    2. Click Browse, then browse to the directory where you want to store the schema file, and then type a name for the file and click Save.
    3. Click Generate All.
    4. After the driver finishes generating the schema, click OK to close the Schema Definition dialog box. If you are prompted to confirm whether you want to close the dialog box without updating the database metadata, click Yes.
    5. In the Simba DynamoDB ODBC Driver DSN Setup dialog box, click Advanced Options.
    6. In the Advanced Options dialog box, select Local File and then specify the full path of the schema file.
    7. To save your settings and close the Advanced Options dialog box, click OK.
  9. To test the connection to your DynamoDB data store, click the Test button in the Simba DynamoDB ODBC Driver DSN Setup dialog box.
  10. The Test Results dialog box appears, displaying a message informing you if the connection succeeded or failed.

  11. Click OK to close the Test Results dialog box, and then click OK to save your DSN and close the Simba DynamoDB ODBC Driver DSN Setup dialog box.

Note:

For more information about configuring the Simba DynamoDB ODBC Driver, including how to modify the schema defined for the DynamoDB data store, refer to the Simba DynamoDB ODBC Driver Installation and Configuration Guide.