hasura

Documentation

Index

• func Create(hasura config.Hasura, cfg config.Database, views []string, ...) error
• type API
  • func New(baseURL, secret string) *API
  • func (api *API) CreateRestEndpoint(name, url, queryName, collectionName string) error
  • func (api *API) CreateSelectPermissions(table, role string, perm Permission) error
  • func (api *API) DropSelectPermissions(table, role string) error
  • func (api *API) ExportMetadata(data *Metadata) (ExportMetadataResponse, error)
  • func (api *API) Health() error
  • func (api *API) ReplaceMetadata(data *Metadata) error
  • func (api *API) TrackTable(schema, name string) error
• type APIError
  • func (e APIError) AlreadyExists() bool
  • func (e APIError) Error() string
• type Columns
  • func (columns Columns) MarshalJSON() ([]byte, error)
  • func (columns *Columns) UnmarshalJSON(data []byte) error
• type Definition
• type ExportMetadataResponse
• type Metadata
  • func Generate(hasura config.Hasura, cfg config.Database, models ...interface{}) (*Metadata, error)
• type Permission
• type Query
• type QueryCollection
• type SelectPermission
• type Table
• type TableSchema

Functions

func Create

func Create(hasura config.Hasura, cfg config.Database, views []string, models ...interface{}) error

Create - creates hasura models

Types

type API

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

API -

func New

func New(baseURL, secret string) *API

New -

func (*API) CreateRestEndpoint

func (api *API) CreateRestEndpoint(name, url, queryName, collectionName string) error

CreateRestEndpoint -

func (*API) CreateSelectPermissions

func (api *API) CreateSelectPermissions(table, role string, perm Permission) error

CreateSelectPermissions - A select permission is used to restrict access to only the specified columns and rows.

func (*API) DropSelectPermissions

func (api *API) DropSelectPermissions(table, role string) error

DropSelectPermissions -

func (*API) ExportMetadata

func (api *API) ExportMetadata(data *Metadata) (ExportMetadataResponse, error)

ExportMetadata -

func (*API) Health

func (api *API) Health() error

Health

func (*API) ReplaceMetadata

func (api *API) ReplaceMetadata(data *Metadata) error

ReplaceMetadata -

func (*API) TrackTable

func (api *API) TrackTable(schema, name string) error

TrackTable -

type APIError

type APIError struct {
	Path string `json:"path"`
	Text string `json:"error"`
	Code string `json:"code"`
}

APIError -

func (APIError) AlreadyExists

func (e APIError) AlreadyExists() bool

AlreadyExists -

func (APIError) Error

func (e APIError) Error() string

Error -

type Columns

type Columns []string

Columns -

func (Columns) MarshalJSON

func (columns Columns) MarshalJSON() ([]byte, error)

MarshalJSON -

func (*Columns) UnmarshalJSON

func (columns *Columns) UnmarshalJSON(data []byte) error

UnmarshalJSON -

type Definition

type Definition struct {
	Queries []Query `json:"queries"`
}

Definition -

type ExportMetadataResponse

type ExportMetadataResponse struct {
	Tables []Table `json:"tables"`
}

ExportMetadataResponse -

type Metadata

type Metadata struct {
	Version          int               `json:"version"`
	Tables           []Table           `json:"tables"`
	QueryCollections []QueryCollection `json:"query_collections,omitempty"`
}

Metadata -

func Generate

func Generate(hasura config.Hasura, cfg config.Database, models ...interface{}) (*Metadata, error)

Generate - creates hasura table structure in JSON from `models`. `models` should be pointer to your table models. `cfg` is DB config from YAML.

type Permission

type Permission struct {
	Columns   Columns     `json:"columns"`
	Limit     uint64      `json:"limit"`
	AllowAggs bool        `json:"allow_aggregations"`
	Filter    interface{} `json:"filter,omitempty"`
}

Permission -

type Query

type Query struct {
	Name           string `json:"name"`
	Query          string `json:"query,omitempty"`
	CollectionName string `json:"collection_name,omitempty"`
}

Query -

type QueryCollection

type QueryCollection struct {
	Definition Definition `json:"definition"`
	Name       string     `json:"name"`
}

QueryCollection -

type SelectPermission

type SelectPermission struct {
	Role       string     `json:"role"`
	Permission Permission `json:"permission"`
}

SelectPermission -

type Table

type Table struct {
	ObjectRelationships []interface{}      `json:"object_relationships"`
	ArrayRelationships  []interface{}      `json:"array_relationships"`
	SelectPermissions   []SelectPermission `json:"select_permissions"`
	Schema              TableSchema        `json:"table"`
}

Table -

type TableSchema

type TableSchema struct {
	Schema string `json:"schema"`
	Name   string `json:"name"`
}

TableSchema -