Safe Haskell	None
Language	Haskell2010

Hasura.Backends.BigQuery.Meta

Synopsis

data MetadataError = RestProblem RestProblem
data RestProblem
- = GetTablesProblem SomeException
- | GetTableProblem SomeException
- | GetRoutineProblem SomeException
- | GetMetaDecodeProblem String
- | GetTablesBigQueryProblem BigQueryProblem
- | GetRoutinesBigQueryProblem BigQueryProblem
- | RESTRequestNonOK Status
data RestTableList = RestTableList {
- nextPageToken :: Maybe Text
- tables :: [RestTableBrief]
}
data RestTableBrief = RestTableBrief {
- tableReference :: RestTableReference
}
data RestTableReference = RestTableReference {
- datasetId :: Text
- projectId :: Text
- tableId :: Text
}
data RestTable = RestTable {
- tableReference :: RestTableReference
- schema :: RestTableSchema
}
data RestTableSchema = RestTableSchema {
- fields :: [RestFieldSchema]
}
data RestFieldSchema = RestFieldSchema {
- name :: Text
- type' :: RestType
- mode :: Mode
}
data Mode
- = Nullable
- | Required
- | Repeated
data RestType
- = STRING
- | BYTES
- | INTEGER
- | FLOAT
- | BOOL
- | TIMESTAMP
- | DATE
- | TIME
- | DATETIME
- | GEOGRAPHY
- | DECIMAL
- | BIGDECIMAL
- | STRUCT
getTables :: MonadIO m => BigQuerySourceConfig -> m (Either RestProblem [RestTable])
getTablesForDataSet :: MonadIO m => BigQueryConnection -> Text -> m (Either RestProblem [RestTable])
getTable :: MonadIO m => BigQueryConnection -> Text -> Text -> m (Either RestProblem RestTable)
encodeParams :: [(Text, Text)] -> Text
data RestRoutineType
- = ROUTINE_TYPE_UNSPECIFIED
- | SCALAR_FUNCTION
- | PROCEDURE
- | TABLE_VALUED_FUNCTION
data RestArgument = RestArgument {
- _raName :: Maybe Text
- _raDataType :: Maybe RestType
}
data RestStandardSqlField = RestStandardSqlField {
- _rssfName :: Maybe Text
- _rssType :: Maybe RestType
}
data RestStandardSqlTableType = RestStandardSqlTableType {
- _rrttColumns :: [RestStandardSqlField]
}
data RestRoutineReference = RestRoutineReference {
- datasetId :: Text
- projectId :: Text
- routineId :: Text
}
routineReferenceToFunctionName :: RestRoutineReference -> FunctionName
data RestRoutine = RestRoutine {
- routineReference :: RestRoutineReference
- routineType :: RestRoutineType
- arguments :: Maybe [RestArgument]
- returnTableType :: Maybe RestStandardSqlTableType
}
data RestRoutineList = RestRoutineList {
- _rrlRoutines :: [RestRoutine]
- _rrlNextPageToken :: Maybe Text
}
getRoutines :: MonadIO m => BigQuerySourceConfig -> m (Either RestProblem [RestRoutine])
getRoutinesForDataSet :: MonadIO m => BigQueryConnection -> Text -> m (Either RestProblem [RestRoutine])

Documentation

data MetadataError Source #

Constructors

RestProblem RestProblem

Instances

Instances details

Show MetadataError Source #
Instance details Defined in Hasura.Backends.BigQuery.Meta Methods showsPrec :: Int -> MetadataError -> ShowS # show :: MetadataError -> String # showList :: [MetadataError] -> ShowS #

data RestProblem Source #

Constructors

GetTablesProblem SomeException
GetTableProblem SomeException
GetRoutineProblem SomeException
GetMetaDecodeProblem String
GetTablesBigQueryProblem BigQueryProblem
GetRoutinesBigQueryProblem BigQueryProblem
RESTRequestNonOK Status

data RestTableList Source #

Constructors

RestTableList
Fields nextPageToken :: Maybe Text tables :: [RestTableBrief]

data RestTableBrief Source #

Constructors

RestTableBrief
Fields tableReference :: RestTableReference

data RestTableReference Source #

Constructors

RestTableReference
Fields datasetId :: Text projectId :: Text tableId :: Text

Instances

Instances details

Show RestTableReference Source #
Instance details Defined in Hasura.Backends.BigQuery.Meta Methods showsPrec :: Int -> RestTableReference -> ShowS # show :: RestTableReference -> String # showList :: [RestTableReference] -> ShowS #
Generic RestTableReference Source #
Instance details Defined in Hasura.Backends.BigQuery.Meta Associated Types type Rep RestTableReference :: Type -> Type # Methods from :: RestTableReference -> Rep RestTableReference x # to :: Rep RestTableReference x -> RestTableReference #
FromJSON RestTableReference Source #
Instance details Defined in Hasura.Backends.BigQuery.Meta Methods parseJSON :: Value -> Parser RestTableReference parseJSONList :: Value -> Parser [RestTableReference]
type Rep RestTableReference Source #
Instance details Defined in Hasura.Backends.BigQuery.Meta type Rep RestTableReference = D1 ('MetaData "RestTableReference" "Hasura.Backends.BigQuery.Meta" "graphql-engine-1.0.0-inplace" 'False) (C1 ('MetaCons "RestTableReference" 'PrefixI 'True) (S1 ('MetaSel ('Just "datasetId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "projectId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "tableId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

data RestTable Source #

Constructors

RestTable
Fields tableReference :: RestTableReference schema :: RestTableSchema

Instances

Instances details

Show RestTable Source #
Instance details Defined in Hasura.Backends.BigQuery.Meta Methods showsPrec :: Int -> RestTable -> ShowS # show :: RestTable -> String # showList :: [RestTable] -> ShowS #
Generic RestTable Source #
Instance details Defined in Hasura.Backends.BigQuery.Meta Associated Types type Rep RestTable :: Type -> Type # Methods from :: RestTable -> Rep RestTable x # to :: Rep RestTable x -> RestTable #
FromJSON RestTable Source #
Instance details Defined in Hasura.Backends.BigQuery.Meta Methods parseJSON :: Value -> Parser RestTable parseJSONList :: Value -> Parser [RestTable]
type Rep RestTable Source #
Instance details Defined in Hasura.Backends.BigQuery.Meta type Rep RestTable = D1 ('MetaData "RestTable" "Hasura.Backends.BigQuery.Meta" "graphql-engine-1.0.0-inplace" 'False) (C1 ('MetaCons "RestTable" 'PrefixI 'True) (S1 ('MetaSel ('Just "tableReference") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 RestTableReference) :*: S1 ('MetaSel ('Just "schema") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 RestTableSchema)))

data RestTableSchema Source #

Constructors

RestTableSchema
Fields fields :: [RestFieldSchema]

Instances

Instances details

Show RestTableSchema Source #
Instance details Defined in Hasura.Backends.BigQuery.Meta Methods showsPrec :: Int -> RestTableSchema -> ShowS # show :: RestTableSchema -> String # showList :: [RestTableSchema] -> ShowS #
Generic RestTableSchema Source #
Instance details Defined in Hasura.Backends.BigQuery.Meta Associated Types type Rep RestTableSchema :: Type -> Type # Methods from :: RestTableSchema -> Rep RestTableSchema x # to :: Rep RestTableSchema x -> RestTableSchema #
FromJSON RestTableSchema Source #
Instance details Defined in Hasura.Backends.BigQuery.Meta Methods parseJSON :: Value -> Parser RestTableSchema parseJSONList :: Value -> Parser [RestTableSchema]
type Rep RestTableSchema Source #
Instance details Defined in Hasura.Backends.BigQuery.Meta type Rep RestTableSchema = D1 ('MetaData "RestTableSchema" "Hasura.Backends.BigQuery.Meta" "graphql-engine-1.0.0-inplace" 'False) (C1 ('MetaCons "RestTableSchema" 'PrefixI 'True) (S1 ('MetaSel ('Just "fields") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [RestFieldSchema])))

data RestFieldSchema Source #

Constructors

RestFieldSchema
Fields name :: Text type' :: RestType The field data type. Possible values include STRING, BYTES, INTEGER, INT64 (same as INTEGER), FLOAT, FLOAT64 (same as FLOAT), BOOLEAN, BOOL (same as BOOLEAN), TIMESTAMP, DATE, TIME, DATETIME, GEOGRAPHY, NUMERIC, RECORD (where RECORD indicates that the field contains a nested schema) or STRUCT (same as RECORD). mode :: Mode

Instances

Instances details

Show RestFieldSchema Source #
Instance details Defined in Hasura.Backends.BigQuery.Meta Methods showsPrec :: Int -> RestFieldSchema -> ShowS # show :: RestFieldSchema -> String # showList :: [RestFieldSchema] -> ShowS #
Generic RestFieldSchema Source #
Instance details Defined in Hasura.Backends.BigQuery.Meta Associated Types type Rep RestFieldSchema :: Type -> Type # Methods from :: RestFieldSchema -> Rep RestFieldSchema x # to :: Rep RestFieldSchema x -> RestFieldSchema #
FromJSON RestFieldSchema Source #
Instance details Defined in Hasura.Backends.BigQuery.Meta Methods parseJSON :: Value -> Parser RestFieldSchema parseJSONList :: Value -> Parser [RestFieldSchema]
type Rep RestFieldSchema Source #
Instance details Defined in Hasura.Backends.BigQuery.Meta type Rep RestFieldSchema = D1 ('MetaData "RestFieldSchema" "Hasura.Backends.BigQuery.Meta" "graphql-engine-1.0.0-inplace" 'False) (C1 ('MetaCons "RestFieldSchema" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 RestType) :: S1 ('MetaSel ('Just "mode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Mode))))

data Mode Source #

Constructors

Nullable
Required
Repeated

Instances

Instances details

Show Mode Source #
Instance details Defined in Hasura.Backends.BigQuery.Meta Methods showsPrec :: Int -> Mode -> ShowS # show :: Mode -> String # showList :: [Mode] -> ShowS #
FromJSON Mode Source #
Instance details Defined in Hasura.Backends.BigQuery.Meta Methods parseJSON :: Value -> Parser Mode parseJSONList :: Value -> Parser [Mode]

data RestType Source #

Constructors

STRING
BYTES
INTEGER
FLOAT
BOOL
TIMESTAMP
DATE
TIME
DATETIME
GEOGRAPHY
DECIMAL
BIGDECIMAL
STRUCT

Instances

Instances details

Show RestType Source #
Instance details Defined in Hasura.Backends.BigQuery.Meta Methods showsPrec :: Int -> RestType -> ShowS # show :: RestType -> String # showList :: [RestType] -> ShowS #
FromJSON RestType Source #
Instance details Defined in Hasura.Backends.BigQuery.Meta Methods parseJSON :: Value -> Parser RestType parseJSONList :: Value -> Parser [RestType]

getTables :: MonadIO m => BigQuerySourceConfig -> m (Either RestProblem [RestTable]) Source #

Get all tables from all specified data sets.

getTablesForDataSet :: MonadIO m => BigQueryConnection -> Text -> m (Either RestProblem [RestTable]) Source #

Get tables in the dataset.

getTable :: MonadIO m => BigQueryConnection -> Text -> Text -> m (Either RestProblem RestTable) Source #

Get tables in the schema.

encodeParams :: [(Text, Text)] -> Text Source #

data RestRoutineType Source #

The fine-grained type of the routine Ref: https://cloud.google.com/bigquery/docs/reference/rest/v2/routines#RoutineType

Constructors

ROUTINE_TYPE_UNSPECIFIED
SCALAR_FUNCTION
PROCEDURE
TABLE_VALUED_FUNCTION

Instances

Instances details

Eq RestRoutineType Source #
Instance details Defined in Hasura.Backends.BigQuery.Meta Methods (==) :: RestRoutineType -> RestRoutineType -> Bool # (/=) :: RestRoutineType -> RestRoutineType -> Bool #
Show RestRoutineType Source #
Instance details Defined in Hasura.Backends.BigQuery.Meta Methods showsPrec :: Int -> RestRoutineType -> ShowS # show :: RestRoutineType -> String # showList :: [RestRoutineType] -> ShowS #
Generic RestRoutineType Source #
Instance details Defined in Hasura.Backends.BigQuery.Meta Associated Types type Rep RestRoutineType :: Type -> Type # Methods from :: RestRoutineType -> Rep RestRoutineType x # to :: Rep RestRoutineType x -> RestRoutineType #
FromJSON RestRoutineType Source #
Instance details Defined in Hasura.Backends.BigQuery.Meta Methods parseJSON :: Value -> Parser RestRoutineType parseJSONList :: Value -> Parser [RestRoutineType]
type Rep RestRoutineType Source #
Instance details Defined in Hasura.Backends.BigQuery.Meta type Rep RestRoutineType = D1 ('MetaData "RestRoutineType" "Hasura.Backends.BigQuery.Meta" "graphql-engine-1.0.0-inplace" 'False) ((C1 ('MetaCons "ROUTINE_TYPE_UNSPECIFIED" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "SCALAR_FUNCTION" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "PROCEDURE" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "TABLE_VALUED_FUNCTION" 'PrefixI 'False) (U1 :: Type -> Type)))

data RestArgument Source #

Input argument of a function/routine. Ref: https://cloud.google.com/bigquery/docs/reference/rest/v2/routines#Argument

Constructors

RestArgument
Fields _raName :: Maybe Text The name of this argument. Can be absent for function return argument. _raDataType :: Maybe RestType

Instances

Instances details

Show RestArgument Source #
Instance details Defined in Hasura.Backends.BigQuery.Meta Methods showsPrec :: Int -> RestArgument -> ShowS # show :: RestArgument -> String # showList :: [RestArgument] -> ShowS #
Generic RestArgument Source #
Instance details Defined in Hasura.Backends.BigQuery.Meta Associated Types type Rep RestArgument :: Type -> Type # Methods from :: RestArgument -> Rep RestArgument x # to :: Rep RestArgument x -> RestArgument #
FromJSON RestArgument Source #
Instance details Defined in Hasura.Backends.BigQuery.Meta Methods parseJSON :: Value -> Parser RestArgument parseJSONList :: Value -> Parser [RestArgument]
type Rep RestArgument Source #
Instance details Defined in Hasura.Backends.BigQuery.Meta type Rep RestArgument = D1 ('MetaData "RestArgument" "Hasura.Backends.BigQuery.Meta" "graphql-engine-1.0.0-inplace" 'False) (C1 ('MetaCons "RestArgument" 'PrefixI 'True) (S1 ('MetaSel ('Just "_raName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "_raDataType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RestType))))

data RestStandardSqlField Source #

A field or a column. Ref: https://cloud.google.com/bigquery/docs/reference/rest/v2/StandardSqlField

Constructors

RestStandardSqlField
Fields _rssfName :: Maybe Text The field name is optional and is absent for fields with STRUCT type. _rssType :: Maybe RestType

Instances

Instances details

Show RestStandardSqlField Source #
Instance details Defined in Hasura.Backends.BigQuery.Meta Methods showsPrec :: Int -> RestStandardSqlField -> ShowS # show :: RestStandardSqlField -> String # showList :: [RestStandardSqlField] -> ShowS #
Generic RestStandardSqlField Source #
Instance details Defined in Hasura.Backends.BigQuery.Meta Associated Types type Rep RestStandardSqlField :: Type -> Type # Methods from :: RestStandardSqlField -> Rep RestStandardSqlField x # to :: Rep RestStandardSqlField x -> RestStandardSqlField #
FromJSON RestStandardSqlField Source #
Instance details Defined in Hasura.Backends.BigQuery.Meta Methods parseJSON :: Value -> Parser RestStandardSqlField parseJSONList :: Value -> Parser [RestStandardSqlField]
type Rep RestStandardSqlField Source #
Instance details Defined in Hasura.Backends.BigQuery.Meta type Rep RestStandardSqlField = D1 ('MetaData "RestStandardSqlField" "Hasura.Backends.BigQuery.Meta" "graphql-engine-1.0.0-inplace" 'False) (C1 ('MetaCons "RestStandardSqlField" 'PrefixI 'True) (S1 ('MetaSel ('Just "_rssfName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "_rssType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RestType))))

data RestStandardSqlTableType Source #

A table type, which has only list of columns with names and types. Ref: https://cloud.google.com/bigquery/docs/reference/rest/v2/routines#StandardSqlTableType

Constructors

RestStandardSqlTableType
Fields _rrttColumns :: [RestStandardSqlField]

Instances

Instances details

Show RestStandardSqlTableType Source #
Instance details Defined in Hasura.Backends.BigQuery.Meta Methods showsPrec :: Int -> RestStandardSqlTableType -> ShowS # show :: RestStandardSqlTableType -> String # showList :: [RestStandardSqlTableType] -> ShowS #
Generic RestStandardSqlTableType Source #
Instance details Defined in Hasura.Backends.BigQuery.Meta Associated Types type Rep RestStandardSqlTableType :: Type -> Type # Methods from :: RestStandardSqlTableType -> Rep RestStandardSqlTableType x # to :: Rep RestStandardSqlTableType x -> RestStandardSqlTableType #
FromJSON RestStandardSqlTableType Source #
Instance details Defined in Hasura.Backends.BigQuery.Meta Methods parseJSON :: Value -> Parser RestStandardSqlTableType parseJSONList :: Value -> Parser [RestStandardSqlTableType]
type Rep RestStandardSqlTableType Source #
Instance details Defined in Hasura.Backends.BigQuery.Meta type Rep RestStandardSqlTableType = D1 ('MetaData "RestStandardSqlTableType" "Hasura.Backends.BigQuery.Meta" "graphql-engine-1.0.0-inplace" 'False) (C1 ('MetaCons "RestStandardSqlTableType" 'PrefixI 'True) (S1 ('MetaSel ('Just "_rrttColumns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [RestStandardSqlField])))

data RestRoutineReference Source #

Id path of a routine. Ref: https://cloud.google.com/bigquery/docs/reference/rest/v2/routines#RoutineReference

Constructors

RestRoutineReference
Fields datasetId :: Text projectId :: Text routineId :: Text

Instances

Instances details

Show RestRoutineReference Source #
Instance details Defined in Hasura.Backends.BigQuery.Meta Methods showsPrec :: Int -> RestRoutineReference -> ShowS # show :: RestRoutineReference -> String # showList :: [RestRoutineReference] -> ShowS #
Generic RestRoutineReference Source #
Instance details Defined in Hasura.Backends.BigQuery.Meta Associated Types type Rep RestRoutineReference :: Type -> Type # Methods from :: RestRoutineReference -> Rep RestRoutineReference x # to :: Rep RestRoutineReference x -> RestRoutineReference #
FromJSON RestRoutineReference Source #
Instance details Defined in Hasura.Backends.BigQuery.Meta Methods parseJSON :: Value -> Parser RestRoutineReference parseJSONList :: Value -> Parser [RestRoutineReference]
type Rep RestRoutineReference Source #
Instance details Defined in Hasura.Backends.BigQuery.Meta type Rep RestRoutineReference = D1 ('MetaData "RestRoutineReference" "Hasura.Backends.BigQuery.Meta" "graphql-engine-1.0.0-inplace" 'False) (C1 ('MetaCons "RestRoutineReference" 'PrefixI 'True) (S1 ('MetaSel ('Just "datasetId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "projectId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "routineId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

routineReferenceToFunctionName :: RestRoutineReference -> FunctionName Source #

data RestRoutine Source #

A user-defined function. Ref: https://cloud.google.com/bigquery/docs/reference/rest/v2/routines#Routine

Constructors

RestRoutine
Fields routineReference :: RestRoutineReference Reference describing the ID of this routine routineType :: RestRoutineType The type of routine arguments :: Maybe [RestArgument] List of arguments defined returnTableType :: Maybe RestStandardSqlTableType Routines defined with 'RETURNS TABLE' clause has this information

Instances

Instances details

Show RestRoutine Source #
Instance details Defined in Hasura.Backends.BigQuery.Meta Methods showsPrec :: Int -> RestRoutine -> ShowS # show :: RestRoutine -> String # showList :: [RestRoutine] -> ShowS #
Generic RestRoutine Source #
Instance details Defined in Hasura.Backends.BigQuery.Meta Associated Types type Rep RestRoutine :: Type -> Type # Methods from :: RestRoutine -> Rep RestRoutine x # to :: Rep RestRoutine x -> RestRoutine #
FromJSON RestRoutine Source #
Instance details Defined in Hasura.Backends.BigQuery.Meta Methods parseJSON :: Value -> Parser RestRoutine parseJSONList :: Value -> Parser [RestRoutine]
type Rep RestRoutine Source #
Instance details Defined in Hasura.Backends.BigQuery.Meta type Rep RestRoutine = D1 ('MetaData "RestRoutine" "Hasura.Backends.BigQuery.Meta" "graphql-engine-1.0.0-inplace" 'False) (C1 ('MetaCons "RestRoutine" 'PrefixI 'True) ((S1 ('MetaSel ('Just "routineReference") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 RestRoutineReference) :: S1 ('MetaSel ('Just "routineType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 RestRoutineType)) :: (S1 ('MetaSel ('Just "arguments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [RestArgument])) :*: S1 ('MetaSel ('Just "returnTableType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RestStandardSqlTableType)))))

data RestRoutineList Source #

List of routines Ref: https://cloud.google.com/bigquery/docs/reference/rest/v2/routines/list

Constructors

RestRoutineList
Fields _rrlRoutines :: [RestRoutine] _rrlNextPageToken :: Maybe Text

getRoutines :: MonadIO m => BigQuerySourceConfig -> m (Either RestProblem [RestRoutine]) Source #

Get all routines from all specified data sets.

getRoutinesForDataSet :: MonadIO m => BigQueryConnection -> Text -> m (Either RestProblem [RestRoutine]) Source #

Get routines in the dataset.