#Jackdb docs update
A query or statement can return one of four types of results when it is executed:Īn error message is returned for invalid queries or statements, along with the underlying exception and the error reported by the driver for the data source.Īn update message is returned for statements that modify data but do not return a result set, e.g., a file upload. The Execute command executes the current query or statement, i.e., any block of text in the editor that your data source accepts as a query or statement. Commands are various actions that apply to the text in your editor, usually as a query or statement that interacts with your data source. JackDB implements a number of useful standard commands.
#Jackdb docs code
The query editor provides all the necessary tools to write and execute queries, including syntax highlighting, code formatting, and auto completion.
#Jackdb docs download
Query execution time is displayed, along with an option to download results. Database records are retrieved as they’re scrolled into view or by explicitly fetching more rows. The data grid displays a scrollable grid of zero or more rows for executed SQL queries and statements that return data.
The information displayed is specific to your data source. You can also view important details like sessions, tablespaces, and extensions. The object browser displays information in a tree format, giving you an instant view of database details like tables, views, indexes, schemas, columns, keys, constraints, triggers, procedures, functions, and more.Ĭlicking on an object (for example, a database table) will load its details on the right-hand side of the screen. To use a non- id field to refer to an object, prefix the field name with a colon ( :) in the request path.After connecting to a data source, users can explore database objects and execute commands in the query editor. Additionally, most objects include additional fields that may be unique as well. Unique IdentifiersĪPI endpoints that refer to an individual object (e.g., Person, Data Source) can be referenced by any unique identifier for that object. Note: Regardless of the format of the request body, API responses will always be returned as JSON.
Timestamp fields are always represented in ISO-8601 format. The id field will remain constant throughout the life of an object.
Successful responses will return a 200 status code, rejected requests ( including authentication errors) will return 40X status codes, and internal server errors will return 50X status codes. Whenever possible, HTTP status codes reflecting the response will be returned. export JACKDB_API_URL=""Įxport JACKDB_API_KEY_ID="423a2940-a1c5-40db-8c3f-9900641e2b36"Įxport JACKDB_API_KEY_SECRET="Xcn2DbmQflnDSPLFPXfnVxMS4QKZsCzR"Īll API responses are returned as JSON. You’ll need to replace them with their equivalents for your JackDB environment.Īfter creating an API key from the web interface, you can find the same values for your JackDB installation by viewing the details of a newly created API key. The examples below assume the following environment variables have been defined. Parameter values are represented as $ so that you can control and replace them via environment variables. cURL ExamplesĮxamples are provided using the cURL command-line tool to demonstrate the requests to and responses from the various API endpoints. Endpoint Prefixįor the current version of the API, all endpoints are prefixed with /api/v2.
#Jackdb docs password
The username is your API key id suffixed with The password is your API secret. Authentication is done using HTTP Authorization header using Basic authentication. AuthenticationĪll API requests must be authenticated. HTTPSĪll API requests must occur over HTTPS. Requests with a blank User-Agent header will be rejected.Ĭlients must specify an Accept: application/2+json header. The same hostname that clients use to connect to the JackDB web interface should be used.Ĭlients must specifiy a User-Agent header. The JackDB API is organized around the following high-level endpoints and resources:Ĭlient must address requests to the hostname for their JackDB server.
0 kommentar(er)
