postgrest

README

Postgrest GO

Golang client for PostgREST. The goal of this library is to make an "ORM-like" restful interface.

Documentation

Full documentation can be found on our website.

Quick start

Install

go get github.com/supabase/postgrest-go

Usage

package main

import (
	"fmt"

	"github.com/supabase/postgrest-go"
)

func main() {
	client := postgrest.NewClient("http://localhost:3000", "", nil)
	if client.ClientError != nil {
		panic(client.ClientError)
	}
	
	result := client.Rpc("add_them", "", map[string]int{"a": 12, "b": 3})
	if client.ClientError != nil {
		panic(client.ClientError)
	}
	
	fmt.Println(result)
}

• select(): https://supabase.io/docs/postgrest/client/select
• insert(): https://supabase.io/docs/postgrest/client/insert
• update(): https://supabase.io/docs/postgrest/client/update
• delete(): https://supabase.io/docs/postgrest/client/delete

License

This repo is liscenced under Apache License.

Sponsors

We are building the features of Firebase using enterprise-grade, open source products. We support existing communities wherever possible, and if the products don’t exist we build them and open source them ourselves. Thanks to these sponsors who are making the OSS ecosystem better for everyone.

Documentation

Index

• type Client
  • func NewClient(rawURL, schema string, headers map[string]string) *Client
  • func (c *Client) ChangeSchema(schema string) *Client
  • func (c *Client) From(table string) *QueryBuilder
  • func (c *Client) Rpc(name string, count string, rpcBody interface{}) string
  • func (c *Client) TokenAuth(token string) *Client
• type ExecuteError
• type FilterBuilder
  • func (f *FilterBuilder) ContainedBy(column string, value []string) *FilterBuilder
  • func (f *FilterBuilder) ContainedByObject(column string, value interface{}) *FilterBuilder
  • func (f *FilterBuilder) Contains(column string, value []string) *FilterBuilder
  • func (f *FilterBuilder) ContainsObject(column string, value interface{}) *FilterBuilder
  • func (f *FilterBuilder) Eq(column, value string) *FilterBuilder
  • func (f *FilterBuilder) Execute() ([]byte, error)
  • func (f *FilterBuilder) ExecuteString() (string, error)
  • func (f *FilterBuilder) ExecuteTo(to interface{}) error
  • func (f *FilterBuilder) Filter(column, operator, value string) *FilterBuilder
  • func (f *FilterBuilder) Gt(column, value string) *FilterBuilder
  • func (f *FilterBuilder) Gte(column, value string) *FilterBuilder
  • func (f *FilterBuilder) Ilike(column, value string) *FilterBuilder
  • func (f *FilterBuilder) In(column string, values []string) *FilterBuilder
  • func (f *FilterBuilder) Is(column, value string) *FilterBuilder
  • func (f *FilterBuilder) Like(column, value string) *FilterBuilder
  • func (f *FilterBuilder) Lt(column, value string) *FilterBuilder
  • func (f *FilterBuilder) Lte(column, value string) *FilterBuilder
  • func (f *FilterBuilder) Match(userQuery map[string]string) *FilterBuilder
  • func (f *FilterBuilder) Neq(column, value string) *FilterBuilder
  • func (f *FilterBuilder) Not(column, operator, value string) *FilterBuilder
  • func (f *FilterBuilder) Or(filters, foreignTable string) *FilterBuilder
  • func (f *FilterBuilder) Overlaps(column string, value []string) *FilterBuilder
  • func (f *FilterBuilder) RangeAdjacent(column, value string) *FilterBuilder
  • func (f *FilterBuilder) RangeGt(column, value string) *FilterBuilder
  • func (f *FilterBuilder) RangeGte(column, value string) *FilterBuilder
  • func (f *FilterBuilder) RangeLt(column, value string) *FilterBuilder
  • func (f *FilterBuilder) RangeLte(column, value string) *FilterBuilder
  • func (f *FilterBuilder) TextSearch(column, userQuery, config, tsType string) *FilterBuilder
• type QueryBuilder
  • func (q *QueryBuilder) Delete(returning, count string) *FilterBuilder
  • func (q *QueryBuilder) Execute() ([]byte, error)
  • func (q *QueryBuilder) ExecuteString() (string, error)
  • func (q *QueryBuilder) ExecuteTo(to interface{}) error
  • func (q *QueryBuilder) Insert(value interface{}, upsert bool, onConflict, returning, count string) *FilterBuilder
  • func (q *QueryBuilder) Select(columns, count string, head bool) *FilterBuilder
  • func (q *QueryBuilder) Update(value interface{}, returning, count string) *FilterBuilder
  • func (q *QueryBuilder) Upsert(value interface{}, onConflict, returning, count string) *FilterBuilder
• type TransformBuilder
  • func (t *TransformBuilder) Execute() ([]byte, error)
  • func (t *TransformBuilder) ExecuteString() (string, error)
  • func (t *TransformBuilder) ExecuteTo(to interface{}) error
  • func (t *TransformBuilder) Limit(count int, foreignTable string) *TransformBuilder
  • func (t *TransformBuilder) Order(column, foreignTable string, ascending, nullsFirst bool) *TransformBuilder
  • func (t *TransformBuilder) Range(from, to int, foreignTable string) *TransformBuilder
  • func (t *TransformBuilder) Single() *TransformBuilder

Types

type Client

type Client struct {
	ClientError error
	// contains filtered or unexported fields
}

func NewClient

func NewClient(rawURL, schema string, headers map[string]string) *Client

func (*Client) ChangeSchema

func (c *Client) ChangeSchema(schema string) *Client

func (*Client) From

func (c *Client) From(table string) *QueryBuilder

func (*Client) Rpc

func (c *Client) Rpc(name string, count string, rpcBody interface{}) string

func (*Client) TokenAuth

func (c *Client) TokenAuth(token string) *Client

type ExecuteError

type ExecuteError struct {
	Hint    string `json:"hint"`
	Details string `json:"details"`
	Code    string `json:"code"`
	Message string `json:"message"`
}

type FilterBuilder

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

func (*FilterBuilder) ContainedBy

func (f *FilterBuilder) ContainedBy(column string, value []string) *FilterBuilder

func (*FilterBuilder) ContainedByObject

func (f *FilterBuilder) ContainedByObject(column string, value interface{}) *FilterBuilder

func (*FilterBuilder) Contains

func (f *FilterBuilder) Contains(column string, value []string) *FilterBuilder

func (*FilterBuilder) ContainsObject

func (f *FilterBuilder) ContainsObject(column string, value interface{}) *FilterBuilder

func (*FilterBuilder) Eq

func (f *FilterBuilder) Eq(column, value string) *FilterBuilder

func (*FilterBuilder) Execute

func (f *FilterBuilder) Execute() ([]byte, error)

func (*FilterBuilder) ExecuteString

func (f *FilterBuilder) ExecuteString() (string, error)

func (*FilterBuilder) ExecuteTo

func (f *FilterBuilder) ExecuteTo(to interface{}) error

func (*FilterBuilder) Filter

func (f *FilterBuilder) Filter(column, operator, value string) *FilterBuilder

func (*FilterBuilder) Gt

func (f *FilterBuilder) Gt(column, value string) *FilterBuilder

func (*FilterBuilder) Gte

func (f *FilterBuilder) Gte(column, value string) *FilterBuilder

func (*FilterBuilder) Ilike

func (f *FilterBuilder) Ilike(column, value string) *FilterBuilder

func (*FilterBuilder) In

func (f *FilterBuilder) In(column string, values []string) *FilterBuilder

func (*FilterBuilder) Is

func (f *FilterBuilder) Is(column, value string) *FilterBuilder

func (*FilterBuilder) Like

func (f *FilterBuilder) Like(column, value string) *FilterBuilder

func (*FilterBuilder) Lt

func (f *FilterBuilder) Lt(column, value string) *FilterBuilder

func (*FilterBuilder) Lte

func (f *FilterBuilder) Lte(column, value string) *FilterBuilder

func (*FilterBuilder) Match

func (f *FilterBuilder) Match(userQuery map[string]string) *FilterBuilder

func (*FilterBuilder) Neq

func (f *FilterBuilder) Neq(column, value string) *FilterBuilder

func (*FilterBuilder) Not

func (f *FilterBuilder) Not(column, operator, value string) *FilterBuilder

func (*FilterBuilder) Or

func (f *FilterBuilder) Or(filters, foreignTable string) *FilterBuilder

func (*FilterBuilder) Overlaps

func (f *FilterBuilder) Overlaps(column string, value []string) *FilterBuilder

func (*FilterBuilder) RangeAdjacent

func (f *FilterBuilder) RangeAdjacent(column, value string) *FilterBuilder

func (*FilterBuilder) RangeGt

func (f *FilterBuilder) RangeGt(column, value string) *FilterBuilder

func (*FilterBuilder) RangeGte

func (f *FilterBuilder) RangeGte(column, value string) *FilterBuilder

func (*FilterBuilder) RangeLt

func (f *FilterBuilder) RangeLt(column, value string) *FilterBuilder

func (*FilterBuilder) RangeLte

func (f *FilterBuilder) RangeLte(column, value string) *FilterBuilder

func (*FilterBuilder) TextSearch

func (f *FilterBuilder) TextSearch(column, userQuery, config, tsType string) *FilterBuilder

type QueryBuilder

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

func (*QueryBuilder) Delete

func (q *QueryBuilder) Delete(returning, count string) *FilterBuilder

func (*QueryBuilder) Execute

func (q *QueryBuilder) Execute() ([]byte, error)

func (*QueryBuilder) ExecuteString

func (q *QueryBuilder) ExecuteString() (string, error)

func (*QueryBuilder) ExecuteTo

func (q *QueryBuilder) ExecuteTo(to interface{}) error

func (*QueryBuilder) Insert

func (q *QueryBuilder) Insert(value interface{}, upsert bool, onConflict, returning, count string) *FilterBuilder

func (*QueryBuilder) Select

func (q *QueryBuilder) Select(columns, count string, head bool) *FilterBuilder

func (*QueryBuilder) Update

func (q *QueryBuilder) Update(value interface{}, returning, count string) *FilterBuilder

func (*QueryBuilder) Upsert

func (q *QueryBuilder) Upsert(value interface{}, onConflict, returning, count string) *FilterBuilder

type TransformBuilder

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

func (*TransformBuilder) Execute

func (t *TransformBuilder) Execute() ([]byte, error)

func (*TransformBuilder) ExecuteString

func (t *TransformBuilder) ExecuteString() (string, error)

func (*TransformBuilder) ExecuteTo

func (t *TransformBuilder) ExecuteTo(to interface{}) error

func (*TransformBuilder) Limit

func (t *TransformBuilder) Limit(count int, foreignTable string) *TransformBuilder

func (*TransformBuilder) Order

func (t *TransformBuilder) Order(column, foreignTable string, ascending, nullsFirst bool) *TransformBuilder

func (*TransformBuilder) Range

func (t *TransformBuilder) Range(from, to int, foreignTable string) *TransformBuilder

func (*TransformBuilder) Single

func (t *TransformBuilder) Single() *TransformBuilder