Update fileset

PUT 
http://localhost:8090/api/metalakes/:metalake/catalogs/:catalog/schemas/:schema/filesets/:fileset

Updates the specified fileset in a schema

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 response of fileset object

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

properties

object

nullable

The properties of the fileset

property name* string

Example (from schema)

{
  "code": 0,
  "fileset": {
    "name": "string",
    "type": "string",
    "comment": "string",
    "storageLocation": "string",
    "properties": {}
  }
}

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

Indicates a bad request error. It could be caused by an unexpected request body format or other forms of request validation failure, such as invalid json. Usually serves application/json content, although in some cases simple text/plain content might be returned by the server's middleware.

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[]

Example (from schema)

{
  "code": 1002,
  "type": "string",
  "message": "string",
  "stack": [
    "string"
  ]
}

Example

{
  "code": 1003,
  "type": "BadRequestException",
  "message": "Malformed request"
}

404

Not Found - The target 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[]

Example (from schema)

{
  "code": 1002,
  "type": "string",
  "message": "string",
  "stack": [
    "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

Conflict - The target fileset already exists

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[]

Example (from schema)

{
  "code": 1002,
  "type": "string",
  "message": "string",
  "stack": [
    "string"
  ]
}

FilesetAlreadyExistsErrorResponse

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

5xx

A server-side problem that might not be addressable from the client side. Used for server 5xx errors without more specific documentation in individual routes.

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[]

Example (from schema)

{
  "code": 1002,
  "type": "string",
  "message": "string",
  "stack": [
    "string"
  ]
}

Example

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

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L -X PUT 'http://localhost:8090/api/metalakes/:metalake/catalogs/:catalog/schemas/:schema/filesets/:fileset' \
-H 'Content-Type: application/json' \
-H 'Accept: application/vnd.gravitino.v1+json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "updates": [
    {
      "@type": "rename",
      "newName": "newName"
    },
    {
      "@type": "setProperty",
      "property": "key",
      "value": "value"
    },
    {
      "@type": "updateComment",
      "newComment": "new comment"
    },
    {
      "@type": "removeProperty",
      "property": "key1"
    }
  ]
}'

Request Collapse all

Base URL

http://localhost:8090/api

Auth

Security Scheme

OAuth2WithJWTBasicAuth

Bearer Token

Parameters

metalake — pathrequired

catalog — pathrequired

schema — pathrequired

fileset — pathrequired

Body

{
  "updates": [
    {
      "@type": "rename",
      "newName": "newName"
    },
    {
      "@type": "setProperty",
      "property": "key",
      "value": "value"
    },
    {
      "@type": "updateComment",
      "newComment": "new comment"
    },
    {
      "@type": "removeProperty",
      "property": "key1"
    }
  ]
}

ResponseClear

Click the Send API Request button above and see the response here!