Postgrestex (Postgrestex v0.1.2) View Source

Postgrestex is a client library which provides elixir bindings to interact with PostgREST. PostgREST in turn is a standalone web server that turns your PostgreSQL database directly into a RESTful API.

Link to this section Summary

Functions

adj(req, column, range)

auth(req, token, username \\ "", password \\ "")

Authenticate the client with either the bearer token or basic authentication.

call(req)

Take in and execute a request. Doesn't return an exception if an error is thrown.

call!(req)

Take in and execute a request. Raises an exception if an error occurs.

cd(req, column, values)

cs(req, column, values)

delete(req, options \\ [])

Delete an existing value in the currently selected table.

eq(req, column, value)

filter(req, column, operator, criteria)

Either filter in or filter out based on negate_next.

from(req, table)

Select table to obtain data from/perform operations on

fts(req, column, query)

gt(req, column, value)

gte(req, column, value)

ilike(req, column, pattern)

in_(req, column, values)

init(schema, path \\ "http://localhost:3000")

Creates an initial request in the form of a map that the user can work with.

insert(req, json, options)

Insert a row into currently selected table. Does an insert and update if upsert is set to True

insert(req, json, upsert \\ false, options \\ [])

is_(req, column, value)

like(req, column, pattern)

limit(req, size, start)

lt(req, column, value)

lte(req, column, value)

neq(req, column, value)

not(req)

Toggle between filtering in or filtering out.

nxl(req, column, range)

nxr(req, column, range)

order(req, column, desc \\ false, nullsfirst \\ false)

ov(req, column, values)

phfts(req, column, query)

plfts(req, column, query)

range(req, start, end_)

rpc(req, func, params)

Execute a Stored Procedure Call

sanitize_params(str)

Remove reserved characters from the parameter string.

sanitize_pattern_params(str)

schema(req, schema)

Switch to another schema.

select(req, columns)

single(req)

sl(req, column, range)

sr(req, column, range)

update(req, json)

Update an existing value in the currently selected table.

update_headers(req, updates)

wfts(req, column, query)

Link to this section Functions

adj(req, column, range)

Specs

adj(map(), String.t(), integer()) :: map()

auth(req, token, username \\ "", password \\ "")

Specs

auth(map(), String.t(), String.t(), String.t()) :: map()

Authenticate the client with either the bearer token or basic authentication.

call(req)

(since 0.1.0)

Specs

call(map()) ::
  {:ok, HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()}
  | {:error, HTTPoison.Error.t()}

Take in and execute a request. Doesn't return an exception if an error is thrown.

call!(req)

(since 0.1.0)

Specs

call!(map()) ::
  {:ok, HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()}
  | Postgrestex.NoMethodException

Take in and execute a request. Raises an exception if an error occurs.

cd(req, column, values)

cs(req, column, values)

delete(req, options \\ [])

(since 0.1.0)

Specs

delete(map(), keyword()) :: map()

Delete an existing value in the currently selected table.

eq(req, column, value)

Specs

eq(map(), String.t(), String.t()) :: map()

filter(req, column, operator, criteria)

(since 0.1.0)

Specs

filter(map(), String.t(), String.t(), String.t()) :: map()

Either filter in or filter out based on negate_next.

from(req, table)

Specs

from(map(), String.t()) :: map()

Select table to obtain data from/perform operations on

fts(req, column, query)

Specs

fts(map(), String.t(), String.t()) :: map()

gt(req, column, value)

Specs

gt(map(), String.t(), String.t()) :: map()

gte(req, column, value)

Specs

gte(map(), String.t(), String.t()) :: map()

ilike(req, column, pattern)

Specs

ilike(map(), String.t(), String.t()) :: map()

in_(req, column, values)

init(schema, path \\ "http://localhost:3000")

(since 0.1.0)

Specs

init(map(), String.t()) :: map()

Creates an initial request in the form of a map that the user can work with.

insert(req, json, options)

(since 0.1.0)

Insert a row into currently selected table. Does an insert and update if upsert is set to True

insert(req, json, upsert \\ false, options \\ [])

Specs

insert(map(), map(), true | false, keyword()) :: map()

is_(req, column, value)

Specs

is_(map(), String.t(), String.t()) :: map()

like(req, column, pattern)

Specs

like(map(), String.t(), String.t()) :: map()

limit(req, size, start)

Specs

limit(map(), integer(), integer()) :: map()

lt(req, column, value)

Specs

lt(map(), String.t(), String.t()) :: map()

lte(req, column, value)

Specs

lte(map(), String.t(), String.t()) :: map()

neq(req, column, value)

Specs

neq(map(), String.t(), String.t()) :: map()

not(req)

(since 0.1.0)

Specs

not map() :: map()

Toggle between filtering in or filtering out.

nxl(req, column, range)

Specs

nxl(map(), String.t(), integer()) :: map()

nxr(req, column, range)

Specs

nxr(map(), String.t(), integer()) :: map()

order(req, column, desc \\ false, nullsfirst \\ false)

Specs

order(map(), String.t(), true | false, true | false) :: map()

ov(req, column, values)

phfts(req, column, query)

Specs

phfts(map(), String.t(), String.t()) :: map()

plfts(req, column, query)

Specs

plfts(map(), String.t(), String.t()) :: map()

range(req, start, end_)

Specs

range(map(), integer(), integer()) :: map()

rpc(req, func, params)

(since 0.1.0)

Specs

rpc(map(), String.t(), map()) :: map()

Execute a Stored Procedure Call

sanitize_params(str)

(since 0.1.0)

Specs

sanitize_params(String.t()) :: String.t()

Remove reserved characters from the parameter string.

sanitize_pattern_params(str)

Specs

sanitize_pattern_params(String.t()) :: String.t()

schema(req, schema)

Specs

schema(map(), String.t()) :: map()

Switch to another schema.

select(req, columns)

Specs

select(map(), list()) :: map()

single(req)

Specs

single(map()) :: map()

sl(req, column, range)

Specs

sl(map(), String.t(), integer()) :: map()

sr(req, column, range)

Specs

sr(map(), String.t(), integer()) :: map()

update(req, json)

(since 0.1.0)

Specs

update(map(), map()) :: map()

Update an existing value in the currently selected table.

update_headers(req, updates)

Specs

update_headers(map(), map()) :: map()

wfts(req, column, query)

Specs

wfts(map(), String.t(), String.t()) :: map()