Update fileset

PUT 
/metalakes/:metalake/catalogs/:catalog/schemas/:schema/filesets/:fileset

Applies the requested changes to a fileset and returns the updated fileset.

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

fileset stringrequired

The name of the fileset

application/json

Body

updates

object[]

required

Array [

oneOf

RenameFilesetRequest

@type stringrequired

Possible values: [rename]

The type of the update

newName stringrequired

The new name of the fileset

SetFilesetPropertyRequest

@type stringrequired

Possible values: [setProperty]

The type of the update

property stringrequired

The name of the property to set

value stringrequired

The value of the property to set

UpdateFilesetCommentRequest

@type stringrequired

Possible values: [updateComment]

The type of the update

newComment stringrequired

The new comment of the fileset

RemoveFilesetPropertyRequest

@type stringrequired

Possible values: [removeProperty]

The type of the update

property stringrequired

The property to remove

]

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

400

The request is malformed or fails validation, for example because of invalid JSON, a missing required field or an invalid parameter value. The body is normally an error model, although the server's middleware can return plain text instead.

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": 1003,
  "type": "BadRequestException",
  "message": "Malformed request"
}

404

The metalake, catalog, schema or fileset does not exist.

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

NoSuchMetalakeException

{
  "code": 1003,
  "type": "NoSuchMetalakeException",
  "message": "Failed to operate metalake(s) [test] operation [LOAD], reason [NoSuchMetalakeException]",
  "stack": [
    "org.apache.gravitino.exceptions.NoSuchMetalakeException: Metalake test does not exist",
    "..."
  ]
}

NoSuchCatalogException

{
  "code": 1003,
  "type": "NoSuchCatalogException",
  "message": "Failed to operate catalog(s) [test] operation [LOAD] under metalake [my_test_metalake], reason [NoSuchCatalogException]",
  "stack": [
    "org.apache.gravitino.exceptions.NoSuchCatalogException: Catalog my_test_metalake.test does not exist",
    "..."
  ]
}

NoSuchSchemaException

{
  "code": 1003,
  "type": "NoSuchSchemaException",
  "message": "Failed to operate schema(s) [my_hive_schema1] operation [LOAD] under catalog [my_hive_catalog], reason [NoSuchSchemaException]",
  "stack": [
    "org.apache.gravitino.exceptions.NoSuchSchemaException: Hive schema (database) does not exist: my_hive_schema1 in Hive Metastore",
    "..."
  ]
}

NoSuchFilesetException

{
  "code": 1003,
  "type": "NoSuchFilesetException",
  "message": "Fileset does not exist",
  "stack": [
    "java.lang.NoSuchFilesetException: Fileset does not exist"
  ]
}

409

A fileset with the new 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...