Starting the Schema Editor for ODBC Connections

System Requirements

The ODBC version of the Schema Editor, which is packaged with ODBC connectors, supports ODBC connections only. However, the schema definitions themselves are compatible with both the ODBC and JDBC versions of the Schema Editor, and can be used by both ODBC and JDBC connectors regardless of the Schema Editor that was used to create the definition.

Important:

The Schema Editor does not support Couchbase schema definitions that were created using version 1.1.2 or earlier of the ODBC connector.

Windows

The Schema Editor supports the following versions of Windows (32- and 64-bit editions are supported):

  • Windows 11, or 10
  • Windows Server 2016 or later

Linux

The Schema Editor supports the following Linux distributions (32- and 64-bit editions are supported):

  • Red Hat® Enterprise Linux® (RHEL) 8 or 9
  • SUSE Linux Enterprise Server (SLES) 15
  • Debian 11 or 12
  • Ubuntu 22.04 or 24.04

To use the Schema Editor on Linux, you must have the following software installed:

  • GTK+ 2.18, 2.20, or 2.24
  • One of the following ODBC driver managers:
    • iODBC 3.52.9 or later
    • unixODBC 2.2.14 or later

Note:

If the LD_LIBRARY_PATH environment variable on your machine includes paths for both iODBC and unixODBC, unixODBC takes precedence.

macOS

The Schema Editor supports macOS version 13, 14, or 15.

To use the Schema Editor on macOS, you must have one of the following ODBC driver managers installed:

  • iODBC 3.52.9 or later
  • unixODBC 2.2.14 or later

Note:

If the DYLD_LIBRARY_PATH environment variable on your machine includes paths for both iODBC and unixODBC, iODBC takes precedence.

Starting the Schema Editor

Depending on which platform you are running, different procedures and files are available for starting the application.

To start the Schema Editor on Windows:

  • Choose one:
  • From the program group of your Simba connector, click the SchemaEditor application shortcut.
  • Or, open the ODBC Data Source Administrator where you created the DSN for your connection, select the DSN, click Configure, and then click Schema Editor.

    • Note:

    When you start the Schema Editor from the DSN configuration of a connector, the application automatically uses the connection information specified in your DSN.

To start the Schema Editor on Linux:

  1. Navigate to the [DRIVER_DIR]/Tools/[Bitness]/SchemaEditor folder, where [DRIVER_DIR] is the root directory of the connector and [Bitness] is the bitness of your connector installation.
  2. Run the SchemaEditor application.

To start the Schema Editor on macOS:

  1. Navigate to the [DRIVER_DIR]/Tools/SchemaEditor folder, where [DRIVER_DIR] is the root directory of the connector.
  2. Run the SchemaEditor application.

The Schema Editor opens on the start page. From there, you can choose to create a new schema definition by sampling data, or modify an existing schema definition stored in a JSON file or a NoSQL data store.