Dataset Microservices (Deprecated)

The CDAP Dataset Microservices allows you to interact with datasets through HTTP. You can list, create, delete, and truncate datasets.

All methods or endpoints described in this API have a base URL (typically http://<host>:11015 or https://<host>:10443) that precedes the resource identifier, as described in the Microservices Conventions. These methods return a status code, as listed in the Microservices Status Codes.

Listing all Datasets

You can list all datasets in CDAP by issuing an HTTP GET request to the URL:

The response body will contain a JSON-formatted list of the existing datasets:

Creating a Dataset

You can create a dataset by issuing an HTTP PUT request to the URL:

with JSON-formatted name of the dataset type, properties, and description in a body:

HTTP Responses

Example

Properties of an Existing Dataset

You can retrieve the properties with which a dataset was created or last updated by issuing an HTTP GET request to the URL:

HTTP Responses

The response, if successful, will contain the JSON-formatted properties:

Note that this returns the original properties that were submitted when the dataset was created or updated. You can use these properties to create a clone of the dataset, or as a basis for updating some properties of this dataset without modifying the remaining properties.

Metadata of an Existing Dataset

You can retrieve the metadata with which a dataset was created by issuing an HTTP GET request to the URL:

HTTP Responses

The response body will contain JSON-formatted metadata of the existing dataset:

Updating an Existing Dataset

You can update an existing dataset's table and properties by issuing an HTTP PUT request to the URL:

with JSON-formatted properties in the body:

Notes:

• The dataset must already exist.

• The properties given in this request replace all existing properties; that is, if you have set other properties for this table, such as time-to-live (dataset.table.ttl), you must also include those properties in the update request.

• You can retrieve the existing properties using the Properties of an Existing Dataset and use that as the basis for constructing your request.

• Once a dataset has been created, the principal cannot be changed.

HTTP Responses

Example

Deleting a Dataset

You can delete a dataset by issuing an HTTP DELETE request to the URL:

HTTP Responses

Example

Deleting all Datasets

If the property enable.unrecoverable.reset in cdap-site.xml is set to true, you can delete all Datasets (in a namespace) by issuing an HTTP DELETE request to the URL:

HTTP Responses

This command will only work if all programs in the namespace are not running.

If the property enable.unrecoverable.reset in cdap-site.xml is not set to true, this operation will return a Status Code 403 Forbidden. Note that this operation can only be performed if all programs are stopped. If there's at least one program that is running, this operation will return a Status Code 409 Conflict.

This method must be exercised with extreme caution, as there is no recovery from it.

Truncating a Dataset

You can truncate a dataset by issuing an HTTP POST request to the URL:

This will clear the existing data from the dataset. This cannot be undone.

HTTP Responses

Datasets used by an Application

You can retrieve a list of datasets used by an application by issuing a HTTP GET request to the URL:

HTTP Responses

Datasets used by a Program

You can retrieve a list of datasets used by a program by issuing a HTTP GET request to the URL:

HTTP Responses

Programs using a Dataset

You can retrieve a list of programs that are using a dataset by issuing a HTTP GET request to the URL:

HTTP Responses