Create fileset
POST/metalakes/:metalake/catalogs/:catalog/schemas/:schema/filesets
Creates a fileset in the schema and returns it. An external fileset must have a storage location, while a managed fileset without one gets a location derived from the schema or catalog location property.
Sign in with a bearer token or a local user's password; see Authentication.
Request
Path Parameters
The name of the metalake
The name of the catalog
The name of the schema
- application/json
Body
The name of the fileset. Can not be empty.
The type of the fileset. The value of type should be EXTERNAL or MANAGED
The comment of the fileset. Can be empty.
The storage location named unknown. A managed fileset can leave it out and take its locations from its schema and catalog. An external fileset must give at least one location. When both this and storageLocations are set, this one replaces storageLocations["unknown"].
storageLocations
object
nullable
The fileset's storage locations by name. Each name resolves on its own: a location here replaces the schema location of the same name, which replaces the catalog's, and names given only by the schema or catalog are inherited. A managed fileset can leave this out.
properties
object
nullable
The properties of the fileset. When the fileset ends up with more than one location, counting inherited ones, default-location-name must name one of them or the request returns 400.
The location used when none is named. Required with several locations; with one, the server fills it in.
Responses
- 200
- 400
- 403
- 406
- 409
- 5xx
The fileset, with its type, storage locations, comment, properties and audit information.
- application/vnd.gravitino.v1+json
- Schema
- Example (from schema)
- FilesetResponse
Schema
Possible values: [0]
Status code of the response
fileset
object
The name of the fileset
The type of the fileset
The comment of the fileset
The location of the fileset
storageLocations
object
The fileset's storage locations by location name. A location created without a name is listed as unknown.
properties
object
nullable
The properties of the fileset
audit
object
Audit information for a Gravitino resource.
The user who created the resource
The time the resource was created
The user who last modified the resource
The time the resource was last modified
{
"code": 0,
"fileset": {
"name": "string",
"type": "string",
"comment": "string",
"storageLocation": "string",
"storageLocations": {},
"properties": {},
"audit": {
"creator": "string",
"createTime": "2024-07-29T15:51:28.071Z",
"lastModifier": "string",
"lastModifiedTime": "2024-07-29T15:51:28.071Z"
}
}
}
{
"code": 0,
"fileset": {
"name": "fileset1",
"type": "managed",
"comment": "This is a comment",
"storageLocation": "hdfs://host/user/s_fileset/schema/fileset1",
"properties": {
"key1": "value1",
"key2": "value2"
}
}
}
The create request is invalid, for example because the fileset has several locations and default-location-name does not name one of them.
- application/vnd.gravitino.v1+json
- Schema
- Example (from schema)
- Example
Schema
Possible values: >= 1000 and <= 1100
HTTP response code
Internal type definition of the error
A human-readable message
Deprecated diagnostic stack trace. Enterprise omits it by default because it can expose internal implementation details. Operators can opt in for controlled diagnostics with gravitino.server.webserver.includeErrorStackTrace=true. See OWASP REST Security: Error handling and CWE-209.
{
"code": 1002,
"type": "string",
"message": "string"
}
{
"code": 1001,
"type": "IllegalArgumentException",
"message": "The fileset property default-location-name must be set and must be one of the fileset locations, location names: [primary, secondary], default location name: null"
}
The caller is not allowed to perform the operation. With authorization on, a metalake that does not exist, or that the caller is not a member of, also returns 403.
- application/vnd.gravitino.v1+json
- Schema
- Example (from schema)
- Example
Schema
Possible values: >= 1000 and <= 1100
HTTP response code
Internal type definition of the error
A human-readable message
Deprecated diagnostic stack trace. Enterprise omits it by default because it can expose internal implementation details. Operators can opt in for controlled diagnostics with gravitino.server.webserver.includeErrorStackTrace=true. See OWASP REST Security: Error handling and CWE-209.
{
"code": 1002,
"type": "string",
"message": "string"
}
{
"code": 1008,
"type": "ForbiddenException",
"message": "Current user alice is not a member of metalake metalake1, or the metalake does not exist"
}
The requested API version is not supported, or the operation cannot answer in the type the Accept header asks for. When Accept names no Gravitino API version, as with application/json, */*, or no header, the server takes the version from Content-Type if present, and the default version otherwise.
- application/vnd.gravitino.v1+json
- Schema
- Example (from schema)
- Example
Schema
Possible values: >= 1000 and <= 1100
HTTP response code
Internal type definition of the error
A human-readable message
Deprecated diagnostic stack trace. Enterprise omits it by default because it can expose internal implementation details. Operators can opt in for controlled diagnostics with gravitino.server.webserver.includeErrorStackTrace=true. See OWASP REST Security: Error handling and CWE-209.
{
"code": 1002,
"type": "string",
"message": "string"
}
{
"code": 1001,
"type": "IllegalArgumentException",
"message": "Unsupported version v99 in request header"
}
A fileset with the same name already exists in the schema.
- application/vnd.gravitino.v1+json
- Schema
- Example (from schema)
- FilesetAlreadyExistsErrorResponse
Schema
Possible values: >= 1000 and <= 1100
HTTP response code
Internal type definition of the error
A human-readable message
Deprecated diagnostic stack trace. Enterprise omits it by default because it can expose internal implementation details. Operators can opt in for controlled diagnostics with gravitino.server.webserver.includeErrorStackTrace=true. See OWASP REST Security: Error handling and CWE-209.
{
"code": 1002,
"type": "string",
"message": "string"
}
{
"code": 1004,
"type": "FilesetAlreadyExistsException",
"message": "Fileset already exists",
"stack": [
"java.lang.FilesetAlreadyExistsException: Fileset already exists"
]
}
The server hit an internal error that the client usually cannot fix by changing the request.
- application/vnd.gravitino.v1+json
- Schema
- Example (from schema)
- Example
Schema
Possible values: >= 1000 and <= 1100
HTTP response code
Internal type definition of the error
A human-readable message
Deprecated diagnostic stack trace. Enterprise omits it by default because it can expose internal implementation details. Operators can opt in for controlled diagnostics with gravitino.server.webserver.includeErrorStackTrace=true. See OWASP REST Security: Error handling and CWE-209.
{
"code": 1002,
"type": "string",
"message": "string"
}
{
"code": 1002,
"type": "RuntimeException",
"message": "Internal Server Error",
"stack": [
"java.lang.RuntimeException: Internal Server Error"
]
}