Skip to content

Latest commit

 

History

History
40 lines (28 loc) · 2.66 KB

README.md

File metadata and controls

40 lines (28 loc) · 2.66 KB
Raw

Datagrok database connectors

Out of the box, the platform comes with the data connectors for 30+ popular databases, and the list is constantly growing. In addition to that, it is possible to develop your own data connectors, and seamlessly integrate them into the platform.

How it works

A server works with the "Grok Connect" REST endpoints registered with the platform. The endpoint's methods are:

  • getConnectors - returns all connectors that the endpoint supports (one for database type)
  • getSchema(connection) - if applicable, returns database schema for the given connection
  • testConnection(connection) - tests the connection
  • execute(query) - executes the specified query
  • queryTable(structuredQuery) - executes a structured query

At startup, the server asks each registered endpoint for the list of supported connectors, and creates a global list of supported connectors. The client asks the server for the available connectors, and populates the UI accordingly. Later on, when client makes a request to query a database, this request gets accepted by a server, and then routed to the corresponding database connector.

How to add a new database connector

  1. Create a DataProvider subclass. If you are adding a JDBC provider, subclass it from the JdbcDataProvider.

  2. Then, override the required methods depending on the specifics of the database/provider.

  3. Add it to the Providers list (list of supported providers) in the connectors_info/DataProvider.java.

How to test a database connector

You have two options for testing your database connector:

Test with GrokConnectShell:

  1. Open connectors/examples/query.json(or use another file which you will need to use in below configuration) and set the query information: set the query itself, datasource equal to descriptor.type in your provider, credentials to server and server address, port, and db name.
  2. Add next run configuration: Application, program arguments: --q examples/query.json --o examples/output.csv if you want to save your output in the connectors/examples/output.csv, or --q examples/query.json if you want to print your output.
  3. Now you can run GrokConnectShell.main() with the added configuration and check the output.

Or you can try to connect Datagrok Docker image to the grok_connect.