postgres

package module
v1.4.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 20, 2025 License: MIT Imports: 28 Imported by: 1

README

Postgres

The Postgres driver for facades.Orm() of Goravel.

Version

goravel/postgres goravel/framework
v1.0.* v1.16.*

Install

Run the command below in your project to install the package automatically:

./artisan package:install github.com/goravel/postgres

Or check the setup file to install the package manually.

Testing

Run command below to run test:

go test ./...

Documentation

Index

Constants

View Source 
const (
	Binding = "goravel.postgres"
	Name    = "PostgreSQL"
)

Variables

View Source 
var (
	FailedToGenerateDSN = errors.New("failed to generate DSN, please check the database configuration")
	ConfigNotFound      = errors.New("not found database configuration")
)
View Source 
var App foundation.Application

Functions

This section is empty.

Types

type Config added in v1.4.0 

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

func NewConfig added in v1.4.0 

func NewConfig(config config.Config, connection string) *Config

func (*Config) Config added in v1.4.0 

func (r *Config) Config() config.Config

func (*Config) Connection added in v1.4.0 

func (r *Config) Connection() string

func (*Config) Readers added in v1.4.0 

func (r *Config) Readers() []contracts.FullConfig

func (*Config) Writers added in v1.4.0 

func (r *Config) Writers() []contracts.FullConfig

type Docker 

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

func NewDocker 

func NewDocker(config contracts.ConfigBuilder, database, username, password string) *Docker

func (*Docker) Build 

func (r *Docker) Build() error

func (*Docker) Config 

func (r *Docker) Config() contractsdocker.DatabaseConfig

func (*Docker) Database 

func (r *Docker) Database(name string) (contractsdocker.DatabaseDriver, error)

func (*Docker) Driver 

func (r *Docker) Driver() string

func (*Docker) Fresh 

func (r *Docker) Fresh() error

func (*Docker) Image 

func (r *Docker) Image(image contractsdocker.Image)

func (*Docker) Ready 

func (r *Docker) Ready() error

func (*Docker) Reuse added in v1.4.0 

func (r *Docker) Reuse(containerID string, port int) error

func (*Docker) Shutdown 

func (r *Docker) Shutdown() error

type Grammar added in v1.4.0 

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

func NewGrammar added in v1.4.0 

func NewGrammar(prefix string) *Grammar

func (*Grammar) CompileAdd added in v1.4.0 

func (r *Grammar) CompileAdd(blueprint driver.Blueprint, command *driver.Command) string

func (*Grammar) CompileChange added in v1.4.0 

func (r *Grammar) CompileChange(blueprint driver.Blueprint, command *driver.Command) []string

func (*Grammar) CompileColumns added in v1.4.0 

func (r *Grammar) CompileColumns(schema, table string) (string, error)

func (*Grammar) CompileComment added in v1.4.0 

func (r *Grammar) CompileComment(blueprint driver.Blueprint, command *driver.Command) string

func (*Grammar) CompileCreate added in v1.4.0 

func (r *Grammar) CompileCreate(blueprint driver.Blueprint) string

func (*Grammar) CompileDefault added in v1.4.0 

func (r *Grammar) CompileDefault(_ driver.Blueprint, _ *driver.Command) string

func (*Grammar) CompileDrop added in v1.4.0 

func (r *Grammar) CompileDrop(blueprint driver.Blueprint) string

func (*Grammar) CompileDropAllDomains added in v1.4.0 

func (r *Grammar) CompileDropAllDomains(domains []string) string

func (*Grammar) CompileDropAllTables added in v1.4.0 

func (r *Grammar) CompileDropAllTables(schema string, tables []driver.Table) []string

func (*Grammar) CompileDropAllTypes added in v1.4.0 

func (r *Grammar) CompileDropAllTypes(schema string, types []driver.Type) []string

func (*Grammar) CompileDropAllViews added in v1.4.0 

func (r *Grammar) CompileDropAllViews(schema string, views []driver.View) []string

func (*Grammar) CompileDropColumn added in v1.4.0 

func (r *Grammar) CompileDropColumn(blueprint driver.Blueprint, command *driver.Command) []string

func (*Grammar) CompileDropForeign added in v1.4.0 

func (r *Grammar) CompileDropForeign(blueprint driver.Blueprint, command *driver.Command) string

func (*Grammar) CompileDropFullText added in v1.4.0 

func (r *Grammar) CompileDropFullText(blueprint driver.Blueprint, command *driver.Command) string

func (*Grammar) CompileDropIfExists added in v1.4.0 

func (r *Grammar) CompileDropIfExists(blueprint driver.Blueprint) string

func (*Grammar) CompileDropIndex added in v1.4.0 

func (r *Grammar) CompileDropIndex(blueprint driver.Blueprint, command *driver.Command) string

func (*Grammar) CompileDropPrimary added in v1.4.0 

func (r *Grammar) CompileDropPrimary(blueprint driver.Blueprint, command *driver.Command) string

func (*Grammar) CompileDropUnique added in v1.4.0 

func (r *Grammar) CompileDropUnique(blueprint driver.Blueprint, command *driver.Command) string

func (*Grammar) CompileForeign added in v1.4.0 

func (r *Grammar) CompileForeign(blueprint driver.Blueprint, command *driver.Command) string

func (*Grammar) CompileForeignKeys added in v1.4.0 

func (r *Grammar) CompileForeignKeys(schema, table string) string

func (*Grammar) CompileFullText added in v1.4.0 

func (r *Grammar) CompileFullText(blueprint driver.Blueprint, command *driver.Command) string

func (*Grammar) CompileInRandomOrder added in v1.4.0 

func (r *Grammar) CompileInRandomOrder(builder sq.SelectBuilder, conditions *driver.Conditions) sq.SelectBuilder

func (*Grammar) CompileIndex added in v1.4.0 

func (r *Grammar) CompileIndex(blueprint driver.Blueprint, command *driver.Command) string

func (*Grammar) CompileIndexes added in v1.4.0 

func (r *Grammar) CompileIndexes(schema, table string) (string, error)

func (*Grammar) CompileJsonColumnsUpdate added in v1.4.0 

func (r *Grammar) CompileJsonColumnsUpdate(values map[string]any) (map[string]any, error)

func (*Grammar) CompileJsonContains added in v1.4.0 

func (r *Grammar) CompileJsonContains(column string, value any, isNot bool) (string, []any, error)

func (*Grammar) CompileJsonContainsKey added in v1.4.0 

func (r *Grammar) CompileJsonContainsKey(column string, isNot bool) string

func (*Grammar) CompileJsonLength added in v1.4.0 

func (r *Grammar) CompileJsonLength(column string) string

func (*Grammar) CompileJsonSelector added in v1.4.0 

func (r *Grammar) CompileJsonSelector(column string) string

func (*Grammar) CompileJsonValues added in v1.4.0 

func (r *Grammar) CompileJsonValues(args ...any) []any

func (*Grammar) CompileLockForUpdate added in v1.4.0 

func (r *Grammar) CompileLockForUpdate(builder sq.SelectBuilder, conditions *driver.Conditions) sq.SelectBuilder

func (*Grammar) CompileLockForUpdateForGorm added in v1.4.0 

func (r *Grammar) CompileLockForUpdateForGorm() clause.Expression

func (*Grammar) CompilePlaceholderFormat added in v1.4.0 

func (r *Grammar) CompilePlaceholderFormat() driver.PlaceholderFormat

func (*Grammar) CompilePrimary added in v1.4.0 

func (r *Grammar) CompilePrimary(blueprint driver.Blueprint, command *driver.Command) string

func (*Grammar) CompilePrune added in v1.4.0 

func (r *Grammar) CompilePrune(_ string) string

func (*Grammar) CompileRandomOrderForGorm added in v1.4.0 

func (r *Grammar) CompileRandomOrderForGorm() string

func (*Grammar) CompileRename added in v1.4.0 

func (r *Grammar) CompileRename(blueprint driver.Blueprint, command *driver.Command) string

func (*Grammar) CompileRenameColumn added in v1.4.0 

func (r *Grammar) CompileRenameColumn(blueprint driver.Blueprint, command *driver.Command, _ []driver.Column) (string, error)

func (*Grammar) CompileRenameIndex added in v1.4.0 

func (r *Grammar) CompileRenameIndex(blueprint driver.Blueprint, command *driver.Command, _ []driver.Index) []string

func (*Grammar) CompileSharedLock added in v1.4.0 

func (r *Grammar) CompileSharedLock(builder sq.SelectBuilder, conditions *driver.Conditions) sq.SelectBuilder

func (*Grammar) CompileSharedLockForGorm added in v1.4.0 

func (r *Grammar) CompileSharedLockForGorm() clause.Expression

func (*Grammar) CompileTableComment added in v1.4.0 

func (r *Grammar) CompileTableComment(blueprint driver.Blueprint, command *driver.Command) string

func (*Grammar) CompileTables added in v1.4.0 

func (r *Grammar) CompileTables(_ string) string

func (*Grammar) CompileTypes added in v1.4.0 

func (r *Grammar) CompileTypes() string

func (*Grammar) CompileUnique added in v1.4.0 

func (r *Grammar) CompileUnique(blueprint driver.Blueprint, command *driver.Command) string

func (*Grammar) CompileVersion added in v1.4.0 

func (r *Grammar) CompileVersion() string

func (*Grammar) CompileViews added in v1.4.0 

func (r *Grammar) CompileViews(database string) string

func (*Grammar) EscapeNames added in v1.4.0 

func (r *Grammar) EscapeNames(names []string) []string

func (*Grammar) GetAttributeCommands added in v1.4.0 

func (r *Grammar) GetAttributeCommands() []string

func (*Grammar) ModifyDefault added in v1.4.0 

func (r *Grammar) ModifyDefault(_ driver.Blueprint, column driver.ColumnDefinition) string

func (*Grammar) ModifyGeneratedAs added in v1.4.0 

func (r *Grammar) ModifyGeneratedAs(_ driver.Blueprint, column driver.ColumnDefinition) string

func (*Grammar) ModifyGeneratedAsForChange added in v1.4.0 

func (r *Grammar) ModifyGeneratedAsForChange(_ driver.Blueprint, column driver.ColumnDefinition) string

func (*Grammar) ModifyIncrement added in v1.4.0 

func (r *Grammar) ModifyIncrement(blueprint driver.Blueprint, column driver.ColumnDefinition) string

func (*Grammar) ModifyNullable added in v1.4.0 

func (r *Grammar) ModifyNullable(_ driver.Blueprint, column driver.ColumnDefinition) string

func (*Grammar) TypeBigInteger added in v1.4.0 

func (r *Grammar) TypeBigInteger(column driver.ColumnDefinition) string

func (*Grammar) TypeBoolean added in v1.4.0 

func (r *Grammar) TypeBoolean(column driver.ColumnDefinition) string

func (*Grammar) TypeChar added in v1.4.0 

func (r *Grammar) TypeChar(column driver.ColumnDefinition) string

func (*Grammar) TypeDate added in v1.4.0 

func (r *Grammar) TypeDate(column driver.ColumnDefinition) string

func (*Grammar) TypeDateTime added in v1.4.0 

func (r *Grammar) TypeDateTime(column driver.ColumnDefinition) string

func (*Grammar) TypeDateTimeTz added in v1.4.0 

func (r *Grammar) TypeDateTimeTz(column driver.ColumnDefinition) string

func (*Grammar) TypeDecimal added in v1.4.0 

func (r *Grammar) TypeDecimal(column driver.ColumnDefinition) string

func (*Grammar) TypeDouble added in v1.4.0 

func (r *Grammar) TypeDouble(column driver.ColumnDefinition) string

func (*Grammar) TypeEnum added in v1.4.0 

func (r *Grammar) TypeEnum(column driver.ColumnDefinition) string

func (*Grammar) TypeFloat added in v1.4.0 

func (r *Grammar) TypeFloat(column driver.ColumnDefinition) string

func (*Grammar) TypeInteger added in v1.4.0 

func (r *Grammar) TypeInteger(column driver.ColumnDefinition) string

func (*Grammar) TypeJson added in v1.4.0 

func (r *Grammar) TypeJson(column driver.ColumnDefinition) string

func (*Grammar) TypeJsonb added in v1.4.0 

func (r *Grammar) TypeJsonb(column driver.ColumnDefinition) string

func (*Grammar) TypeLongText added in v1.4.0 

func (r *Grammar) TypeLongText(column driver.ColumnDefinition) string

func (*Grammar) TypeMediumInteger added in v1.4.0 

func (r *Grammar) TypeMediumInteger(column driver.ColumnDefinition) string

func (*Grammar) TypeMediumText added in v1.4.0 

func (r *Grammar) TypeMediumText(column driver.ColumnDefinition) string

func (*Grammar) TypeSmallInteger added in v1.4.0 

func (r *Grammar) TypeSmallInteger(column driver.ColumnDefinition) string

func (*Grammar) TypeString added in v1.4.0 

func (r *Grammar) TypeString(column driver.ColumnDefinition) string

func (*Grammar) TypeText added in v1.4.0 

func (r *Grammar) TypeText(column driver.ColumnDefinition) string

func (*Grammar) TypeTime added in v1.4.0 

func (r *Grammar) TypeTime(column driver.ColumnDefinition) string

func (*Grammar) TypeTimeTz added in v1.4.0 

func (r *Grammar) TypeTimeTz(column driver.ColumnDefinition) string

func (*Grammar) TypeTimestamp added in v1.4.0 

func (r *Grammar) TypeTimestamp(column driver.ColumnDefinition) string

func (*Grammar) TypeTimestampTz added in v1.4.0 

func (r *Grammar) TypeTimestampTz(column driver.ColumnDefinition) string

func (*Grammar) TypeTinyInteger added in v1.4.0 

func (r *Grammar) TypeTinyInteger(column driver.ColumnDefinition) string

func (*Grammar) TypeTinyText added in v1.4.0 

func (r *Grammar) TypeTinyText(column driver.ColumnDefinition) string

func (*Grammar) TypeUuid added in v1.4.0 

func (r *Grammar) TypeUuid(column driver.ColumnDefinition) string

type Postgres 

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

func NewPostgres 

func NewPostgres(config config.Config, log log.Log, connection string) *Postgres

func (*Postgres) Docker 

func (r *Postgres) Docker() (docker.DatabaseDriver, error)

func (*Postgres) Grammar added in v1.4.0 

func (r *Postgres) Grammar() driver.Grammar

func (*Postgres) Pool added in v1.4.0 

func (r *Postgres) Pool() database.Pool

func (*Postgres) Processor added in v1.4.0 

func (r *Postgres) Processor() driver.Processor

type Processor added in v1.4.0 

type Processor struct {
}

func NewProcessor added in v1.4.0 

func NewProcessor() *Processor

func (Processor) ProcessColumns added in v1.4.0 

func (r Processor) ProcessColumns(dbColumns []driver.DBColumn) []driver.Column

func (Processor) ProcessForeignKeys added in v1.4.0 

func (r Processor) ProcessForeignKeys(dbForeignKeys []driver.DBForeignKey) []driver.ForeignKey

func (Processor) ProcessIndexes added in v1.4.0 

func (r Processor) ProcessIndexes(dbIndexes []driver.DBIndex) []driver.Index

func (Processor) ProcessTypes added in v1.4.0 

func (r Processor) ProcessTypes(types []driver.Type) []driver.Type

type ServiceProvider 

type ServiceProvider struct {
}

func (*ServiceProvider) Boot 

func (r *ServiceProvider) Boot(app foundation.Application)

func (*ServiceProvider) Register 

func (r *ServiceProvider) Register(app foundation.Application)

func (*ServiceProvider) Relationship added in v1.4.0 

func (r *ServiceProvider) Relationship() binding.Relationship

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.