Skip to main content
Version: 0.0.1

View

Use the Catalog API to retrieve, create, update, and delete views.

{{< codeheader "View Object" >}}

{
  "entityType": "dataset",
  "id": "ef99ab32-89ca-4d1c-9e91-2c8be861bb8a",
  "type": "VIRTUAL_DATASET",
  "path": [
    "Business",
    "Transportation",
    "NYC-taxi-trips-short-distance"
  ],
  "createdAt": "2022-11-17T18:31:23.236Z",
  "tag": "f90d1526-e64b-47b1-9ab0-d25df5247cab",
  "sql": "SELECT * FROM \"NYC-taxi-trips\" WHERE trip_distance_mi <= 2.0 ORDER BY trip_distance_mi ASC",
  "sqlContext": [
    "Samples",
    "samples.dremio.com"
  ],
  "accessControlList": {
    "users": [
      {
        "id": "c590ed7f-b2b4-4e1f-ba7d-94173afdc9a3",
        "permissions": [
          "SELECT",
          "ALTER"
        ]
      },
      {
        "id": "30fca499-4abc-4469-7142-fc8dd29acac8",
        "permissions": [
          "SELECT",
          "ALTER",
          "MANAGE_GRANTS"
        ]
      }
    ],
    "roles": [
      {
        "id": "76a9884b-aea5-46d5-a73a-000edf23f390",
        "permissions": [
          "SELECT",
          "ALTER"
        ]
      }
    ]
  },
  "permissions": [
    "READ",
    "WRITE",
    "ALTER_REFLECTION",
    "SELECT",
    "ALTER",
    "VIEW_REFLECTION",
    "MODIFY",
    "MANAGE_GRANTS",
    "CREATE_TABLE",
    "DROP",
    "EXTERNAL_QUERY",
    "INSERT",
    "TRUNCATE",
    "DELETE",
    "UPDATE",
    "EXECUTE",
    "CREATE_SOURCE",
    "ALL"
  ],
  "owner": {
    "ownerId": "30fca499-4abc-4469-7142-fc8dd29acac8",
    "ownerType": "USER"
  },
  "fields": [
    {
      "name": "pickup_datetime",
      "type": {
        "name": "TIMESTAMP"
      }
    },
    {
      "name": "passenger_count",
      "type": {
        "name": "BIGINT"
      }
    },
    {
      "name": "passenger_payment_method",
      "type": {
        "name": "STRUCT",
        "subSchema": [
          {
            "name": "cash",
            "type": {
              "name": "BOOLEAN"
            }
          },
          {
            "name": "credit-debit",
            "type": {
              "name": "BOOLEAN"
            }
          },
          {
            "name": "payment-app",
            "type": {
              "name": "BOOLEAN"
            }
          },
          {
            "name": "other",
            "type": {
              "name": "BOOLEAN"
            }
          }
        ]
      }
    },
    {
      "name": "trip_distance_mi",
      "type": {
        "name": "DOUBLE"
      }
    },
    {
      "name": "fare_amount",
      "type": {
        "name": "DOUBLE"
      }
    },
    {
      "name": "tip_amount",
      "type": {
        "name": "DOUBLE"
      }
    },
    {
      "name": "total_amount",
      "type": {
        "name": "DOUBLE"
      }
    }
  ]
}

View Attributes​

{{< api-section file="data/software-api/view.json" data="viewAttributes" >}}

accessControlList​

{{< api-section file="data/software-api/view.json" data="accessControlListAttributes" >}}

users and roles​

{{< api-section file="data/software-api/view.json" data="usersRolesAccessControlAttributes" >}}

owner​

{{< api-section file="data/software-api/view.json" data="ownerAttributes" >}}

fields​

{{< api-section file="data/software-api/view.json" data="fieldsAttributes" >}}

type​

{{< api-section file="data/software-api/view.json" data="typeAttributes" >}}

subSchema​

{{< api-section file="data/api/tables.json" data="subSchemaAttributes" >}}

Creating a View​

Create a view from a table in Dremio.

{{< codeheader "Method and URL" >}}

POST /api/v3/catalog

Parameters​

{{< api-section file="data/software-api/view.json" data="createViewParameters" >}}

accessControlList​

{{< api-section file="data/software-api/view.json" data="createAccessControlListObjectParameters" >}}

users and roles​

{{< api-section file="data/software-api/view.json" data="createUsersRolesAccessControlParameters" >}}


{{< codeheader "Example Request" >}}

curl -X POST 'https://{hostname}/api/v3/catalog/' \
--header 'Authorization: _dremio{tokenstring}' \
--header 'Content-Type: application/json' \
--data-raw '{
  "entityType": "dataset",
  "path": [
    "Business",
    "Transportation",
    "NYC-taxi-trips-short-distance"
  ],
  "type": "VIRTUAL_DATASET",
  "sql": "SELECT * FROM \"NYC-taxi-trips\" WHERE trip_distance_mi <= 2.0 ORDER BY trip_distance_mi ASC",
  "sqlContext": [
    "Samples",
    "samples.dremio.com"
  ],
  "accessControlList": {
    "users": [
      {
        "id": "c590ed7f-b2b4-4e1f-ba7d-94173afdc9a3",
        "permissions": [
          "SELECT",
          "ALTER"
        ]
      },
      {
        "id": "30fca499-4abc-4469-7142-fc8dd29acac8",
        "permissions": [
          "SELECT",
          "ALTER",
          "MANAGE_GRANTS"
        ]
      }
    ],
    "roles": [
      {
        "id": "76a9884b-aea5-46d5-a73a-000edf23f390",
        "permissions": [
          "SELECT",
          "ALTER"
        ]
      }
    ]
  }
}'

{{< codeheader "Example Response" >}}

{
  "entityType": "dataset",
  "id": "ef99ab32-89ca-4d1c-9e91-2c8be861bb8a",
  "type": "VIRTUAL_DATASET",
  "path": [
    "Business",
    "Transportation",
    "NYC-taxi-trips-short-distance"
  ],
  "createdAt": "2022-11-17T18:31:23.236Z",
  "tag": "f90d1526-e64b-47b1-9ab0-d25df5247cab",
  "sql": "SELECT * FROM \"NYC-taxi-trips\" WHERE trip_distance_mi <= 2.0 ORDER BY trip_distance_mi ASC",
  "sqlContext": [
    "Samples",
    "samples.dremio.com"
  ],
  "accessControlList": {
    "users": [
      {
        "id": "c590ed7f-b2b4-4e1f-ba7d-94173afdc9a3",
        "permissions": [
          "SELECT",
          "ALTER"
        ]
      },
      {
        "id": "30fca499-4abc-4469-7142-fc8dd29acac8",
        "permissions": [
          "SELECT",
          "ALTER",
          "MANAGE_GRANTS"
        ]
      }
    ],
    "roles": [
      {
        "id": "76a9884b-aea5-46d5-a73a-000edf23f390",
        "permissions": [
          "SELECT",
          "ALTER"
        ]
      }
    ]
  },
  "owner": {
    "ownerId": "30fca499-4abc-4469-7142-fc8dd29acac8",
    "ownerType": "USER"
  },
  "fields": [
    {
      "name": "pickup_datetime",
      "type": {
        "name": "TIMESTAMP"
      }
    },
    {
      "name": "passenger_count",
      "type": {
        "name": "BIGINT"
      }
    },
    {
      "name": "passenger_payment_method",
      "type": {
        "name": "STRUCT",
        "subSchema": [
          {
            "name": "cash",
            "type": {
              "name": "BOOLEAN"
            }
          },
          {
            "name": "credit-debit",
            "type": {
              "name": "BOOLEAN"
            }
          },
          {
            "name": "payment-app",
            "type": {
              "name": "BOOLEAN"
            }
          },
          {
            "name": "other",
            "type": {
              "name": "BOOLEAN"
            }
          }
        ]
      }
    },
    {
      "name": "trip_distance_mi",
      "type": {
        "name": "DOUBLE"
      }
    },
    {
      "name": "fare_amount",
      "type": {
        "name": "DOUBLE"
      }
    },
    {
      "name": "tip_amount",
      "type": {
        "name": "DOUBLE"
      }
    },
    {
      "name": "total_amount",
      "type": {
        "name": "DOUBLE"
      }
    }
  ]
}

Response Status Codes​

{{< api-responses file="data/software-api/view.json" data="createViewResponseCodes" >}}

Retrieving a View by ID​

Retrieve a view by specifying the view's id value.

{{< codeheader "Method and URL" >}}

POST /api/v3/catalog/{id}

Parameters​

{{< api-section file="data/software-api/view.json" data="retrieveViewIdParameters" >}}


{{< codeheader "Example Request" >}}

curl -X GET 'https://{hostname}/api/v3/catalog/ef99ab32-89ca-4d1c-9e91-2c8be861bb8a' \
--header 'Authorization: _dremio{tokenstring}' \
--header 'Content-Type: application/json'

{{< codeheader "Example Response" >}}

{
  "entityType": "dataset",
  "id": "ef99ab32-89ca-4d1c-9e91-2c8be861bb8a",
  "type": "VIRTUAL_DATASET",
  "path": [
    "Business",
    "Transportation",
    "NYC-taxi-trips-short-distance"
  ],
  "createdAt": "2022-11-17T18:31:23.236Z",
  "tag": "f90d1526-e64b-47b1-9ab0-d25df5247cab",
  "sql": "SELECT * FROM \"NYC-taxi-trips\" WHERE trip_distance_mi <= 2.0 ORDER BY trip_distance_mi ASC",
  "sqlContext": [
    "Samples",
    "samples.dremio.com"
  ],
  "accessControlList": {
    "users": [
      {
        "id": "c590ed7f-b2b4-4e1f-ba7d-94173afdc9a3",
        "permissions": [
          "SELECT",
          "ALTER"
        ]
      },
      {
        "id": "30fca499-4abc-4469-7142-fc8dd29acac8",
        "permissions": [
          "SELECT",
          "ALTER",
          "MANAGE_GRANTS"
        ]
      }
    ],
    "roles": [
      {
        "id": "76a9884b-aea5-46d5-a73a-000edf23f390",
        "permissions": [
          "SELECT",
          "ALTER"
        ]
      }
    ]
  },
  "owner": {
    "ownerId": "30fca499-4abc-4469-7142-fc8dd29acac8",
    "ownerType": "USER"
  },
  "fields": [
    {
      "name": "pickup_datetime",
      "type": {
        "name": "TIMESTAMP"
      }
    },
    {
      "name": "passenger_count",
      "type": {
        "name": "BIGINT"
      }
    },
    {
      "name": "passenger_payment_method",
      "type": {
        "name": "STRUCT",
        "subSchema": [
          {
            "name": "cash",
            "type": {
              "name": "BOOLEAN"
            }
          },
          {
            "name": "credit-debit",
            "type": {
              "name": "BOOLEAN"
            }
          },
          {
            "name": "payment-app",
            "type": {
              "name": "BOOLEAN"
            }
          },
          {
            "name": "other",
            "type": {
              "name": "BOOLEAN"
            }
          }
        ]
      }
    },
    {
      "name": "trip_distance_mi",
      "type": {
        "name": "DOUBLE"
      }
    },
    {
      "name": "fare_amount",
      "type": {
        "name": "DOUBLE"
      }
    },
    {
      "name": "tip_amount",
      "type": {
        "name": "DOUBLE"
      }
    },
    {
      "name": "total_amount",
      "type": {
        "name": "DOUBLE"
      }
    }
  ]
}

Response Status Codes​

{{< api-responses file="data/software-api/view.json" data="retrieveViewIdResponseCodes" >}}

Retrieving a View by Path​

Retrieve a view by specifying the view's path.

{{< codeheader "Method and URL" >}}

GET /api/v3/catalog/by-path/{path}

Parameters​

{{< api-section file="data/software-api/view.json" data="retrieveViewPathParameters" >}}


{{< codeheader "Example Request" >}}

curl -X GET 'https://{hostname}/api/v3/catalog/by-path/Business/Transportation/NYC-taxi-trips-short-distance' \
--header 'Authorization: _dremio{tokenstring}' \
--header 'Content-Type: application/json'

{{< codeheader "Example Response" >}}

{
  "entityType": "dataset",
  "id": "ef99ab32-89ca-4d1c-9e91-2c8be861bb8a",
  "type": "VIRTUAL_DATASET",
  "path": [
    "Business",
    "Transportation",
    "NYC-taxi-trips-short-distance"
  ],
  "createdAt": "2022-11-17T18:31:23.236Z",
  "tag": "f90d1526-e64b-47b1-9ab0-d25df5247cab",
  "sql": "SELECT * FROM \"NYC-taxi-trips\" WHERE trip_distance_mi <= 2.0 ORDER BY trip_distance_mi ASC",
  "sqlContext": [
    "Samples",
    "samples.dremio.com"
  ],
  "accessControlList": {
    "users": [
      {
        "id": "c590ed7f-b2b4-4e1f-ba7d-94173afdc9a3",
        "permissions": [
          "SELECT",
          "ALTER"
        ]
      },
      {
        "id": "30fca499-4abc-4469-7142-fc8dd29acac8",
        "permissions": [
          "SELECT",
          "ALTER",
          "MANAGE_GRANTS"
        ]
      }
    ],
    "roles": [
      {
        "id": "76a9884b-aea5-46d5-a73a-000edf23f390",
        "permissions": [
          "SELECT",
          "ALTER"
        ]
      }
    ]
  },
  "owner": {
    "ownerId": "30fca499-4abc-4469-7142-fc8dd29acac8",
    "ownerType": "USER"
  },
  "fields": [
    {
      "name": "pickup_datetime",
      "type": {
        "name": "TIMESTAMP"
      }
    },
    {
      "name": "passenger_count",
      "type": {
        "name": "BIGINT"
      }
    },
    {
      "name": "passenger_payment_method",
      "type": {
        "name": "STRUCT",
        "subSchema": [
          {
            "name": "cash",
            "type": {
              "name": "BOOLEAN"
            }
          },
          {
            "name": "credit-debit",
            "type": {
              "name": "BOOLEAN"
            }
          },
          {
            "name": "payment-app",
            "type": {
              "name": "BOOLEAN"
            }
          },
          {
            "name": "other",
            "type": {
              "name": "BOOLEAN"
            }
          }
        ]
      }
    },
    {
      "name": "trip_distance_mi",
      "type": {
        "name": "DOUBLE"
      }
    },
    {
      "name": "fare_amount",
      "type": {
        "name": "DOUBLE"
      }
    },
    {
      "name": "tip_amount",
      "type": {
        "name": "DOUBLE"
      }
    },
    {
      "name": "total_amount",
      "type": {
        "name": "DOUBLE"
      }
    }
  ]
}

Response Status Codes​

{{< api-responses file="data/software-api/view.json" data="retrieveViewPathResponseCodes" >}}

Updating a View​

Update a view in Dremio.

{{< codeheader "Method and URL" >}}

PUT /api/v3/catalog/{id}

Parameters​

{{< api-section file="data/software-api/view.json" data="updateViewParameters" >}}

accessControlList​

{{< api-section file="data/software-api/view.json" data="updateAccessControlListObjectParameters" >}}

users and roles​

{{< api-section file="data/software-api/view.json" data="updateUsersRolesAccessControlParameters" >}}


{{< codeheader "Example Request" >}}

curl -X PUT 'https://{hostname}/api/v3/catalog/ef99ab32-89ca-4d1c-9e91-2c8be861bb8a' \
--header 'Authorization: _dremio{tokenstring}' \
--header 'Content-Type: application/json' \
--data-raw '{
  "entityType": "dataset",
  "id": "ef99ab32-89ca-4d1c-9e91-2c8be861bb8a",
  "path": [
    "Business",
    "Transportation",
    "NYC-taxi-trips-short-distance"
  ],
  "type": "VIRTUAL_DATASET",
  "tag": "f90d1526-e64b-47b1-9ab0-d25df5247cab",
  "sql": "SELECT trip_distance_mi, fare_amount, tip_amount FROM \"NYC-taxi-trips\" WHERE trip_distance_mi <= 2.0 ORDER BY trip_distance_mi DESC",
  "sqlContext": [
    "Samples",
    "samples.dremio.com"
  ]
}'

{{< codeheader "Example Response" >}}

{
  "entityType": "dataset",
  "id": "ef99ab32-89ca-4d1c-9e91-2c8be861bb8a",
  "type": "VIRTUAL_DATASET",
  "path": [
    "Business",
    "Transportation",
    "NYC-taxi-trips-by-distance"
  ],
  "createdAt": "2023-01-20T15:26:39.780Z",
  "tag": "7cab1a42-8835-4d31-827b-fedee1ad38d1",
  "sql": "SELECT trip_distance_mi, fare_amount, tip_amount FROM \"NYC-taxi-trips\" WHERE trip_distance_mi <= 2.0 ORDER BY trip_distance_mi DESC",
  "sqlContext": [
    "Samples",
    "samples.dremio.com"
  ],
  "accessControlList": {
    "users": [
      {
        "id": "c590ed7f-b2b4-4e1f-ba7d-94173afdc9a3",
        "permissions": [
          "SELECT",
          "ALTER"
        ]
      },
      {
        "id": "30fca499-4abc-4469-7142-fc8dd29acac8",
        "permissions": [
          "SELECT",
          "ALTER",
          "MANAGE_GRANTS"
        ]
      }
    ],
    "roles": [
      {
        "id": "76a9884b-aea5-46d5-a73a-000edf23f390",
        "permissions": [
          "SELECT",
          "ALTER"
        ]
      }
    ]
  },
  "owner": {
    "ownerId": "30fca499-4abc-4469-7142-fc8dd29acac8",
    "ownerType": "USER"
  },
  "fields": [
    {
      "name": "pickup_datetime",
      "type": {
        "name": "TIMESTAMP"
      }
    },
    {
      "name": "passenger_count",
      "type": {
        "name": "BIGINT"
      }
    },
    {
      "name": "passenger_payment_method",
      "type": {
        "name": "STRUCT",
        "subSchema": [
          {
            "name": "cash",
            "type": {
              "name": "BOOLEAN"
            }
          },
          {
            "name": "credit-debit",
            "type": {
              "name": "BOOLEAN"
            }
          },
          {
            "name": "payment-app",
            "type": {
              "name": "BOOLEAN"
            }
          },
          {
            "name": "other",
            "type": {
              "name": "BOOLEAN"
            }
          }
        ]
      }
    },
    {
      "name": "trip_distance_mi",
      "type": {
        "name": "DOUBLE"
      }
    },
    {
      "name": "fare_amount",
      "type": {
        "name": "DOUBLE"
      }
    },
    {
      "name": "tip_amount",
      "type": {
        "name": "DOUBLE"
      }
    },
    {
      "name": "total_amount",
      "type": {
        "name": "DOUBLE"
      }
    }
  ]
}

Response Status Codes​

{{< api-responses file="data/software-api/view.json" data="updateViewResponseCodes" >}}

Deleting a View​

Delete the specified view.

{{< codeheader "Method and URL" >}}

DELETE /api/v3/catalog/{id}

Parameters​

{{< api-section file="data/software-api/view.json" data="deleteViewParameters" >}}


{{< codeheader "Example Request" >}}

curl -X DELETE 'https://{hostname}/api/v3/catalog/ef99ab32-89ca-4d1c-9e91-2c8be861bb8a' \
-H 'Authorization: _dremio{tokenstring}' \
-H 'Content-Type: application/json'

{{< codeheader "Example Response" >}}

No response

Response Status Codes​

{{< api-responses file="data/software-api/view.json" data="deleteViewResponseCodes" >}}