@hasura/metadata-api/dist/models/CitusCustomSQLMetadata.d.ts

Hasura GraphQL Engine Metadata API types

import type { CustomSQLParameter } from './CustomSQLParameter';
import type { PostgresQualified_TableName } from './PostgresQualified_TableName';
/**
 * A custom SQL function to add to the GraphQL schema with configuration.
 *
 * https://hasura.io/docs/latest/graphql/core/api-reference/schema-metadata-api/custom-functions.html#args-syntax
 *
 */
export type CitusCustomSQLMetadata = {
    /**
     * Function parameters and their types
     */
    parameters: Array<CustomSQLParameter>;
    /**
     * Return type of function
     */
    returns: (PostgresQualified_TableName | string);
    /**
     * Field name for custom SQL
     */
    root_field_name: string;
    /**
     * SQL to run
     */
    sql: string;
    /**
     * Type of SQL statement to run
     */
    type: string;
};