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

metalake stringrequired

The name of the metalake

catalog stringrequired

The name of the catalog

schema stringrequired

The name of the schema

application/json

Body

name stringrequired

The name of the fileset. Can not be empty.

type stringnullable

The type of the fileset. The value of type should be EXTERNAL or MANAGED

comment stringnullable

The comment of the fileset. Can be empty.

storageLocation stringnullable

The location of the fileset. If the storage location of managed fileset is empty, it will \ use the location of namespace. The storage location of external fileset must be set.

storageLocations

object

nullable

The storage locations of the fileset. If the storage location of managed fileset is empty, \ it will use the location of namespace. The storage locations of external fileset must be set.

property name* string

properties

object

nullable

The properties of the fileset. Can be empty.

property name* string

Responses

200

The fileset, with its type, storage locations, comment, properties and audit information.

application/vnd.gravitino.v1+json

Schema

Schema

code int32

Possible values: [0]

Status code of the response

fileset

object

name stringrequired

The name of the fileset

type stringnullable

The type of the fileset

comment stringnullable

The comment of the fileset

storageLocation stringnullable

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.

property name* string

properties

object

nullable

The properties of the fileset

property name* string

audit

object

Audit information for a Gravitino resource.

creator string

The user who created the resource

createTime date-time

The time the resource was created

lastModifier string

The user who last modified the resource

lastModifiedTime date-time

The time the resource was last modified

Example (from schema)

{
  "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"
    }
  }
}

FilesetResponse

{
  "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"
    }
  }
}

409

A fileset with the same name already exists in the schema.

application/vnd.gravitino.v1+json

Schema

Schema

code integerrequired

Possible values: >= 1000 and <= 1100

HTTP response code

type stringrequired

Internal type definition of the error

message stringrequired

A human-readable message

stack string[]deprecated

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.

Example (from schema)

{
  "code": 1002,
  "type": "string",
  "message": "string"
}

FilesetAlreadyExistsErrorResponse

{
  "code": 1004,
  "type": "FilesetAlreadyExistsException",
  "message": "Fileset already exists",
  "stack": [
    "java.lang.FilesetAlreadyExistsException: Fileset already exists"
  ]
}

5xx

The server hit an internal error that the client usually cannot fix by changing the request.

application/vnd.gravitino.v1+json

Schema

Schema

code integerrequired

Possible values: >= 1000 and <= 1100

HTTP response code

type stringrequired

Internal type definition of the error

message stringrequired

A human-readable message

stack string[]deprecated

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.

Example (from schema)

{
  "code": 1002,
  "type": "string",
  "message": "string"
}

Example

{
  "code": 1002,
  "type": "RuntimeException",
  "message": "Internal Server Error",
  "stack": [
    "java.lang.RuntimeException: Internal Server Error"
  ]
}

Loading...