List functions

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

List functions

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

Include detailed information about the functions

Responses

200

Returns the list of function objects if {details} is true, otherwise returns the list of function identifiers

application/vnd.gravitino.v1+json

Schema

Schema

oneOf

schema

code int32

Possible values: [0]

Status code of the response

identifiers

object[]

A list of NameIdentifier objects

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

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 data type of the parameter

oneOf

PrimitiveType

string

StructType

type stringrequired

Possible values: [struct]

fields

object[]

required

Array [

name stringrequired

The name of the struct field

type required

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 required

MapType

type stringrequired

Possible values: [map]

keyType required

valueType required

valueContainsNull booleannullable

Default value: true

Whether the value of the map contains null values

UnionType

type stringrequired

Possible values: [union]

types undefined[]required

UnparsedType

type stringrequired

Possible values: [unparsed]

unparsedType stringrequired

The unparsed type

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

oneOf

PrimitiveType

string

StructType

type stringrequired

Possible values: [struct]

fields

object[]

required

Array [

name stringrequired

The name of the struct field

type required

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 required

MapType

type stringrequired

Possible values: [map]

keyType required

valueType required

valueContainsNull booleannullable

Default value: true

Whether the value of the map contains null values

UnionType

type stringrequired

Possible values: [union]

types undefined[]required

UnparsedType

type stringrequired

Possible values: [unparsed]

unparsedType stringrequired

The unparsed type

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

The arguments of the function

]

returnType

object

The return type of the function (for SCALAR and AGGREGATE functions)

oneOf

PrimitiveType

string

StructType

type stringrequired

Possible values: [struct]

fields

object[]

required

Array [

name stringrequired

The name of the struct field

type required

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 required

MapType

type stringrequired

Possible values: [map]

keyType required

valueType required

valueContainsNull booleannullable

Default value: true

Whether the value of the map contains null values

UnionType

type stringrequired

Possible values: [union]

types undefined[]required

UnparsedType

type stringrequired

Possible values: [unparsed]

unparsedType stringrequired

The unparsed type

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 data type of the return column

oneOf

PrimitiveType

string

StructType

type stringrequired

Possible values: [struct]

fields

object[]

required

Array [

name stringrequired

The name of the struct field

type required

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 required

MapType

type stringrequired

Possible values: [map]

keyType required

valueType required

valueContainsNull booleannullable

Default value: true

Whether the value of the map contains null values

UnionType

type stringrequired

Possible values: [union]

types undefined[]required

UnparsedType

type stringrequired

Possible values: [unparsed]

unparsedType stringrequired

The unparsed type

comment stringnullable

The comment of the return column

]

impls

object[]

The implementations of the function definition

Array [

oneOf

SQLImpl

language stringrequired

Possible values: [SQL]

runtime stringrequired

Possible values: [SPARK, TRINO]

The runtime type of the implementation

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]

runtime stringrequired

Possible values: [SPARK, TRINO]

The runtime type of the implementation

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]

runtime stringrequired

Possible values: [SPARK, TRINO]

The runtime type of the implementation

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)

{}

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

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

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