List files

GET 
/metalakes/:metalake/catalogs/:catalog/schemas/:schema/filesets/:fileset/files

List metadata of files and directories in a fileset

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

Query Parameters

sub_path string

Default value: /

The sub path within the fileset to list files and directories from

location_name string

The name of the storage location

Responses

200

The response containing a list of file/directory metadata

application/vnd.gravitino.v1+json

Schema

Schema

code int32

Possible values: [0]

Status code of the response

files

object[]

Array [

name stringrequired

The name of the file/directory

isDir booleanrequired

Whether this is a directory

size int64required

The file size in bytes (0 if directory)

lastModified int64required

The last modification time of the file/directory

path stringrequired

The gvfs path of the file/directory

]

Example (from schema)

{
  "code": 0,
  "files": [
    {
      "name": "string",
      "isDir": true,
      "size": 0,
      "lastModified": 0,
      "path": "string"
    }
  ]
}

FileInfoListResponse

{
  "code": 0,
  "files": [
    {
      "name": "file.txt",
      "isDir": false,
      "size": 5,
      "lastModified": 1748875070123,
      "path": "/fileset/catalog1/schema1/fileset1/file.txt"
    },
    {
      "name": "sub_dir",
      "isDir": true,
      "size": 0,
      "lastModified": 1748875070124,
      "path": "/fileset/catalog1/schema1/fileset1/sub_dir"
    }
  ]
}

404

Not Found – the target fileset or subPath or locationName 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"
  ]
}

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

Loading...