postgresql

package
v1.13.2 Latest Latest
Warning

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

Go to latest
Published: Jul 21, 2026 License: MIT Imports: 10 Imported by: 0

Documentation

Overview

Package postgresql provides a database provider for PostgreSQL.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Provider

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

Provider implements the Provider interface for PostgreSQL

func New

func New() *Provider

New creates a new PostgreSQL provider

func (*Provider) ConvertFieldType

func (p *Provider) ConvertFieldType(field *types.Field) string

ConvertFieldType converts YAML field type to PostgreSQL-specific SQL type

func (*Provider) ConvertFieldTypeWithSchema

func (p *Provider) ConvertFieldTypeWithSchema(schema *types.Schema, field *types.Field) string

ConvertFieldTypeWithSchema converts YAML field type to PostgreSQL-specific SQL type with schema context for foreign keys

func (*Provider) GenerateAddColumn

func (p *Provider) GenerateAddColumn(tableName string, field *types.Field) string

GenerateAddColumn generates ALTER TABLE ADD COLUMN statement. The DEFAULT clause is emitted when field.Default is non-empty (already resolved from symbolic keys by resolveFieldDefault before this is called).

func (*Provider) GenerateAlterColumn

func (p *Provider) GenerateAlterColumn(tableName string, oldField, newField *types.Field) (string, error)

GenerateAlterColumn generates one or more ALTER TABLE … ALTER COLUMN statements to transition a column from oldField to newField. Each distinct change (type, nullability, default) becomes its own statement, separated by newlines. Returns an empty string when no attributes differ.

func (*Provider) GenerateCreateIndex

func (p *Provider) GenerateCreateIndex(index *types.Index, tableName string) string

GenerateCreateIndex generates CREATE INDEX statement for PostgreSQL

func (*Provider) GenerateCreateTable

func (p *Provider) GenerateCreateTable(schema *types.Schema, table *types.Table) (string, error)

GenerateCreateTable generates the CREATE TABLE SQL statement for the given table.

func (*Provider) GenerateDropColumn

func (p *Provider) GenerateDropColumn(tableName, columnName string) string

GenerateDropColumn generates ALTER TABLE DROP COLUMN statement

func (*Provider) GenerateDropForeignKeyConstraint

func (p *Provider) GenerateDropForeignKeyConstraint(tableName, constraintName string) string

GenerateDropForeignKeyConstraint generates an ALTER TABLE statement to drop a foreign key constraint.

func (*Provider) GenerateDropIndex

func (p *Provider) GenerateDropIndex(indexName, tableName string) string

GenerateDropIndex generates DROP INDEX statement for PostgreSQL

func (*Provider) GenerateDropTable

func (p *Provider) GenerateDropTable(tableName string) string

GenerateDropTable generates DROP TABLE statement

func (*Provider) GenerateDropTableCascade

func (p *Provider) GenerateDropTableCascade(tableName string) string

GenerateDropTableCascade generates DROP TABLE IF EXISTS ... CASCADE statement for PostgreSQL. The CASCADE clause automatically drops any dependent objects (such as foreign key constraints from other tables referencing this one), preventing ordering failures during rollback.

func (*Provider) GenerateForeignKeyConstraint

func (p *Provider) GenerateForeignKeyConstraint(tableName, fieldName, referencedTable, constraintName, onDelete, onUpdate string) string

GenerateForeignKeyConstraint generates an ALTER TABLE statement to add a foreign key constraint.

func (*Provider) GenerateForeignKeyConstraints

func (p *Provider) GenerateForeignKeyConstraints(schema *types.Schema, junctionTables []types.Table) string

GenerateForeignKeyConstraints generates all foreign key constraint SQL statements for a schema.

func (*Provider) GenerateIndexes

func (p *Provider) GenerateIndexes(schema *types.Schema) string

GenerateIndexes generates CREATE INDEX statements for all tables in the schema.

func (*Provider) GenerateJunctionTable

func (p *Provider) GenerateJunctionTable(table1, table2 string, schema *types.Schema) (string, error)

GenerateJunctionTable generates the CREATE TABLE SQL for a many-to-many junction table.

func (*Provider) GenerateRenameColumn

func (p *Provider) GenerateRenameColumn(tableName, oldName, newName string) string

GenerateRenameColumn generates ALTER TABLE RENAME COLUMN statement

func (*Provider) GenerateRenameTable

func (p *Provider) GenerateRenameTable(oldName, newName string) string

GenerateRenameTable generates ALTER TABLE RENAME statement

func (*Provider) GenerateUpsert

func (p *Provider) GenerateUpsert(table string, conflictKeys []string, columns []string, valueLiterals [][]string) string

GenerateUpsert generates a multi-row INSERT ... ON CONFLICT DO UPDATE SET statement for PostgreSQL. It accepts pre-formatted SQL value literals that are inserted as-is. If all columns are conflict keys, DO NOTHING is used instead of DO UPDATE SET. Returns an empty string if valueLiterals is empty.

func (*Provider) GetDatabaseSchema

func (p *Provider) GetDatabaseSchema(connectionString string) (*types.Schema, error)

GetDatabaseSchema extracts schema information from a PostgreSQL database

func (*Provider) GetDefaultValue

func (p *Provider) GetDefaultValue(defaultRef string, defaults map[string]string) (string, error)

GetDefaultValue converts default value references to PostgreSQL-specific values

func (*Provider) HistoryTableDDL

func (p *Provider) HistoryTableDDL() string

HistoryTableDDL returns the CREATE TABLE IF NOT EXISTS statement for the morphic_history migration-tracking table, using this provider's SQL dialect.

func (*Provider) InferForeignKeyType

func (p *Provider) InferForeignKeyType(referencedTable string, schema *types.Schema) string

InferForeignKeyType returns the SQL type to use for a foreign key column referencing the given table.

func (*Provider) IsAlreadyExistsError

func (p *Provider) IsAlreadyExistsError(err error) bool

IsAlreadyExistsError returns true when err indicates an object already exists in the database.

func (*Provider) IsNotFoundError

func (p *Provider) IsNotFoundError(err error) bool

IsNotFoundError returns true when err is a PostgreSQL "does not exist" error.

func (*Provider) Placeholder

func (p *Provider) Placeholder(n int) string

Placeholder returns the bind-parameter placeholder for the nth argument (1-indexed).

func (*Provider) QuoteName

func (p *Provider) QuoteName(name string) string

QuoteName quotes database identifiers for PostgreSQL

func (*Provider) SetTypeMappings

func (p *Provider) SetTypeMappings(mappings map[string]string)

SetTypeMappings sets user-defined type mappings for this provider.

func (*Provider) SupportsOperation

func (p *Provider) SupportsOperation(operation string) bool

SupportsOperation checks if PostgreSQL supports a specific operation

func (*Provider) TableColumns added in v1.12.0

func (p *Provider) TableColumns(db *sql.DB, tableName string) ([]string, error)

TableColumns returns the column names for the given table in the public schema. Returns nil, nil if the table does not exist.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL