hasura_api

package module
v0.3.17 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 7, 2022 License: MIT Imports: 9 Imported by: 1

README

Hasura Go API

An unofficial API based on Hasura API Reference.

Use Example

client, err := hasura_api.NewHasuraClient()
if err != nil {
    //...
}

res, err = client.Metadata.PgTrackTable(&metadata.PgTrackTableArgs{
    Table:  metadata.TableName("users"),
    Source: "public",
})
if err != nil {
     //...
}


API Implementation Status

Priority: Low | Medium | High

API Endpoint Access Priority Status
GraphQL /v1/graphql Permission rules Medium 0%
Relay /v1beta1/relay Permission rules Low 0%
Schema (> v2.0) /v2/query Admin only High 0%
Metadata (> v2.0) /v1/metadata Admin only High 10%
Restified GQL /api/rest GQL REST Routes Low 0%
Version /v1/version Public Low 0%
Health /healthz Public Low 0%
PG Dump /v1alpha1/pg_dump Admin only Low 0%
Config /v1alpha1/config Admin only Medium 0%
Explain /v1/graphql/explain Admin only Low 0%
Metadata API Status
Query Status Comments
Bulk 100%
PgAddSource
PgDropSource
PgTrackTable 100%
PgUntrackTable 100%
PgSetTableCustomization 100%
PgSetTableIsEnum
PgTrackFunction
PgUntrackFunction
PgSetFunctionCustomization
PgCreateFunctionPermission
PgDropFunctionPermission
PgCreateObjectRelationship
PgCreateArrayRelationship
PgDropRelationship
PgRenameRelationship
PgSetRelationshipComment
PgAddComputedField
PgDropComputedField
PgCreateInsertPermission 100%
PgDropInsertPermission 100%
PgCreateSelectPermission 100%
PgDropSelectPermission 100%
PgCreateUpdatePermission 100%
PgDropUpdatePermission 100%
PgCreateDeletePermission 100%
PgDropDeletePermission 100%
PgSetPermissionComment
PgCreateEventTrigger
PgDeleteEventTrigger
PgRedeliverEvent
PgInvokeEventTrigger
BigqueryTrackTable
BigqueryUntrackTable
BigquerySetTableCustomization
MssqlAddSource
MssqlDropSource
MssqlTrackTable
MssqlUntrackTable
MssqlCreateObjectRelationship
MssqlCreateArrayRelationship
MssqlDropRelationship
MssqlRenameRelationship
MssqlSetRelationshipComment
MssqlSetTableCustomization
MssqlCreateInsertPermission
MssqlDropInsertPermission
MssqlCreateSelectPermission
MssqlDropSelectPermission
MssqlCreateUpdatePermission
MssqlDropUpdatePermission
MssqlCreateDeletePermission
MssqlDropDeletePermission
MssqlSetPermissionComment
CreateCronTrigger
DeleteCronTrigger
GetCronTriggers
CreateScheduledEvent
DeleteScheduledEvent
AddRemoteSchema
UpdateRemoteSchema
RemoveRemoteSchema
ReloadRemoteSchema
AddRemoteSchemaPermissions
DropRemoteSchemaPermissions
PgCreateRemoteRelationship
PgUpdateRemoteRelationship
PgDeleteRemoteRelationship
ExportMetadata
ReplaceMetadata
ReloadMetadata
ClearMetadata
GetInconsistentMetadata
DropInconsistentMetadata
CreateQueryCollection
DropQueryCollection
AddQueryToCollection
DropQueryFromCollection
AddCollectionToAllowlist
DropCollectionFromAllowlist
SetCustomTypes
CreateAction
DropAction
UpdateAction
CreateActionPermission
DropActionPermission
CreateRestEndpoint
DropRestEndpoint
AddInheritedRole
DropInheritedRole
SetGraphqlIntrospectionOptions
AddHostToTlsAllowlist
DropHostFromTlsAllowlist

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Actions

type Actions struct {
	Kind                  string `yaml:"kind"`
	HandlerWebhookBaseurl string `yaml:"handler_webhook_baseurl"`
}

type HasuraClient

type HasuraClient struct {
	Metadata *MetadataClient

	Config *HasuraConfig
	Debug  bool
	// contains filtered or unexported fields
}

func NewHasuraClient

func NewHasuraClient(options ...HasuraClientOption) (*HasuraClient, error)

type HasuraClientOption

type HasuraClientOption func(*HasuraClientOptions)

func WithConfigFilepath

func WithConfigFilepath(filepath ...string) HasuraClientOption

func WithDebug added in v0.3.10

func WithDebug(debug bool) HasuraClientOption

func WithEnvFilepath

func WithEnvFilepath(filepath ...string) HasuraClientOption

func WithLiterals added in v0.3.2

func WithLiterals(hasuraEndpoint, hasuraAdminSecret string) HasuraClientOption

func WithTimeout added in v0.3.17

func WithTimeout(timeout time.Duration) HasuraClientOption

type HasuraClientOptions

type HasuraClientOptions struct {
	// contains filtered or unexported fields
}

type HasuraConfig

type HasuraConfig struct {
	Version           int     `yaml:"version"`
	Endpoint          string  `yaml:"endpoint"`
	MetadataDirectory string  `yaml:"metadata_directory"`
	Actions           Actions `yaml:"actions"`
}

func ConfigFromFile

func ConfigFromFile(filepath ...string) (*HasuraConfig, error)

func MustConfigFromFile

func MustConfigFromFile(filepath string) *HasuraConfig

type MetadataClient added in v0.3.0

type MetadataClient struct {
	HasuraClient
}

func (*MetadataClient) AddCollectionToAllowlist added in v0.3.0

func (*MetadataClient) AddHostToTlsAllowlist added in v0.3.0

func (*MetadataClient) AddInheritedRole added in v0.3.0

func (*MetadataClient) AddQueryToCollection added in v0.3.0

func (*MetadataClient) AddRemoteSchema added in v0.3.0

func (*MetadataClient) AddRemoteSchemaPermissions added in v0.3.0

func (r *MetadataClient) AddRemoteSchemaPermissions(body *metadata.AddRemoteSchemaPermissionsArgs) (metadata.MetadataResponse, error)

func (*MetadataClient) BigquerySetTableCustomization added in v0.3.0

func (r *MetadataClient) BigquerySetTableCustomization(body *metadata.BigquerySetTableCustomizationArgs) (metadata.MetadataResponse, error)

func (*MetadataClient) BigqueryTrackTable added in v0.3.0

func (*MetadataClient) BigqueryUntrackTable added in v0.3.0

func (*MetadataClient) Bulk added in v0.3.0

func (*MetadataClient) ClearMetadata added in v0.3.0

func (*MetadataClient) CreateAction added in v0.3.0

func (*MetadataClient) CreateActionPermission added in v0.3.0

func (*MetadataClient) CreateCronTrigger added in v0.3.0

func (*MetadataClient) CreateQueryCollection added in v0.3.0

func (*MetadataClient) CreateRestEndpoint added in v0.3.0

func (*MetadataClient) CreateScheduledEvent added in v0.3.0

func (*MetadataClient) DeleteCronTrigger added in v0.3.0

func (*MetadataClient) DeleteScheduledEvent added in v0.3.0

func (*MetadataClient) DropAction added in v0.3.0

func (*MetadataClient) DropActionPermission added in v0.3.0

func (*MetadataClient) DropCollectionFromAllowlist added in v0.3.0

func (r *MetadataClient) DropCollectionFromAllowlist(body *metadata.DropCollectionFromAllowlistArgs) (metadata.MetadataResponse, error)

func (*MetadataClient) DropHostFromTlsAllowlist added in v0.3.0

func (*MetadataClient) DropInconsistentMetadata added in v0.3.0

func (*MetadataClient) DropInheritedRole added in v0.3.0

func (*MetadataClient) DropQueryCollection added in v0.3.0

func (*MetadataClient) DropQueryFromCollection added in v0.3.0

func (*MetadataClient) DropRemoteSchemaPermissions added in v0.3.0

func (r *MetadataClient) DropRemoteSchemaPermissions(body *metadata.DropRemoteSchemaPermissionsArgs) (metadata.MetadataResponse, error)

func (*MetadataClient) DropRestEndpoint added in v0.3.0

func (*MetadataClient) Exec added in v0.3.2

func (*MetadataClient) ExportMetadata added in v0.3.0

func (*MetadataClient) GetCronTriggers added in v0.3.0

func (*MetadataClient) GetInconsistentMetadata added in v0.3.0

func (*MetadataClient) MssqlAddSource added in v0.3.0

func (*MetadataClient) MssqlCreateArrayRelationship added in v0.3.0

func (r *MetadataClient) MssqlCreateArrayRelationship(body *metadata.MssqlCreateArrayRelationshipArgs) (metadata.MetadataResponse, error)

func (*MetadataClient) MssqlCreateDeletePermission added in v0.3.0

func (r *MetadataClient) MssqlCreateDeletePermission(body *metadata.MssqlCreateDeletePermissionArgs) (metadata.MetadataResponse, error)

func (*MetadataClient) MssqlCreateInsertPermission added in v0.3.0

func (r *MetadataClient) MssqlCreateInsertPermission(body *metadata.MssqlCreateInsertPermissionArgs) (metadata.MetadataResponse, error)

func (*MetadataClient) MssqlCreateObjectRelationship added in v0.3.0

func (r *MetadataClient) MssqlCreateObjectRelationship(body *metadata.MssqlCreateObjectRelationshipArgs) (metadata.MetadataResponse, error)

func (*MetadataClient) MssqlCreateSelectPermission added in v0.3.0

func (r *MetadataClient) MssqlCreateSelectPermission(body *metadata.MssqlCreateSelectPermissionArgs) (metadata.MetadataResponse, error)

func (*MetadataClient) MssqlCreateUpdatePermission added in v0.3.0

func (r *MetadataClient) MssqlCreateUpdatePermission(body *metadata.MssqlCreateUpdatePermissionArgs) (metadata.MetadataResponse, error)

func (*MetadataClient) MssqlDropDeletePermission added in v0.3.0

func (*MetadataClient) MssqlDropInsertPermission added in v0.3.0

func (*MetadataClient) MssqlDropRelationship added in v0.3.0

func (*MetadataClient) MssqlDropSelectPermission added in v0.3.0

func (*MetadataClient) MssqlDropSource added in v0.3.0

func (*MetadataClient) MssqlDropUpdatePermission added in v0.3.0

func (*MetadataClient) MssqlRenameRelationship added in v0.3.0

func (*MetadataClient) MssqlSetPermissionComment added in v0.3.0

func (*MetadataClient) MssqlSetRelationshipComment added in v0.3.0

func (r *MetadataClient) MssqlSetRelationshipComment(body *metadata.MssqlSetRelationshipCommentArgs) (metadata.MetadataResponse, error)

func (*MetadataClient) MssqlSetTableCustomization added in v0.3.0

func (r *MetadataClient) MssqlSetTableCustomization(body *metadata.MssqlSetTableCustomizationArgs) (metadata.MetadataResponse, error)

func (*MetadataClient) MssqlTrackTable added in v0.3.0

func (*MetadataClient) MssqlUntrackTable added in v0.3.0

func (*MetadataClient) PgAddComputedField added in v0.3.0

func (*MetadataClient) PgAddSource added in v0.3.0

func (*MetadataClient) PgCreateArrayRelationship added in v0.3.0

func (*MetadataClient) PgCreateDeletePermission added in v0.3.0

func (*MetadataClient) PgCreateEventTrigger added in v0.3.0

func (*MetadataClient) PgCreateFunctionPermission added in v0.3.0

func (r *MetadataClient) PgCreateFunctionPermission(body *metadata.PgCreateFunctionPermissionArgs) (metadata.MetadataResponse, error)

func (*MetadataClient) PgCreateInsertPermission added in v0.3.0

func (*MetadataClient) PgCreateObjectRelationship added in v0.3.0

func (r *MetadataClient) PgCreateObjectRelationship(body *metadata.PgCreateObjectRelationshipArgs) (metadata.MetadataResponse, error)

func (*MetadataClient) PgCreateRemoteRelationship added in v0.3.0

func (r *MetadataClient) PgCreateRemoteRelationship(body *metadata.PgCreateRemoteRelationshipArgs) (metadata.MetadataResponse, error)

func (*MetadataClient) PgCreateSelectPermission added in v0.3.0

func (*MetadataClient) PgCreateUpdatePermission added in v0.3.0

func (*MetadataClient) PgDeleteEventTrigger added in v0.3.0

func (*MetadataClient) PgDeleteRemoteRelationship added in v0.3.0

func (r *MetadataClient) PgDeleteRemoteRelationship(body *metadata.PgDeleteRemoteRelationshipArgs) (metadata.MetadataResponse, error)

func (*MetadataClient) PgDropComputedField added in v0.3.0

func (*MetadataClient) PgDropDeletePermission added in v0.3.0

func (*MetadataClient) PgDropFunctionPermission added in v0.3.0

func (*MetadataClient) PgDropInsertPermission added in v0.3.0

func (*MetadataClient) PgDropRelationship added in v0.3.0

func (*MetadataClient) PgDropSelectPermission added in v0.3.0

func (*MetadataClient) PgDropSource added in v0.3.0

func (*MetadataClient) PgDropUpdatePermission added in v0.3.0

func (*MetadataClient) PgInvokeEventTrigger added in v0.3.0

func (*MetadataClient) PgRedeliverEvent added in v0.3.0

func (*MetadataClient) PgRenameRelationship added in v0.3.0

func (*MetadataClient) PgSetFunctionCustomization added in v0.3.0

func (r *MetadataClient) PgSetFunctionCustomization(body *metadata.PgSetFunctionCustomizationArgs) (metadata.MetadataResponse, error)

func (*MetadataClient) PgSetPermissionComment added in v0.3.0

func (*MetadataClient) PgSetRelationshipComment added in v0.3.0

func (*MetadataClient) PgSetTableCustomization added in v0.3.0

func (*MetadataClient) PgSetTableIsEnum added in v0.3.0

func (*MetadataClient) PgTrackFunction added in v0.3.0

func (*MetadataClient) PgTrackTable added in v0.3.0

func (*MetadataClient) PgUntrackFunction added in v0.3.0

func (*MetadataClient) PgUntrackTable added in v0.3.0

func (*MetadataClient) PgUpdateRemoteRelationship added in v0.3.0

func (r *MetadataClient) PgUpdateRemoteRelationship(body *metadata.PgUpdateRemoteRelationshipArgs) (metadata.MetadataResponse, error)

func (*MetadataClient) ReloadMetadata added in v0.3.0

func (*MetadataClient) ReloadRemoteSchema added in v0.3.0

func (*MetadataClient) RemoveRemoteSchema added in v0.3.0

func (*MetadataClient) ReplaceMetadata added in v0.3.0

func (*MetadataClient) SetCustomTypes added in v0.3.0

func (*MetadataClient) SetGraphqlIntrospectionOptions added in v0.3.0

func (r *MetadataClient) SetGraphqlIntrospectionOptions(body *metadata.SetGraphqlIntrospectionOptionsArgs) (metadata.MetadataResponse, error)

func (*MetadataClient) UpdateAction added in v0.3.0

func (*MetadataClient) UpdateRemoteSchema added in v0.3.0

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL