List functions

GET 
/metalakes/:metalake/catalogs/:catalog/schemas/:schema/functions

Returns the identifiers of the functions in the schema, or the full functions when details is true. When authorization is enabled, only the functions the caller owns or holds EXECUTE_FUNCTION or MODIFY_FUNCTION on are returned.

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

Query Parameters

details boolean

When true, returns the full function objects instead of their identifiers

Responses

200

The identifiers of the functions in the schema, or the full functions with their definitions when details is true.

application/vnd.gravitino.v1+json

Schema

Schema

oneOf

FunctionIdentifierListResponse

code int32

Possible values: [0]

Status code of the response

identifiers

object[]

The identifiers of the functions in the schema

Array [

namespace string[]required

The namespace of the entity may be with multiple levels

name stringrequired

The name of the entity

]

FunctionListResponse

code int32

Possible values: [0]

Status code of the response

functions

object[]

The list of function objects

Array [

name stringrequired

The name of the function

functionType stringrequired

Possible values: [scalar, aggregate, table]

The type of the function. Responses return the value in lowercase; requests accept any case.

deterministic boolean

Whether the function is deterministic

comment stringnullable

The comment of the function

definitions

object[]

required

The definitions of the function

Array [

parameters

object[]

The parameters of the function definition

Array [

name stringrequired

The name of the parameter

dataType

object

required

The general, read-compatible data type representation. UnparsedType preserves types that the current server cannot resolve when reading existing metadata. Endpoints that require resolved new metadata use WritableDataType instead.

oneOf

PrimitiveType

The string name of a primitive type, such as boolean, byte, byte unsigned, short, short unsigned, integer, integer unsigned, long, long unsigned, float, double, decimal(10,2), date, time(3), timestamp(3), timestamp_tz(3), string, char(10), varchar(10), interval_day, interval_year, uuid, fixed(16) or binary.

string

StructType

type stringrequired

Possible values: [struct]

fields

object[]

required

Array [

name stringrequired

The name of the struct field

type

object

required

A nested data type, in any form that DataType describes.

oneOf

MOD1

A primitive type, as in PrimitiveType

string

MOD2

A struct, list, map, union, unparsed or external type, as in DataType

object

nullable booleannullable

Default value: true

Whether the struct field is nullable

comment stringnullable

The comment of the struct field

]

ListType

type stringrequired

Possible values: [list]

containsNull booleannullable

Default value: true

Whether the list contains null values

elementType

object

required

A nested data type, in any form that DataType describes.

oneOf

MOD1

A primitive type, as in PrimitiveType

string

MOD2

A struct, list, map, union, unparsed or external type, as in DataType

object

MapType

type stringrequired

Possible values: [map]

keyType

object

required

A nested data type, in any form that DataType describes.

oneOf

MOD1

A primitive type, as in PrimitiveType

string

MOD2

A struct, list, map, union, unparsed or external type, as in DataType

object

valueType

object

required

A nested data type, in any form that DataType describes.

oneOf

MOD1

A primitive type, as in PrimitiveType

string

MOD2

A struct, list, map, union, unparsed or external type, as in DataType

object

valueContainsNull booleannullable

Default value: true

Whether the value of the map contains null values

UnionType

type stringrequired

Possible values: [union]

types

object[]

required

Array [

oneOf

MOD1

A primitive type, as in PrimitiveType

string

MOD2

A struct, list, map, union, unparsed or external type, as in DataType

object

]

UnparsedType

type stringrequired

Possible values: [unparsed]

unparsedType stringrequired

The unparsed type

ExternalType

type stringrequired

Possible values: [external]

catalogString stringrequired

The string representation of this type in the catalog

comment stringnullable

The comment of the parameter

defaultValue

object

The default value expression of the parameter

oneOf

Literal

type string

Possible values: [literal]

dataType

object

required

The general, read-compatible data type representation. UnparsedType preserves types that the current server cannot resolve when reading existing metadata. Endpoints that require resolved new metadata use WritableDataType instead.

oneOf

PrimitiveType

The string name of a primitive type, such as boolean, byte, byte unsigned, short, short unsigned, integer, integer unsigned, long, long unsigned, float, double, decimal(10,2), date, time(3), timestamp(3), timestamp_tz(3), string, char(10), varchar(10), interval_day, interval_year, uuid, fixed(16) or binary.

string

StructType

type stringrequired

Possible values: [struct]

fields

object[]

required

Array [

name stringrequired

The name of the struct field

type

object

required

A nested data type, in any form that DataType describes.

oneOf

MOD1

A primitive type, as in PrimitiveType

string

MOD2

A struct, list, map, union, unparsed or external type, as in DataType

object

nullable booleannullable

Default value: true

Whether the struct field is nullable

comment stringnullable

The comment of the struct field

]

ListType

type stringrequired

Possible values: [list]

containsNull booleannullable

Default value: true

Whether the list contains null values

elementType

object

required

A nested data type, in any form that DataType describes.

oneOf

MOD1

A primitive type, as in PrimitiveType

string

MOD2

A struct, list, map, union, unparsed or external type, as in DataType

object

MapType

type stringrequired

Possible values: [map]

keyType

object

required

A nested data type, in any form that DataType describes.

oneOf

MOD1

A primitive type, as in PrimitiveType

string

MOD2

A struct, list, map, union, unparsed or external type, as in DataType

object

valueType

object

required

A nested data type, in any form that DataType describes.

oneOf

MOD1

A primitive type, as in PrimitiveType

string

MOD2

A struct, list, map, union, unparsed or external type, as in DataType

object

valueContainsNull booleannullable

Default value: true

Whether the value of the map contains null values

UnionType

type stringrequired

Possible values: [union]

types

object[]

required

Array [

oneOf

MOD1

A primitive type, as in PrimitiveType

string

MOD2

A struct, list, map, union, unparsed or external type, as in DataType

object

]

UnparsedType

type stringrequired

Possible values: [unparsed]

unparsedType stringrequired

The unparsed type

ExternalType

type stringrequired

Possible values: [external]

catalogString stringrequired

The string representation of this type in the catalog

value stringrequired

The string format of the literal value

Field

type stringrequired

Possible values: [field]

fieldName string[]required

The name of the field, may be with multiple levels

Function

type stringrequired

Possible values: [function]

funcName stringrequired

The name of the function

funcArgs object[]required

The arguments of the function

]

returnType

object

The general, read-compatible data type representation. UnparsedType preserves types that the current server cannot resolve when reading existing metadata. Endpoints that require resolved new metadata use WritableDataType instead.

oneOf

PrimitiveType

The string name of a primitive type, such as boolean, byte, byte unsigned, short, short unsigned, integer, integer unsigned, long, long unsigned, float, double, decimal(10,2), date, time(3), timestamp(3), timestamp_tz(3), string, char(10), varchar(10), interval_day, interval_year, uuid, fixed(16) or binary.

string

StructType

type stringrequired

Possible values: [struct]

fields

object[]

required

Array [

name stringrequired

The name of the struct field

type

object

required

A nested data type, in any form that DataType describes.

oneOf

MOD1

A primitive type, as in PrimitiveType

string

MOD2

A struct, list, map, union, unparsed or external type, as in DataType

object

nullable booleannullable

Default value: true

Whether the struct field is nullable

comment stringnullable

The comment of the struct field

]

ListType

type stringrequired

Possible values: [list]

containsNull booleannullable

Default value: true

Whether the list contains null values

elementType

object

required

A nested data type, in any form that DataType describes.

oneOf

MOD1

A primitive type, as in PrimitiveType

string

MOD2

A struct, list, map, union, unparsed or external type, as in DataType

object

MapType

type stringrequired

Possible values: [map]

keyType

object

required

A nested data type, in any form that DataType describes.

oneOf

MOD1

A primitive type, as in PrimitiveType

string

MOD2

A struct, list, map, union, unparsed or external type, as in DataType

object

valueType

object

required

A nested data type, in any form that DataType describes.

oneOf

MOD1

A primitive type, as in PrimitiveType

string

MOD2

A struct, list, map, union, unparsed or external type, as in DataType

object

valueContainsNull booleannullable

Default value: true

Whether the value of the map contains null values

UnionType

type stringrequired

Possible values: [union]

types

object[]

required

Array [

oneOf

MOD1

A primitive type, as in PrimitiveType

string

MOD2

A struct, list, map, union, unparsed or external type, as in DataType

object

]

UnparsedType

type stringrequired

Possible values: [unparsed]

unparsedType stringrequired

The unparsed type

ExternalType

type stringrequired

Possible values: [external]

catalogString stringrequired

The string representation of this type in the catalog

returnColumns

object[]

nullable

The return columns of the function (for TABLE functions)

Array [

name stringrequired

The name of the return column

dataType

object

required

The general, read-compatible data type representation. UnparsedType preserves types that the current server cannot resolve when reading existing metadata. Endpoints that require resolved new metadata use WritableDataType instead.

oneOf

PrimitiveType

The string name of a primitive type, such as boolean, byte, byte unsigned, short, short unsigned, integer, integer unsigned, long, long unsigned, float, double, decimal(10,2), date, time(3), timestamp(3), timestamp_tz(3), string, char(10), varchar(10), interval_day, interval_year, uuid, fixed(16) or binary.

string

StructType

type stringrequired

Possible values: [struct]

fields

object[]

required

Array [

name stringrequired

The name of the struct field

type

object

required

A nested data type, in any form that DataType describes.

oneOf

MOD1

A primitive type, as in PrimitiveType

string

MOD2

A struct, list, map, union, unparsed or external type, as in DataType

object

nullable booleannullable

Default value: true

Whether the struct field is nullable

comment stringnullable

The comment of the struct field

]

ListType

type stringrequired

Possible values: [list]

containsNull booleannullable

Default value: true

Whether the list contains null values

elementType

object

required

A nested data type, in any form that DataType describes.

oneOf

MOD1

A primitive type, as in PrimitiveType

string

MOD2

A struct, list, map, union, unparsed or external type, as in DataType

object

MapType

type stringrequired

Possible values: [map]

keyType

object

required

A nested data type, in any form that DataType describes.

oneOf

MOD1

A primitive type, as in PrimitiveType

string

MOD2

A struct, list, map, union, unparsed or external type, as in DataType

object

valueType

object

required

A nested data type, in any form that DataType describes.

oneOf

MOD1

A primitive type, as in PrimitiveType

string

MOD2

A struct, list, map, union, unparsed or external type, as in DataType

object

valueContainsNull booleannullable

Default value: true

Whether the value of the map contains null values

UnionType

type stringrequired

Possible values: [union]

types

object[]

required

Array [

oneOf

MOD1

A primitive type, as in PrimitiveType

string

MOD2

A struct, list, map, union, unparsed or external type, as in DataType

object

]

UnparsedType

type stringrequired

Possible values: [unparsed]

unparsedType stringrequired

The unparsed type

ExternalType

type stringrequired

Possible values: [external]

catalogString stringrequired

The string representation of this type in the catalog

comment stringnullable

The comment of the return column

]

impls

object[]

The implementations of the function definition

Array [

oneOf

SQLImpl

language stringrequired

Possible values: [SQL]

The implementation language. The server matches the value exactly, in uppercase, in both requests and responses.

runtime stringrequired

Possible values: [SPARK, TRINO]

The runtime type of the implementation. Responses return the value in uppercase; requests accept any case.

sql stringrequired

The SQL expression

resources

object

External resources required by a function implementation

jars string[]nullable

JAR file URIs

files string[]nullable

File URIs

archives string[]nullable

Archive URIs

properties

object

nullable

Additional properties

property name* string

JavaImpl

language stringrequired

Possible values: [JAVA]

The implementation language. The server matches the value exactly, in uppercase, in both requests and responses.

runtime stringrequired

Possible values: [SPARK, TRINO]

The runtime type of the implementation. Responses return the value in uppercase; requests accept any case.

className stringrequired

The fully qualified class name

resources

object

External resources required by a function implementation

jars string[]nullable

JAR file URIs

files string[]nullable

File URIs

archives string[]nullable

Archive URIs

properties

object

nullable

Additional properties

property name* string

PythonImpl

language stringrequired

Possible values: [PYTHON]

The implementation language. The server matches the value exactly, in uppercase, in both requests and responses.

runtime stringrequired

Possible values: [SPARK, TRINO]

The runtime type of the implementation. Responses return the value in uppercase; requests accept any case.

handler stringnullable

The Python handler function

codeBlock stringnullable

The Python code block

resources

object

External resources required by a function implementation

jars string[]nullable

JAR file URIs

files string[]nullable

File URIs

archives string[]nullable

Archive URIs

properties

object

nullable

Additional properties

property name* string

]

]

audit

object

required

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)

{}

FunctionIdentifierListResponse

{
  "code": 0,
  "identifiers": [
    {
      "namespace": [
        "my_metalake",
        "my_catalog",
        "my_schema"
      ],
      "name": "add_one"
    }
  ]
}

FunctionListResponse

{
  "code": 0,
  "functions": [
    {
      "name": "add_one",
      "functionType": "scalar",
      "deterministic": true,
      "comment": "A simple scalar function",
      "definitions": [
        {
          "parameters": [
            {
              "name": "x",
              "dataType": "integer"
            }
          ],
          "returnType": "integer",
          "impls": [
            {
              "language": "SQL",
              "runtime": "SPARK",
              "sql": "x + 1"
            }
          ]
        }
      ],
      "audit": {
        "creator": "user1",
        "createTime": "2021-01-01T00:00:00Z"
      }
    }
  ]
}

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

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