Rapidly Develop CockroachDB-Driven Apps with Active Query Builder

Ready to get started?

Download for a free trial:

Download Now

Learn more:

CockroachDB ODBC Driver

The CockroachDB ODBC Driver is a powerful tool that allows you to connect with live data from CockroachDB, directly from any applications that support ODBC connectivity.

Access CockroachDB data like you would a database - read, write, and update CockroachDB NewSQLDB, etc. through a standard ODBC Driver interface.



Leverage the Active Query Builder SQL interface builder and the ease of .NET data access to create data-driven WinForms and ASP.NET apps.

Write standard .NET to expose CockroachDB data through an SQL interface: Active Query Builder helps developers write SQL interfaces; the CData ODBC Driver for CockroachDB enables standards-based access to CockroachDB. This integration uses the Microsoft ADO.NET Provider for ODBC as a bridge between the ODBC Driver and the Active Query Builder objects to build a visual SQL composer.

Connect to CockroachDB as an ODBC Data Source

If you have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs.

Set the following to connect to CockroachDB.

  • Server: The host name or IP address of the server.
  • Port: The port number of the CockroachDB server. If not specified, the default port is 26257.
  • Database: The name of the Cockroach database. If not specified, you connect to the user's default database.
  • User: The Cockroach DB user account used to authenticate.
  • Password: The password used to authenticate the user.

Use SQL to Interact with CockroachDB

Follow the steps below to create a WinForms visual query builder.

  1. In a new Windows Forms project, drag the QueryBuilder from the Toolbox onto the form.
  2. Add a reference to ActiveQueryBuilder.ODBCMetadataProvider.
  3. Add an OdbcConnection and set the connection string to the DSN that you created in the first section. OdbcConnection connection = new OdbcConnection(); connection.ConnectionString = "DSN=CockroachDB"
  4. Initialize ODBCMetadataProvider and GeneralSyntaxProvider instances and set the Connection property of the ODBCMetadataProvider object to the OdbcConnection. GenericSyntaxProvider syntaxProvider = new GenericSyntaxProvider(); ODBCMetadataProvider metadataProvider = new ODBCMetadataProvider(); metadataProvider.Connection = connection;
  5. Set the corresponding MetadataProvider and SyntaxProvider properties of the QueryBuilder object. queryBuilder1.MetadataProvider = metadataProvider; queryBuilder1.SyntaxProvider = syntaxProvider;
  6. Call the InitiatelizeDatabaseSchemaTree method of the QueryBuilder class to retrieve CockroachDB metadata and generate a tree view of CockroachDB tables. queryBuilder1.InitializeDatabaseSchemaTree();
  7. After creating the QueryBuilder, connect it to a TextBox or, as we use, the ActiveQueryBuilder SQLTextEditor: Drag and drop an SQLTextEditor onto the designer.

  8. Add the following code to the Validating event for the SQLTextEditor: private void sqlTextEditor1_Validating(object sender, CancelEventArgs e) { try { // Update the query builder with manually edited query text: queryBuilder1.SQL = sqlTextEditor1.Text; } catch (SQLParsingException ex) { e.Cancel = true; // Set caret to error position sqlTextEditor1.SelectionStart = ex.ErrorPos.pos; // Report error MessageBox.Show(ex.Message, "Parsing error"); } }
  9. Add the following to the SQLUpdated event: private void queryBuilder1_SQLUpdated(object sender, EventArgs e) { sqlTextEditor1.Text = queryBuilder1.FormattedSQL; }
  10. You can now build queries visually: Double-click a table in the Columns Pane Area and an entity/relationship diagram is displayed in the Query Building Area. Columns that you select in the diagram are added to the query.