Dremio Cloud
Dremio Software
 
On this page

    Physical Datasets

    Endpoints:

    Physical Dataset Object

    Physical Dataset Attributes

    Name Type Description

    Format Data as a Physical Dataset

    POST /v0/projects/{project-id}/catalog/{id}

    Format a file or folder to a physical dataset. The physical dataset that gets created has a different ID than the file/folder since it is a different catalog entity.

    Parameters

    Name Located in Type Description Required
    project-id path string (uuid) The ID of the project that contains the file/folder you want to format. Yes
    id path string (uuid) The ID of the file or folder you want to format as a physical dataset Yes
    entityType query string Container type. This attribute is always FOLDER for folders. Yes
    path query [ string ] The path for this folder.
    Example: ["reporting", "test-folder"]    		 Yes
    tag query string
    type query
    fields query
    createdAt query
    accelerationRefreshPolicy query
    sqlContext query
    format query

    Example Request

    curl -X GET 'https://api.dremio.cloud/v0/projects/02d36975-73eb-47ed-9bb5-de73060380f6/catalog/' \
-H 'Authorization: Bearer <personal access token>' \
-H 'Content-Type: application/json' \
-D '{

}'

    Example Response

    Responses

    Code Description
    200 Physical dataset created successfully.
    400 The supplied CatalogEntity object is invalid.
    404 User does not have permission to create the catalog entity.

    Refreshing a Physical Dataset

    POST /v0/projects/{project-id}/catalog/{id}/refresh

    Refreshes the specified physical dataset. Also, refreshes the reflections associated with the physical dataset.

    Parameters

    Name Located in Type Description Required
    project-id path string (uuid) The ID of the project that contains the physical dataset to refresh. Yes
    id path string (uuid) The ID of the physical dataset to refresh. Yes

    Example Request

    curl -X POST 'https://api.dremio.cloud/v0/projects/02d36975-73eb-47ed-9bb5-de73060380f6/catalog/e2676566-1946-4f11-8e21-9fbb366fa77a/refresh' \
-H 'Authorization: Bearer <personal access token>' \
-H 'Content-Type: application/json' \
-H 'cache-control: no-cache'

    Example Response

    No response

    Response

    Code Description
    200 Physical dataset refreshed successfully.
    403 User does not have permission to access the catalog entity.
    404 A catalog entity with the specified ID could not be found.

    Deleting a Physical Dataset

    DELETE /v0/projects/{project-id}/catalog/{id}

    Deleting the physical dataset reverses the formatting on the data and reverts it back to its’ original format (file or folder).

    Parameters

    Name Located in Type Description Required
    project-id path string (uuid) The ID of the project that contains the physical dataset to delete. Yes
    id path string (uuid) The ID of the physical dataset to delete. Yes

    Example Request

    curl -X DELETE 'https://api.dremio.cloud/v0/projects/02d36975-73eb-47ed-9bb5-de73060380f6/catalog/fabe8c1d-1cd4-23k8-9l58-f888838dsdc0' \
-H 'Authorization: Bearer <personal access token>' \
-H 'Content-Type: application/json'

    Example Response

    No response