update-datahub-dataset

dci update-datahub-dataset name

Updates an existing DataHub dataset's metadata. Only the description field can be updated. The dataset name is immutable and serves as the resource identifier. To rename a dataset, delete it and create a new one. If name is included in the request body, it must match the dataset name in the URL path. A mismatched name will be rejected with a 400 error.

Request

Content-Type: application/json

Schema

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "type": "string",
      "description": "Must match the dataset name in the URL path. Included for idempotency; the name cannot be changed.",
      "example": "My Custom Dataset"
    },
    "description": {
      "type": "string",
      "description": "The new description for the dataset.",
      "example": "Updated description for the dataset"
    }
  }
}

Output

OK - Dataset updated successfully.

By default dci renders the result as a table. Use --output json to get the full structure described below — see Output formats.

Field	Type	Description
name	string	The name of the dataset.
description	string	The description of the dataset.
records	integer (int64)	The number of records in the dataset.
updatedBy	string	The email of the user who last updated the dataset.
lastUpdated	string	The timestamp of the last update.

Raw JSON schema

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the dataset.",
      "example": "My Custom Dataset"
    },
    "description": {
      "type": "string",
      "description": "The description of the dataset.",
      "example": "Updated description for the dataset"
    },
    "records": {
      "type": "integer",
      "format": "int64",
      "description": "The number of records in the dataset.",
      "example": 1500,
      "nullable": true
    },
    "updatedBy": {
      "type": "string",
      "description": "The email of the user who last updated the dataset.",
      "example": "[email protected]"
    },
    "lastUpdated": {
      "type": "string",
      "description": "The timestamp of the last update.",
      "example": "2024-03-10T23:00:00Z"
    }
  }
}

Errors

On failure, dci prints a single error message — with a hint when one is available — and exits with a typed code your scripts can branch on. See Errors and exit codes for the full contract.

HTTP status	Exit code	Error code	Meaning
400	30	VALIDATION_ERROR	The arguments or request body were rejected. Review the command's flags and payload.
401	10	AUTHENTICATION_FAILED	Not signed in, or the API token is invalid. Run dci login or check DCI_API_KEY.
403	11	PERMISSION_DENIED	The DoiT user or the active customer context does not have access.
404	20	RESOURCE_NOT_FOUND	The requested resource does not exist. Check the identifier argument.
500	40	API_SERVER_ERROR	The API failed to process the request. Retryable; contact DoiT support if it persists.

Aliases: updatedatahubdataset