Welcome to Dremio Cloud Documentation - Dremio > > > >

Schedules preview

Dremio Arctic enables you to schedule optimization jobs to help you manage the accumulation of the data files that occurs through DML operations. This API allows you to add, modify, retrieve, list, and delete schedules.

Schedules Object

{
  "type": "OPTIMIZE",
  "catalogId": "1a234bc5-6789-46d7-b9cb-d236e195b34a",
  "id": "123ab456-cdef-78ab-c901-23de4f5ab6c7",
  "schedule": "@daily",
  "username": "dremio_user@company.com",
  "config": {
    "tableId": "sample-nyc-taxi-data",
    "reference": "main",
    "maxFileSize": "460 MB",
    "minFileSize": "192 MB",
    "minFiles": 5,
    "targetFileSize": "256 MB"
  }
}

Schedule Attributes

The type of job that is run by the schedule. For Arctic optimization jobs, the type is OPTIMIZE.

Example OPTIMIZE

Unique identifier for the catalog where the schedule ran.

Example 1a234bc5-6789-46d7-b9cb-d236e195b34a

Unique identifier for the schedule.

Example 123ab456-cdef-78ab-c901-23de4f5ab6c7

Identifies a schedule's frequency. Can be a preset option or a supported cron expression. The cron expressions that are supported include:

Dash-separated ranges
Comma-separated lists
Quotients
Individual field values for minutes, hours, day of month, month, and day of week
JAN-DEC, SUN-SAT, and their equivalent numeric values

The enum lists the preset options. The example shows a cron expression to run the job on the first day of every month. For information about cron expressions, read cron.

Enum @once , @hourly , @daily , @weekly , @monthly

Example 0 0 1 * *

The user who created the schedule.

Example dremio_user@company.com

Configuration options for the specified schedule.

`config` Object Attributes

Identifies the branch, tag, or commit where the table containing the optimization schedule is located.

Example main

The name of the table that the optimization schedule applies to. The table name is preceded by zero or more namespaces with a period (.) as the separator.

Example sample-NYC-taxi-trips, tripdata.sample-NYC-taxi-trips

The maximum file size threshold for type OPTIMIZE. Files that are larger in size than the specified maxFileSize qualify for optimization. The integer must be a non-negative number. The default value is 460 MB.

Example 460 MB

The minimum file size threshold for type OPTIMIZE. Files that are smaller in size than the specified minFileSize qualify for optimization. The integer must be a non-negative number. The default value is 192 MB.

Example 192 MB

The minimum number of qualified files required to run an optimization job. Supports only type OPTIMIZE. The default is 5 files.

Example 5

Controls the target size of the files that are generated for type OPTIMIZE. The integer must be a non-negative number. The default file size is 256 MB.

Example 256 MB

Listing All Schedules

List all the job schedules available for the specified Arctic catalog.

Method and URL

GET /v0/arctic/catalogs/{catalogId}/schedules

Parameters

Unique identifier of the catalog you want to list all job schedules for.

Example 1a234bc5-6789-46d7-b9cb-d236e195b34a

A common expression language (CEL) expression that filters responses so that they include only results with the specified attributes and values. Value is a URL-encoded string that represents a JSON object. The JSON object specifies the attributes to filter on and the values to match for each attribute. Read filter Query Parameter for usage examples.

The maximum number of results to to return in the response. The server may return fewer results, but not more. The default is 10. Read maxResults Query Parameter for usage examples.

Token for retrieving the next page of jobs. If the Dremio instance has more jobs than the maximum per page (default 10), the response will include a nextPageToken after the data array. Use the nextPageToken value in your request URL as the pageToken value. Do not change any other query parameters included in the request URL when you use pageToken. Read pageToken Query Parameter for usage examples.

`filter` Object Attributes

The type of job to be run by the schedule. For Arctic optimization jobs, the type is OPTIMIZE.

Example OPTIMIZE

The name of the table that the optimization schedule applies to. The table name is preceded by zero or more namespaces with a period (.) as the separator. If a tableID is used, then the type is OPTIMIZE.

Example sample-NYC-taxi-trips, tripdata.sample-NYC-taxi-trips

Identifies the branch, tag, or commit where the table containing the optimization schedule is located. If a reference is used, then the type is OPTIMIZE.

Example main

The user who created the schedule.

Example dremio_user@company.com

Example Request

curl -X GET 'https://api.dremio.cloud/v0/arctic/catalogs/1a234bc5-6789-46d7-b9cb-d236e195b34a/schedules' \
-H 'Authorization: Bearer <personal access token>' \
-H 'Content-Type: application/json'

Example Response

[
  {
    "data": [
    {
      "type": "OPTIMIZE",
      "id": "123ab456-cdef-78ab-c901-23de4f5ab6c7",
      "schedule": "@weekly",
      "username": "dremio_user@company.com",
      "config": {
        "maxFileSize": "460 MB",
        "minFileSize": "192 MB",
        "minFiles": 5,
        "reference": "etl",
        "tableId": "sample-NYC-taxi-trips",
        "targetFileSize": "256 MB"
      }
    },
    {
      "type": "OPTIMIZE",
      "id": "abc123d4-ab12-345cd-1234-abc123def456",
      "schedule": "@monthly",      
      "username": "dremio_user@company.com",
      "config": {
        "maxFileSize": "920 MB",
        "minFileSize": "384 MB",
        "minFiles": 5,
        "reference": "dev",
        "tableId": "sample-SF-taxi-trips",
        "targetFileSize": "512 MB"
      }
    }
   ]
  }
]

Responses

Creating a Schedule

Creates a job schedule for the specified Arctic catalog.

Method and URL

POST /v0/arctic/catalogs/{catalogId}/schedules

Parameters

The type of job that is run by the schedule. For Arctic optimization jobs, the type is OPTIMIZE.

Example OPTIMIZE

Unique identifier of the catalog you want to add a job schedules for.

Example 1a234bc5-6789-46d7-b9cb-d236e195b34a

Identifies a schedule's frequency. Can be a preset option or a supported cron expression. The cron expressions that are supported include:

Dash-separated ranges
Comma-separated lists
Quotients
Individual field values for minutes, hours, day of month, month, and day of week
JAN-DEC, SUN-SAT, and their equivalent numeric values

The enum lists the preset options. The example shows a cron expression to run the job on the first day of every month. For information about cron expressions, read cron.

Enum @once , @hourly , @daily , @weekly , @monthly

Example 0 0 1 * *

Configuration options for the specified schedule.

`config` Object Attributes

Identifies the branch, tag, or commit where the table containing the optimization schedule is located.

Example main

The name of the table that the optimization schedule applies to. The table name is preceded by zero or more namespaces with a period (.) as the separator.

Example sample-NYC-taxi-trips, tripdata.sample-NYC-taxi-trips

Example 460 MB

Example 192 MB

The minimum number of qualified files required to run an optimization job. Supports only type OPTIMIZE. The default is 5 files.

Example 5

Controls the target size of the files that are generated for type OPTIMIZE. The integer must be a non-negative number. The default file size is 256 MB.

Example 256 MB

Example Request to Create a Weekly Schedule

curl -X POST 'https://api.dremio.cloud/v0/arctic/catalogs/1a234bc5-6789-46d7-b9cb-d236e195b34a/schedules \
-H 'Authorization: Bearer <personal access token>' \
-H 'Content-Type: application/json' \
-d '{
    "type": "OPTIMIZE",
    "schedule": "@weekly",
    "config": {
       "reference": "etl",
       "tableID": "sample-NYC-taxi-trips",
       "maxFileSize": "460 MB",
       "minFileSize": "192 MB",
       "minFiles": 5,
       "targetFileSize": "70 MB"
      }
    }'

Example Response

{
  "type": "OPTIMIZE",
  "id": "123ab456-cdef-78ab-c901-23de4f5ab6c7",
  "schedule": "@weekly",
  "username": "dremio_user@company.com",
  "config": {
     "maxFileSize": "460 MB",
     "minFileSize": "192 MB",
     "minFiles": 5,
     "targetFileSize": "70 MB"
  }
}

Responses

Retrieving a Schedule

Retrieve the specified schedule.

Method and URL

GET /v0/arctic/catalogs/{catalogId}/schedules/{scheduleId}

Parameters

Unique identifier of the catalog you want to list all job schedules for.

Example 1a234bc5-6789-46d7-b9cb-d236e195b34a

Unique identifier of the schedule you want to retrieve.

Example 9876a54b-681b-49fe-afff-0d753ed5ad85

Example Request

curl -X GET 'https://api.dremio.cloud/v0/catalogs/1a234bc5-6789-46d7-b9cb-d236e195b34a/schedules/9876a54b-681b-49fe-afff-0d753ed5ad85' \
-H 'Authorization: Bearer <personal access token>' \
-H 'Content-Type: application/json'

Example Response

{
  "type": "OPTIMIZE",
  "id": "673cd876-abcd-1234-b478-91ca5e9cc8f6",
  "schedule": "@daily",
  "username": "analyst@company.com",
  "config": {
    "reference": "dev",
    "tableId": "sales_2022",
    "maxFileSize": "2048 MB",
    "minFileSize": "768 MB",
    "minFiles": 10,
    "targetFileSize": "1024 MB"
    },
}

Responses

Modifying a Schedule

Modify an Arctic job schedule.

Method and URL

PUT /v0/arctic/catalogs/{catalogId}/schedules/{scheduleId}

Parameters

The type of job that is run by the schedule. For Arctic optimization jobs, the type is OPTIMIZE.

Example OPTIMIZE

Unique identifier of the catalog you want to modify a schedule for.

Example 1a234bc5-6789-46d7-b9cb-d236e195b34a

Unique identifier of the schedule you want to modify.

Example 9876a54b-681b-49fe-afff-0d753ed5ad85

Identifies a schedule's frequency. Can be a preset option or a supported cron expression. The cron expressions that are supported include:

Dash-separated ranges
Comma-separated lists
Quotients
Individual field values for minutes, hours, day of month, month, and day of week
JAN-DEC, SUN-SAT, and their equivalent numeric values

The enum lists the preset options. The example shows a cron expression to run the job on the first day of every month. For information about cron expressions, read cron.

Enum @once , @hourly , @daily , @weekly , @monthly

Example 0 0 1 * *

Configuration options for the specified schedule.

`config` Object Attributes

Identifies the branch, tag, or commit where the table containing the optimization schedule is located.

Example main

The name of the table that the optimization schedule applies to. The table name is preceded by zero or more namespaces with a period (.) as the separator.

Example sample-NYC-taxi-trips, tripdata.sample-NYC-taxi-trips

Example 460 MB

Example 192 MB

The minimum number of qualified files required to run an optimization job. Supports only type OPTIMIZE. The default is 5 files.

Example 5

Controls the target size of the files that are generated for type OPTIMIZE. The integer must be a non-negative number. The default file size is 256 MB.

Example 256 MB

Example Request to Modify a Weekly Schedule

curl -X GET 'https://api.dremio.cloud/v0/catalogs/1a234bc5-6789-46d7-b9cb-d236e195b34a/schedules/9876a54b-681b-49fe-afff-0d753ed5ad85' \
-H 'Authorization: Bearer <personal access token>' \
-H 'Content-Type: application/json' \
-d '{
    "type": "OPTIMIZE",
    "schedule": "@weekly",
    "config": {
       "reference": "compare",
       "tableID": "customer-sales",
       "maxFileSize": "460 MB",
       "minFileSize": "192 MB",
       "minFiles": 3,
       "targetFileSize": "70 MB"
      }
    }'

Example Response

{
  "type": "OPTIMIZE",
  "id": "9876a54b-681b-49fe-afff-0d753ed5ad85",
  "schedule": "@weekly",
  "username": "marketing-admin@company.com",
  "config": {
     "reference": "compare",
     "tableID": "customer-sales",
     "maxFileSize": "460 MB",
     "minFileSize": "192 MB",
     "minFiles": 3,
     "targetFileSize": "70 MB"
  },
}

Responses

Deleting a Schedule

Delete an Arctic job schedule.

Method and URL

DELETE /v0/arctic/catalogs/{catalogId}/schedules/{scheduleId}

Parameters

Unique identifier of the catalog you want to delete.

Example 1a234bc5-6789-46d7-b9cb-d236e195b34a

Unique identifier of the schedule you want to delete.

Example 9876a54b-681b-49fe-afff-0d753ed5ad85

Example Request

curl -X DELETE 'https://api.dremio.cloud/v0/catalogs/1a234bc5-6789-46d7-b9cb-d236e195b34a/schedules/9876a54b-681b-49fe-afff-0d753ed5ad85' \
-H 'Authorization: Bearer <personal access token>' \
-H 'Content-Type: application/json'

Example Response

{
  "code": 200,
  "id": "e04bd884-fa37-4d10-bb4e-153443b8234c",
  "message": "Successfully found and deleted the schedule"
}

Responses

Was this page helpful?

Glad to hear it! Thank you for your feedback. Sorry to hear that. Thank you for your feedback.

Schedules preview

Schedule Attributes

config Object Attributes

Listing All Schedules

Parameters

filter Object Attributes

Responses

Creating a Schedule

Parameters

config Object Attributes

Responses

Retrieving a Schedule

Parameters

Responses

Modifying a Schedule

Parameters

config Object Attributes

Responses

Deleting a Schedule

Parameters

Responses

`config` Object Attributes

`filter` Object Attributes

`config` Object Attributes

`config` Object Attributes