storage/postgres

id, title

id	title
postgres	Postgres

A Postgres storage driver using jackc/pgx.

Table of Contents

• Signatures
• Installation
• Examples
• Config
• Default Config

Signatures

func New(config ...Config) Storage
func (s *Storage) Get(key string) ([]byte, error)
func (s *Storage) GetWithContext(ctx context.Context, key string) ([]byte, error)
func (s *Storage) Set(key string, val []byte, exp time.Duration) error
func (s *Storage) SetWithContext(ctx context.Context, key string, val []byte, exp time.Duration) error
func (s *Storage) Delete(key string) error
func (s *Storage) DeleteWithContext(ctx context.Context, key string) error
func (s *Storage) Reset() error
func (s *Storage) ResetWithContext(ctx context.Context) error
func (s *Storage) Close() error
func (s *Storage) Conn() *pgxpool.Pool

Installation

Postgres is tested on the 2 last Go versions with support for modules. So make sure to initialize one first if you didn't do that yet:

go mod init github.com/<user>/<repo>

And then install the postgres implementation:

go get github.com/gofiber/storage/postgres/v3

Examples

Import the storage package.

import "github.com/gofiber/storage/postgres/v3"

You can use the following possibilities to create a storage:

// Initialize default config
store := postgres.New()

// Initialize custom config
store := postgres.New(postgres.Config{
    DB:              dbPool,
    Table:           "fiber_storage",
    Reset:           false,
    GCInterval:      10 * time.Second,
})

Config

// Config defines the config for storage.
type Config struct {
    // DB pgxpool.Pool object will override connection uri and other connection fields
    //
    // Optional. Default is nil
    DB *pgxpool.Pool

    // Connection string to use for DB. Will override all other authentication values if used
    //
    // Optional. Default is ""
    ConnectionURI string

    // Host name where the DB is hosted
    //
    // Optional. Default is "127.0.0.1"
    Host string

    // Port where the DB is listening on
    //
    // Optional. Default is 5432
    Port int

    // Server username
    //
    // Optional. Default is ""
    Username string

    // Server password
    //
    // Optional. Default is ""
    Password string

    // Database name
    //
    // Optional. Default is "fiber"
    Database string

    // Table name
    //
    // Optional. Default is "fiber_storage"
    Table string

    // The SSL mode for the connection
    //
    // Optional. Default is "disable"
    SSLMode string

    // Reset clears any existing keys in existing Table
    //
    // Optional. Default is false
    Reset bool

    // DisableStartupCheck skips the initial connection validation during New.
    //
    // Optional. Default is false
    DisableStartupCheck bool

    // Time before deleting expired keys
    //
    // Optional. Default is 10 * time.Second
    GCInterval time.Duration
}

Default Config

// ConfigDefault is the default config
var ConfigDefault = Config{
    ConnectionURI: "",
    Host:          "127.0.0.1",
    Port:          5432,
    Database:      "fiber",
    Table:         "fiber_storage",
    SSLMode:       "disable",
    Reset:         false,
    DisableStartupCheck: false,
    GCInterval:    10 * time.Second,
}