List files

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

Returns the files and directories directly under a path in a fileset, with the name, size, modification time and directory flag of each. Fails when the catalog sets disable-filesystem-ops to true.

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

Query Parameters

sub_path string

Default value: /

The path to list, relative to the fileset's storage location

location_name string

The name of the storage location to list. Defaults to the fileset's only location, or to the location named by its default-location-name property when it has several.

Responses

200

The files and directories directly under the path, each with its name, directory flag, size, modification time and virtual file path.

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

The metalake, catalog, schema or fileset does not exist, or the fileset has no storage location with the given location_name.

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

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...