README
¶
pgtypes
This package provides wrapper types for converting various go types to and
from their postgresql representation via the standard database/sql interfaces.
The original implementation of these types came from the github.com/lib/pq package,
which you can still use to gain access to these types. The reason to use ethanpailes/pgtypes
instead is that lib/pq is that lib/pq is no longer maintained and bundles an
entire postgres driver. ethanpailes/pgtypes just provides the conversion types.
Licensing & Copyright
The copyright for most of this code is held by the lib/pq contributors and
Blake Mizerany and licenced under the MIT license. The copyright for some recent
changes is held by Ethan Pailes and ethanpailes/pgtypes contributors under the
same license.
Documentation
¶
Index ¶
- Constants
- func Array(a interface{}) interface{ ... }
- func FormatTimestamp(t time.Time) []byte
- func ParseTimestamp(currentLocation *time.Location, str string) (time.Time, error)
- type ArrayDelimiter
- type BoolArray
- type ByteaArray
- type Error
- type ErrorClass
- type ErrorCode
- type Float32Array
- type Float64Array
- type GenericArray
- type Int32Array
- type Int64Array
- type NullTime
- type StringArray
Constants ¶
const ( Efatal = "FATAL" Epanic = "PANIC" Ewarning = "WARNING" Enotice = "NOTICE" Edebug = "DEBUG" Einfo = "INFO" Elog = "LOG" )
Error severities
Variables ¶
This section is empty.
Functions ¶
func Array ¶
Array returns the optimal driver.Valuer and sql.Scanner for an array or slice of any dimension.
For example:
db.Query(`SELECT * FROM t WHERE id = ANY($1)`, pq.Array([]int{235, 401}))
var x []sql.NullInt64
db.QueryRow('SELECT ARRAY[235, 401]').Scan(pq.Array(&x))
Scanning multi-dimensional arrays is not supported. Arrays where the lower bound is not one (such as `[0:0]={1}') are not supported.
func FormatTimestamp ¶
FormatTimestamp formats t into Postgres' text format for timestamps.
func ParseTimestamp ¶
ParseTimestamp parses Postgres' text format. It returns a time.Time in currentLocation iff that time's offset agrees with the offset sent from the Postgres server. Otherwise, ParseTimestamp returns a time.Time with the fixed offset offset provided by the Postgres server.
Types ¶
type ArrayDelimiter ¶
type ArrayDelimiter interface {
// ArrayDelimiter returns the delimiter character(s) for this element's type.
ArrayDelimiter() string
}
ArrayDelimiter may be optionally implemented by driver.Valuer or sql.Scanner to override the array delimiter used by GenericArray.
type BoolArray ¶
type BoolArray []bool
BoolArray represents a one-dimensional array of the PostgreSQL boolean type.
type ByteaArray ¶
type ByteaArray [][]byte
ByteaArray represents a one-dimensional array of the PostgreSQL bytea type.
func (*ByteaArray) Scan ¶
func (a *ByteaArray) Scan(src interface{}) error
Scan implements the sql.Scanner interface.
type Error ¶
type Error struct {
Severity string
Code ErrorCode
Message string
Detail string
Hint string
Position string
InternalPosition string
InternalQuery string
Where string
Schema string
Table string
Column string
DataTypeName string
Constraint string
File string
Line string
Routine string
}
Error represents an error communicating with the server.
See http://www.postgresql.org/docs/current/static/protocol-error-fields.html for details of the fields
type ErrorClass ¶
type ErrorClass string
ErrorClass is only the class part of an error code.
func (ErrorClass) Name ¶
func (ec ErrorClass) Name() string
Name returns the condition name of an error class. It is equivalent to the condition name of the "standard" error code (i.e. the one having the last three characters "000").
type ErrorCode ¶
type ErrorCode string
ErrorCode is a five-character error code.
func (ErrorCode) Class ¶
func (ec ErrorCode) Class() ErrorClass
Class returns the error class, e.g. "28".
See http://www.postgresql.org/docs/9.3/static/errcodes-appendix.html for details.
func (ErrorCode) Name ¶
Name returns a more human friendly rendering of the error code, namely the "condition name".
See http://www.postgresql.org/docs/9.3/static/errcodes-appendix.html for details.
type Float32Array ¶
type Float32Array []float32
Float32Array represents a one-dimensional array of the PostgreSQL double precision type.
func (*Float32Array) Scan ¶
func (a *Float32Array) Scan(src interface{}) error
Scan implements the sql.Scanner interface.
type Float64Array ¶
type Float64Array []float64
Float64Array represents a one-dimensional array of the PostgreSQL double precision type.
func (*Float64Array) Scan ¶
func (a *Float64Array) Scan(src interface{}) error
Scan implements the sql.Scanner interface.
type GenericArray ¶
type GenericArray struct{ A interface{} }
GenericArray implements the driver.Valuer and sql.Scanner interfaces for an array or slice of any dimension.
func (GenericArray) Scan ¶
func (a GenericArray) Scan(src interface{}) error
Scan implements the sql.Scanner interface.
type Int32Array ¶
type Int32Array []int32
Int32Array represents a one-dimensional array of the PostgreSQL integer types.
func (*Int32Array) Scan ¶
func (a *Int32Array) Scan(src interface{}) error
Scan implements the sql.Scanner interface.
type Int64Array ¶
type Int64Array []int64
Int64Array represents a one-dimensional array of the PostgreSQL integer types.
func (*Int64Array) Scan ¶
func (a *Int64Array) Scan(src interface{}) error
Scan implements the sql.Scanner interface.
type NullTime ¶
NullTime represents a time.Time that may be null. NullTime implements the sql.Scanner interface so it can be used as a scan destination, similar to sql.NullString.
type StringArray ¶
type StringArray []string
StringArray represents a one-dimensional array of the PostgreSQL character types.
func (*StringArray) Scan ¶
func (a *StringArray) Scan(src interface{}) error
Scan implements the sql.Scanner interface.
Source Files
Directories