Dremio Cloud

https://docs.dremio.com/cloud
Admin
Dremio Cloud is a cloud-based data lakehouse platform that enables organizations to connect to data...
Tokens:952,103
Snippets:8,036
Trust Score:10
Update:4 hours ago
Show doc for...
Tokens:
Raw
### INITCAP example with 'a guide to data lakehouses'

Source: https://docs.dremio.com/cloud/reference/sql/sql-functions/functions/INITCAP/

Returns 'A Guide To Data Lakehouses' from the input string 'a guide to data lakehouses'.

```sql
SELECT INITCAP('a guide to data lakehouses')
-- A Guide To Data Lakehouses
```

--------------------------------

### INITCAP example with 'a guide to data lakeHouses'

Source: https://docs.dremio.com/cloud/reference/sql/sql-functions/functions/INITCAP/

Returns 'A Guide To Data Lakehouses' from the input string 'a guide to data lakeHouses', demonstrating that subsequent letters are converted to lowercase.

```sql
SELECT INITCAP('a guide to data lakeHouses')
-- A Guide To Data Lakehouses
```

--------------------------------

### Example 1: Create and load tables for MERGE

Source: https://docs.dremio.com/cloud/reference/sql/commands/merge/

Creates the target_table and source_table, and populates them with initial data for the MERGE example.

```sql
CREATE TABLE target_table (ID INTEGER, description VARCHAR);
CREATE TABLE source_table (ID INTEGER, description_1 VARCHAR, description_2 VARCHAR);

INSERT INTO target_table (ID, description ) VALUES
  (1, 'Original value'),
  (2, 'Original value');

INSERT INTO source_table (ID, description_1, description_2) VALUES
  (1, 'Value 1', 'Value 2'),
  (3, 'Value 1', 'Value 2');
```

--------------------------------

### Example Response for GET External Token Provider

Source: https://docs.dremio.com/cloud/reference/api/external-token-providers/

Example JSON response for a successful GET request. Shows the structure of an external token provider object, including the enabled field set to true.

```json
{
  "id": "a32191f2-ede6-4533-9a17-1532eea015aa",
  "name": "My Token Provider",
  "audience": [
    "f7fdd9e0-8332-4131-95ce-b350c3bbeab2"
  ],
  "userClaim": "upn",
  "issuerUrl": "https://login.microsoftonline.com/959d4644-91e6-4652-9d16-bddeb046c807/v2.0",
  "jwksUrl": "https://login.microsoftonline.com/959d4644-91e6-4652-9d16-bddeb046c807/discovery/v2.0/keys",
  "enabled": true 
}
```

--------------------------------

### SHOW CREATE VIEW example with AT REF

Source: https://docs.dremio.com/cloud/reference/sql/commands/show-create-view/

Example showing the definition of a view at a specific branch reference. The view name is quoted and the reference is specified with AT REF.

```sql
SHOW CREATE VIEW "company_data".Locations."offices_by_region"
   AT REF "myBranch"
```

--------------------------------

### Retrieve Vacuum Configuration - Example Request

Source: https://docs.dremio.com/cloud/reference/api/arctic/engine/engine-vacuum/

Example curl request to retrieve the vacuum configuration. Note: The method is POST in the example, but the endpoint is GET.

```nginx
curl -X POST 'https://api.dremio.cloud/v0/arctic/catalogs/d34bd884-4d19-fe37-ac42-e45443b8234c/engine/vacuum'
--header 'Authorization: Bearer <PersonalAccessToken>' \
--header "Content-Type: application/json
```

--------------------------------

### Create a View

Source: https://docs.dremio.com/cloud/reference/sql/commands/create-view/

Creates a view named demo.example_view that selects all columns from the specified table.

```sql
CREATE VIEW demo.example_view AS
  SELECT *
  FROM "oracle_tpch".DREMIO.JOBS
```

--------------------------------

### CHAR_LENGTH example with 'get the char length'

Source: https://docs.dremio.com/cloud/reference/sql/sql-functions/functions/CHAR_LENGTH/

Returns the character length of the string 'get the char length', which is 19.

```sql
SELECT CHAR_LENGTH('get the char length')
-- 19
```

--------------------------------

### Example 2: Create and load tables for MERGE

Source: https://docs.dremio.com/cloud/reference/sql/commands/merge/

Creates the target_table and source_table with different column names, and populates them with initial data for the MERGE example.

```sql
CREATE TABLE target_table (ID INTEGER, desc_1 VARCHAR, desc_2 VARCHAR);
CREATE TABLE source_table (ID INTEGER, description_1 VARCHAR, description_2 VARCHAR);

INSERT INTO target_table (ID, desc_1, desc_2 ) VALUES
  (1, 'Original value 1', 'Original value 2'),
  (2, 'Original value 1', 'Original value 2');

INSERT INTO source_table (ID, description_1, description_2) VALUES
  (1, 'Value 1', 'Value 2'),
  (3, 'Value A', 'Value B');
```

--------------------------------

### Example session_properties configuration

Source: https://docs.dremio.com/cloud/sonar/client-apps/python/

Example showing how to set session_properties in the config file, using a schema property.

```text
session_properties:
  - schema='Samples."samples.dremio.com"'
```

--------------------------------

### OCTET_LENGTH example

Source: https://docs.dremio.com/cloud/reference/sql/sql-functions/functions/OCTET_LENGTH/

Example query using OCTET_LENGTH to get the byte length of the string 'abc'. The expected result is 3.

```sql
SELECT OCTET_LENGTH('abc')
-- 3
```

--------------------------------

### CREATE ROLE example

Source: https://docs.dremio.com/cloud/reference/sql/commands/create-role/

Example that creates a role named role1.

```sql
CREATE ROLE role1
```

--------------------------------

### LOCATE SQL example: substring found with start position

Source: https://docs.dremio.com/cloud/reference/sql/sql-functions/functions/LOCATE/

Returns 4 when searching for 'an' in 'banana' starting at position 3.

```sql
SELECT LOCATE('an','banana', 3)
-- 4
```

--------------------------------

### ARRAY_GENERATE_RANGE with start equal to stop

Source: https://docs.dremio.com/cloud/reference/sql/sql-functions/functions/ARRAY_GENERATE_RANGE/

Returns an empty array when start equals stop. Example: SELECT ARRAY_GENERATE_RANGE(2, 2, 4) returns [].

```sql
SELECT ARRAY_GENERATE_RANGE(2, 2, 4)
-- []
```

--------------------------------

### Sample client usage command syntax

Source: https://docs.dremio.com/cloud/sonar/custom-apps/arrow-flight-sql/

Shows the usage syntax for the flight-sql-sample-client-application.jar. Includes options for host, port, TLS, personal access token, query, schema, and session properties. Defaults: TLS enabled, server verification enabled.

```text
Usage: java -jar flight-sql-sample-client-application.jar  -host localhost -port 443 ...

 -command,--command <arg>                 Method to run
 -dsv,--disableServerVerification <arg>   Disable TLS server verification.
                                          Defaults to false.
 -host,--hostname <arg>                   `data.dremio.cloud` for Dremio's US control plane
                                          `data.eu.dremio.cloud` for Dremio's European control plane
 -kstpass,--keyStorePassword <arg>        The jks keystore password.
 -kstpath,--keyStorePath <arg>            Path to the jks keystore.
 -pat,--personalAccessToken <arg>         Personal access token
 -port,--flightport <arg>                 443
 -query,--query <arg>                     The query to run
 -schema,--schema <arg>                   The schema to use
 -sp,--sessionProperty <arg>              Key value pairs of
                                          SessionProperty, example: -sp
                                          schema='Samples."samples.dremio.
                                          com"' -sp key=value
 -table,--table <arg>                     The table to query
 -tls,--tls <arg>                         Enable encrypted connection.
                                          Defaults to true.
```

--------------------------------

### Example Request: curl GET folder by ID

Source: https://docs.dremio.com/cloud/reference/api/catalog/folder/

Example curl command to retrieve a folder by its UUID. Requires a personal access token for authorization.

```nginx
curl -X GET 'https://api.dremio.cloud/v0/projects/02d36975-73eb-47ed-9bb5-de73060380f6/catalog/ffbe8c1d-1db7-48d1-9c58-f452838fedc0' \
-H 'Authorization: Bearer <personal access token>' \
-H 'Content-Type: application/json'
```

--------------------------------

### Create a table in your project store

Source: https://docs.dremio.com/cloud/reference/sql/commands/create-table-as/

Basic CREATE TABLE AS example that creates a table from a SELECT query on a sample dataset.

```sql
CREATE TABLE demo_table
  AS SELECT * FROM Samples."samples.dremio.com"."zips.json"
```

--------------------------------

### SHOW CREATE TABLE Example with Branch

Source: https://docs.dremio.com/cloud/reference/sql/commands/show-create-table/

Example showing the definition of an Arctic table in a specified branch. Requires SELECT privilege on the table.

```sql
SHOW CREATE TABLE "company_data".employees
  AT BRANCH "main"
```

--------------------------------

### Example response for GET script grants

Source: https://docs.dremio.com/cloud/reference/api/scripts/

Example JSON response showing the privileges granted to users and roles. The response includes granteeId and privileges arrays.

```json
{
  "users": [
    {
      "granteeId": "8be516f3-04c4-4d19-824d-5a70b3c4442e",
      "privileges": [
        "VIEW",
        "MODIFY",
        "DELETE",
        "MANAGE_GRANTS"
      ]
    },
    {
      "granteeId": "a97c694f-1e55-4f34-91aa-97f99fee802e",
      "privileges": [
        "VIEW",
        "MODIFY",
        "DELETE",
        "MANAGE_GRANTS"
      ]
    }
  ],
  "roles": []
}
```

--------------------------------

### Example Response for Retrieve Script

Source: https://docs.dremio.com/cloud/reference/api/scripts/

Example JSON response for a successful GET request. Shows the script's id, name, content (SQL), context, owner, and timestamps.

```json
{
  "id": "74cfddfd-cb0b-4b2f-b555-cb8b827fec1e",
  "name": "newScript",
  "content": "VACUUM CATALOG azure_test_3",
  "context": [
    "azure_test_3"
  ],
  "owner": "8be516f3-04c4-4d19-824d-5a70b3c4442e",
  "createdAt": "2024-05-24T17:42:00.304Z",
  "createdBy": "a97c694f-1e55-4f34-91aa-97f99fee802e",
  "modifiedAt": "2024-05-24T17:42:00.304Z",
  "modifiedBy": "a97c694f-1e55-4f34-91aa-97f99fee802e"
```

--------------------------------

### CREATE FOLDER syntax

Source: https://docs.dremio.com/cloud/reference/sql/commands/create-folder/

Shows the full syntax of the CREATE FOLDER command, including optional IF NOT EXISTS and AT { REF | BRANCH } clauses.

```sql
CREATE FOLDER [ IF NOT EXISTS ] <folder_name>
  [ AT { REF[ERENCE] | BRANCH } <reference_name> ]
```

--------------------------------

### Example response for adding or updating an engine

Source: https://docs.dremio.com/cloud/reference/api/arctic/engine/

Example JSON response showing the created engine with state CREATING.

```json
{
  "cloudId": "bc5787c6-e9bf-4159-a1b0-93d3cc6f19e9",
  "credentials": {
    "accessKeyId": "8BDLDGT42KJ4JEXAMPLE",
    "type": "ACCESS_KEY"
  },
  "engineSize": "XX_SMALL_V1",
  "logStorageLocation": "usrsdre-test-west1/usrsdre/",
  "state": "CREATING"
}
```

--------------------------------

### ARRAY_GENERATE_RANGE with default step and start equal to stop

Source: https://docs.dremio.com/cloud/reference/sql/sql-functions/functions/ARRAY_GENERATE_RANGE/

Returns an empty array when start equals stop and step defaults to 1. Example: SELECT ARRAY_GENERATE_RANGE(2, 2) returns [].

```sql
SELECT ARRAY_GENERATE_RANGE(2, 2)
-- []
```

--------------------------------

### ARRAY_GENERATE_RANGE with start less than stop and negative step

Source: https://docs.dremio.com/cloud/reference/sql/sql-functions/functions/ARRAY_GENERATE_RANGE/

Returns an empty array when start is less than stop and step is negative. Example: SELECT ARRAY_GENERATE_RANGE(2, 8, -2) returns [].

```sql
SELECT ARRAY_GENERATE_RANGE(2, 8, -2)
-- []
```

--------------------------------

### Example config file for connecting to Dremio Cloud

Source: https://docs.dremio.com/cloud/sonar/client-apps/python/

Example configuration file showing required settings for connecting to Dremio Cloud, including hostname, port, personal access token, TLS, and a sample query.

```text
hostname: data.dremio.cloud
port: 443
pat: my_PAT
tls: true
query: SELECT * FROM Samples."samples.dremio.com"."NYC-taxi-trips" limit 10
```

--------------------------------

### ARRAY_GENERATE_RANGE with start greater than stop and positive step

Source: https://docs.dremio.com/cloud/reference/sql/sql-functions/functions/ARRAY_GENERATE_RANGE/

Returns an empty array when start is greater than stop and step is positive. Example: SELECT ARRAY_GENERATE_RANGE(8, 2, 2) returns [].

```sql
SELECT ARRAY_GENERATE_RANGE(8, 2, 2)
-- []
```

--------------------------------

### Example Response for Retrieving a Source

Source: https://docs.dremio.com/cloud/reference/api/catalog/source/

JSON response showing source details including configuration, metadata policy, and children.

```json
{
  "entityType": "source",
  "config": {
    "hostname": "177.15.0.112",
    "port": "3306",
    "authenticationType": "ANONYMOUS",
    "netWriteTimeout": 60,
    "fetchSize": 200,
    "maxIdleConns": 8,
    "idleTimeSec": 60,
    "propertyList": []
  },
  "id": "629904cf-9c06-4ae6-8cc1-faf1d2f1ab5f",
  "tag": "a927dd14-2c7d-4684-9de2-4000e05c0d07",
  "type": "MYSQL",
  "name": "recruitingdb",
  "createdAt": "2022-09-12T07:22:19.334Z",
  "metadataPolicy": {
    "authTTLMs": 86400000,
    "namesRefreshMs": 86400000,
    "datasetRefreshAfterMs": 86400000,
    "datasetExpireAfterMs": 259200000,
    "datasetUpdateMode": "PREFETCH_QUERIED",
    "deleteUnavailableDatasets": true
  },
  "accelerationGracePeriodMs": 10800000,
  "accelerationRefreshPeriodMs": 3600000,
  "accelerationActivePolicyType": "PERIOD",
  "accelerationNeverExpire": false,
  "accelerationNeverRefresh": false,
  "children": [
    {
      "id": "42312a90-1723-4bcb-b62c-bf9abee371b1",
      "path": [
        "recruitingdb",
        "contacts"
      ],
      "type": "CONTAINER",
      "containerType": "FOLDER"
    }
  ],
  "allowCrossSourceSelection": false,
  "disableMetadataValidityCheck": false,
  "accessControlList": {},
  "permissions": [],
  "checkTableAuthorizer": false,
  "accelerationRefreshOnDataChanges": false,
  "owner": {
    "ownerId": "5c9c394d-7395-4687-97dd-beac4384c359",
    "ownerType": "USER"
  }
}
```

--------------------------------

### UCASE basic example

Source: https://docs.dremio.com/cloud/reference/sql/sql-functions/functions/UCASE/

Converts a string literal to uppercase. Outputs 'A GUIDE TO DATA LAKEHOUSES'.

```sql
SELECT UCASE('a guide to data lakehouses')
-- A GUIDE TO DATA LAKEHOUSES
```

--------------------------------

### LCASE basic example

Source: https://docs.dremio.com/cloud/reference/sql/sql-functions/functions/LCASE/

Converts a string literal to lowercase. The output is 'a guide to data lakehouses'.

```sql
SELECT LCASE('A GUIDE to data Lakehouses')
-- a guide to data lakehouses
```

--------------------------------

### Example Response for Creating a Wiki

Source: https://docs.dremio.com/cloud/reference/api/catalog/wiki/

Example JSON response returned after successfully creating a wiki. Contains the wiki text and a version field.

```json
{
  "text": "# Test Wiki\nThis is an example wiki for a catalog object in Dremio. Here is some text in **bold**. Here is some text in *italics*.\n\nHere is an example excerpt with quotation formatting:\n\n> Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.\n\n\n## Heading Level 2\n\nHere is a bulleted list:\n* An item in a bulleted list\n* A second item in a bulleted list\n* A third item in a bulleted list\n\n\n### Heading Level 3\n\nHere is a numbered list:\n1. An item in a numbered list\n1. A second item in a numbered list\n1. A third item in a numbered list\n\n\nHere is a sentence that includes an [external link to https://dremio.com](https://dremio.com).\n\nHere is an image:\n\n![](https://www.dremio.com/wp-content/uploads/2022/03/Dremio-logo.png)\n\nUt enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.",
  "version": 0
}
```

--------------------------------

### RESET ENGINE Example

Source: https://docs.dremio.com/cloud/reference/sql/commands/reset-engine/

Example usage of the RESET ENGINE command. Subsequent queries in the same session will be routed according to default WLM rules.

```sql
RESET ENGINE;
```

--------------------------------

### LOWER function basic example

Source: https://docs.dremio.com/cloud/reference/sql/sql-functions/functions/LOWER/

Converts a string literal to lowercase. Output is 'a guide to data lakehouses'.

```sql
SELECT LOWER('A GUIDE to data Lakehouses')
-- a guide to data lakehouses
```

--------------------------------

### Example response for listing all projects

Source: https://docs.dremio.com/cloud/reference/api/projects/

Example JSON response showing an array of project objects with metadata such as name, id, type, state, credentials, and cloudType. Includes projects in ACTIVE, INACTIVE, and ARCHIVED states.

```json
[
  {
    "name": "default-project",
    "id": "c683b988-aa93-439c-a9ac-0d7f72b53d23",
    "type": "QUERY_ENGINE",
    "cloudId": "37b34779-13f1-48e5-b2c8-f3db4c824733",
    "state": "ACTIVE",
    "createdBy": "de8a47bf-432a-4d83-b60e-90d86cda8d70",
    "modifiedBy": "de8a47bf-432a-4d83-b60e-90d86cda8d70",
    "createdAt": "Thu Aug 19 14:39:38 UTC 2023",
    "modifiedAt": "Thu Aug 19 14:39:46 UTC 2023",
    "projectStore": "my.dremio.store",
    "credentials": {
      "type": "ACCESS_KEY",
      "accessKeyId": "AKIAJIPU77TQL8LR6OIR",
      "secretAccessKey": null
    },
    "numberOfEngines": 2,
    "cloudType": "AWS",
    "primaryCatalogId": "cc9d3b9c-4b16-01ed-8067-d1f871042d9f"
  },
  {
    "name": "second-project",
    "id": "ad22911e-c6a1-11ee-a506-0242ac120002",
    "type": "QUERY_ENGINE",
    "cloudId": "37b34779-13f1-48e5-b2c8-f3db4c824733",
    "state": "INACTIVE",
    "createdBy": "339d1654-879d-4eeb-8c96-d6999334a110",
    "modifiedBy": "de8a47bf-432a-4d83-b60e-90d86cda8d70",
    "createdAt": "Wed Feb 07 17:16:57 UTC 2024",
    "modifiedAt": "Thu Feb 08 01:15:33 UTC 2024",
    "projectStore": "my.dremio.store",
    "credentials": {
      "type": "IAM_ROLE",
      "roleArn": "arn:aws:iam::388677480418:role/user-test3-DremioIAMCloudComputeRole-ULX75EXAMPLE",
      "externalId": "075f6f33-1361-46c9-b266-78cbaEXAMPLE_1234567890",
      "instanceProfileArn": null,
      "externalIdSignature": null
    },
    "numberOfEngines": 1,
    "cloudType": "AWS",
    "primaryCatalogId": "cc9d3b9c-4b16-01ed-8067-d1f871042d9f",
    "lastStateError": {
      "timestamp": 1707339965231,
      "error": "INVALID_CREDENTIALS"
    }
  },
  {
    "name": "azure-project",
    "id": "09d9e30d-0b10-4ea7-821c-8e902c47f908",
    "type": "QUERY_ENGINE",
    "cloudId": "3986c088-93f1-41b8-a45a-d51831478f71",
    "state": "ACTIVE",
    "createdBy": "c2697d8e-d455-495c-ae56-a5ce30d1b02e",
    "modifiedBy": "c2697d8e-d455-495c-ae56-a5ce30d1b02e",
    "createdAt": "Mon Oct 23 14:08:50 UTC 2023",
    "modifiedAt": "Mon Oct 23 14:08:54 UTC 2023",
    "projectStore": "teststoragecontainer",
    "credentials": {
      "type": "AZURE_STORAGE_CLIENT_CREDENTIALS",
      "tenantId": "10070cc4-8877-4b2b-a8c8-b5c7e640d1cd",
      "clientId": "ba71d0bb-d8ef-43b4-be0f-0cc5d080449b",
      "clientSecret": "secret",
      "accountName": "testaccount"
    },
    "numberOfEngines": 3,
    "cloudType": "AZURE",
    "primaryCatalogId": "cc9d3b9c-4b16-01ed-8067-d1f871042d9f"
  },
  {
    "name": "second-azure-project",
    "id": "89bd0e01-ec06-403e-a80e-01ca9c9b51df",
    "type": "QUERY_ENGINE",
    "cloudId": "3986c088-93f1-41b8-a45a-d51831478f71",
    "state": "ARCHIVED",
    "createdBy": "c2697d8e-d455-495c-ae56-a5ce30d1b02e",
    "modifiedBy": "c2697d8e-d455-495c-ae56-a5ce30d1b02e",
    "createdAt": "Wed Feb 07 17:16:57 UTC 2024",
    "modifiedAt": "Wed Feb 07 17:17:05 UTC 2024",
    "projectStore": "teststoragecontainer",
    "credentials": {
      "type": "AZURE_STORAGE_CLIENT_CREDENTIALS",
      "tenantId": "10070cc4-8877-4b2b-a8c8-b5c7e640d1cd",
      "clientId": "ba71d0bb-d8ef-43b4-be0f-0cc5d080449b",
      "clientSecret": "secret",
      "accountName": "departmentaccount"
    },
    "numberOfEngines": 3,
    "cloudType": "AZURE",
    "primaryCatalogId": "cc9d3b9c-4b16-01ed-8067-d1f871042d9f",
    "lastStateError": {
      "timestamp": 1707339965231,
      "error": "INVALID_CREDENTIALS"
    }
  }
]
```

--------------------------------

### STARTS_WITH SQL Example

Source: https://docs.dremio.com/cloud/reference/sql/sql-functions/functions/STARTS_WITH/

Example query using STARTS_WITH to filter records where the Category starts with 'OTHER'. The query selects IncidntNum, Category, and Descript from the SF_incidents2016.json sample data, limits to 2 rows, and shows sample output.

```sql
SELECT IncidntNum, Category, Descript FROM  "Samples"."samples.dremio.com"."SF_incidents2016.json"
  WHERE STARTS_WITH(Category, 'OTHER')
  LIMIT 2
-- IncidntNum, Category, Descript
-- 160003130, OTHER OFFENSES, PAROLE VIOLATION
-- 160073014, OTHER OFFENSES, RESISTING ARREST
```

--------------------------------

### Example response for GET /v0/clouds/{id}

Source: https://docs.dremio.com/cloud/reference/api/clouds/

Example JSON response containing cloud metadata including name, ID, timestamps, and attributes such as vendor, region, subnets, security group IDs, credentials, and VPC endpoint ID.

```json
  {
  "name": "docCloud",
  "id": "e43e8505-8a44-4dc5-8181-75be1067cf99",
  "createdBy": "de8a47bf-432a-4d83-b60e-90d86cda8d70",
  "modifiedBy": "de8a47bf-432a-4d83-b60e-90d86cda8d70",
  "createdAt": "Sat Aug 21 16:37:18 UTC 2023",
  "modifiedAt": "Sat Aug 21 16:37:18 UTC 2023",
  "attributes": {
    "vendor": "aws",
    "region": "US_WEST_2",
    "subnets": [
      "subnet-f4dec3df",
      "subnet-e9a0fedd"
    ],
    "securityGroupIds": [
      "sg-03b443cd073634008"
    ],
    "credentials": {
      "type": "ACCESS_KEY",
      "accessKeyId": "AKIAJIPU77TQL8LR6OIR",
      "secretAccessKey": null
    },
    "vpcEndpointId": "vpce-020b6e4fc2c494f27"
  }
}
```

--------------------------------

### Example SQLAlchemy URI for Preset connection

Source: https://docs.dremio.com/cloud/sonar/client-apps/preset/

Example URI showing the format with a sample PAT and project ID. Note the URL-encoded PAT and the ssl=1 property. Use this as a reference when constructing your own connection URI.

```text
dremio://$token:hoYL2mqORpOv1Lq5WNOT-A-REAL-PATq5yeHEYon%2BOT0VHM0JYS%2BCMH7kpL%2BPQ%3D%[email protected]:443/1df71752-NOT-A-PROJECT-ID-990e6b194aa4;ssl=1
```

--------------------------------

### GET /v0/api/projects/{project-id}/scripts?search=dev

Source: https://docs.dremio.com/cloud/reference/api/

Example request using the search query parameter to filter scripts by name.

```APIDOC
## [GET] /v0/api/projects/{project-id}/scripts?search=dev

### Description
Use the `search` query parameter to limit the request to objects that contain values that include the search string. For the Scripts API, the search parameter is supported for the `name` attribute.

### Method
GET

### Endpoint
/v0/api/projects/{project-id}/scripts?search=dev

### Parameters
#### Query Parameters
- **search** (string) - Required - The search string to match against the `name` attribute.

### Request Example
```nginx
curl -X GET 'https://api.dremio.cloud/v0/api/projects/{project-id}/scripts?search=dev' \
--header 'Authorization: Bearer <PersonalAccessToken>' \
--header 'Content-Type: application/json'
```
```

--------------------------------

### Example Request Using Optional Parameters

Source: https://docs.dremio.com/cloud/reference/api/sql/

Submits a SQL query with the optional 'context' and 'references' parameters. The 'context' specifies the container path, and 'references' specifies Arctic source versions (branch, tag, commit).

```nginx
curl -X POST 'https://api.dremio.cloud/v0/projects/02a36975-73bc-47de-9fg5-ff73060380f6/sql' \
--header 'Authorization: Bearer <personal access token>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "sql": "SELECT * FROM \"SF weather 2018-2019.csv\"",
  "context": [
    "Samples",
    "samples.dremio.com"
  ],
  "references": {
    "myCatalog": {
      "type": "BRANCH",
      "value": "testing"
    },
    "anotherCatalog": {
      "type": "TAG",
      "value": "Test commit"
    },
    "thirdCatalog": {
      "type": "COMMIT",
      "value": "7a5edb57e035f52beccfab632cea070514eb8b773f616aaeaf668e2f0be8f10d"
    }
  }
}'
```

--------------------------------

### GET /v0/projects/{project-id}/catalog/privileges?type=SOURCE

Source: https://docs.dremio.com/cloud/reference/api/

Example request using the type query parameter to limit results to sources.

```APIDOC
## [GET] /v0/projects/{project-id}/catalog/privileges?type=SOURCE

### Description
Use the `type` query parameter to limit the response to include only results for the specified type. For example, appending `?type=SOURCE` limits the response to sources.

### Method
GET

### Endpoint
/v0/projects/{project-id}/catalog/privileges?type=SOURCE

### Parameters
#### Query Parameters
- **type** (string) - Required - The type of results to include. Valid values include `SOURCE`.

### Request Example
```nginx
curl -X GET 'https://api.dremio.cloud/v0/projects/{project-id}/catalog/privileges?type=SOURCE' \
--header 'Authorization: Bearer <PersonalAccessToken>' \
--header 'Content-Type: application/json'
```
```
Tokens:
Raw