README
¶
PostgreSQL adaptor
The PostgreSQL adaptor is capable of reading/tailing tables using logical decoding and receiving data for inserts.
Configuration:
pg = postgres({
"uri": "postgres://127.0.0.1:5432/test"
})
Permissions
Postgres as a transporter source uses Logical Decoding which requires the user account to have superuser or replication permissions.
Warning! PostgreSQL on Compose platform does not support superuser permissions so it is not possible to use a Compose PostgreSQL database as a transporter source.
Documentation
¶
Index ¶
Constants ¶
const ( // DefaultURI is the default endpoint of Postgres on the local machine. // Primarily used when initializing a new Client without a specific URI. DefaultURI = "postgres://127.0.0.1:5432?sslmode=disable" )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client represents a client to the underlying File source.
func NewClient ¶
func NewClient(options ...ClientOptionFunc) (*Client, error)
NewClient creates a default file client
type ClientOptionFunc ¶
ClientOptionFunc is a function that configures a Client. It is used in NewClient.
func WithURI ¶
func WithURI(uri string) ClientOptionFunc
WithURI defines the full connection string for the Postgres connection
type Postgres ¶
type Postgres struct {
adaptor.BaseConfig
Debug bool `json:"debug" doc:"display debug information"`
Tail bool `json:"tail" doc:"if tail is true, then the postgres source will tail the oplog after copying the namespace"`
ReplicationSlot string `json:"replication_slot" doc:"required if tail is true; sets the replication slot to use for logical decoding"`
}
Postgres is an adaptor to read / write to postgres. it works as a source by copying files, and then optionally tailing the oplog
func (*Postgres) Description ¶
Description for postgres adaptor
func (*Postgres) SampleConfig ¶
SampleConfig for postgres adaptor
type Reader ¶
type Reader struct {
}
Reader implements the behavior defined by client.Reader for interfacing with MongoDB.
func (*Reader) Read ¶
func (r *Reader) Read(resumeMap map[string]client.MessageSet, filterFn client.NsFilterFunc) client.MessageChanFunc
type Session ¶
type Session struct {
// contains filtered or unexported fields
}
Session serves as a wrapper for the underlying *sql.DB
type Tailer ¶
type Tailer struct {
// contains filtered or unexported fields
}
Tailer implements the behavior defined by client.Tailer for interfacing with the MongoDB oplog.
func (*Tailer) Read ¶
func (t *Tailer) Read(resumeMap map[string]client.MessageSet, filterFn client.NsFilterFunc) client.MessageChanFunc
Tail does the things
Source Files