oracle

README

GORM Oracle Driver

Description

GORM Oracle driver for connect Oracle DB and Manage Oracle DB, Based on CengSin/oracle and sijms/go-ora (pure go oracle client)，not recommended for use in a production environment.

Required dependency Install

• Oracle 12C+
• Golang 1.20+
• gorm 1.24.0+

Quick Start

How to install

go get -u gitlab.com/CoiaPrant/gorm-oracle

Usage

package main

import (
	oracle "gitlab.com/CoiaPrant/gorm-oracle"
	"gorm.io/gorm"
)

func main() {
	// oracle://user:password@127.0.0.1:1521/service
	url := oracle.BuildUrl("127.0.0.1", "1521", "service", "user", "password", nil)
	db, err := gorm.Open(oracle.Open(url), &gorm.Config{})
	if err != nil {
		// panic error or log error info
	}

	// do somethings
}

Documentation

Index

• Constants
• Variables
• func BuildJDBC(user, password, connStr string, options map[string]string) string
• func BuildUrl(server string, port int, service, user, password string, ...) string
• func Create(db *gorm.DB)
• func New(config Config) gorm.Dialector
• func Open(dsn string) gorm.Dialector
• type Arg
• type Config
• type Dialector
  • func (d Dialector) BindVarTo(writer clause.Writer, stmt *gorm.Statement, v interface{})
  • func (d Dialector) ClauseBuilders() map[string]clause.ClauseBuilder
  • func (dialector Dialector) DataTypeOf(field *schema.Field) string
  • func (d Dialector) DefaultValueOf(*schema.Field) clause.Expression
  • func (d Dialector) DummyTableName() string
  • func (d Dialector) Explain(rawSQL string, vars ...interface{}) string
  • func (d Dialector) Initialize(db *gorm.DB) (err error)
  • func (d Dialector) Migrator(db *gorm.DB) gorm.Migrator
  • func (d Dialector) Name() string
  • func (d Dialector) QuoteTo(writer clause.Writer, str string)
  • func (dialector Dialector) RollbackTo(tx *gorm.DB, name string) error
  • func (dialector Dialector) SavePoint(tx *gorm.DB, name string) error
• type Migrator
  • func (m Migrator) AlterColumn(value interface{}, field string) error
  • func (m Migrator) ColumnTypes(value interface{}) ([]gorm.ColumnType, error)
  • func (m Migrator) CreateConstraint(value interface{}, name string) error
  • func (m Migrator) CreateTable(values ...interface{}) (err error)
  • func (m Migrator) CurrentDatabase() (name string)
  • func (m Migrator) CurrentSchema(table string) (string, string)
  • func (m Migrator) DropConstraint(value interface{}, name string) error
  • func (m Migrator) DropIndex(value interface{}, name string) error
  • func (m Migrator) DropTable(values ...interface{}) error
  • func (m Migrator) FullDataTypeOf(field *schema.Field) (expr clause.Expr)
  • func (m Migrator) GetTypeAliases(databaseTypeName string) []string
  • func (m Migrator) HasColumn(value interface{}, field string) bool
  • func (m Migrator) HasConstraint(value interface{}, name string) bool
  • func (m Migrator) HasIndex(value interface{}, name string) bool
  • func (m Migrator) HasTable(value interface{}) bool
  • func (m Migrator) RenameIndex(value interface{}, oldName, newName string) error
  • func (m Migrator) RenameTable(oldName, newName interface{}) (err error)
  • func (m Migrator) TryRemoveOnUpdate(values ...interface{}) error
• type Returning
  • func (returning Returning) Build(builder clause.Builder)
  • func (returning Returning) MergeClause(clause *clause.Clause)
  • func (returning Returning) Name() string

Constants

const (
	// ClauseLimit for clause.ClauseBuilder LIMIT key
	ClauseLimit = "LIMIT"
)

Variables

var (
	// CreateClauses create clauses
	CreateClauses = []string{"INSERT", "VALUES", "ON CONFLICT", "RETURNING INTO"}
	// QueryClauses query clauses
	QueryClauses = []string{}
	// UpdateClauses update clauses
	UpdateClauses = []string{"UPDATE", "SET", "WHERE", "ORDER BY", "LIMIT"}
	// DeleteClauses delete clauses
	DeleteClauses = []string{"DELETE", "FROM", "WHERE", "ORDER BY", "LIMIT"}
)

Functions

func BuildJDBC

func BuildJDBC(user, password, connStr string, options map[string]string) string

func BuildUrl

func BuildUrl(server string, port int, service, user, password string, options map[string]string) string

func Create

func Create(db *gorm.DB)

func New

func New(config Config) gorm.Dialector

func Open

func Open(dsn string) gorm.Dialector

Types

type Arg

type Arg struct {
	Value any
	Size  int
}

type Config

type Config struct {
	DriverName        string
	DSN               string
	Conn              gorm.ConnPool
	DefaultStringSize uint
}

type Dialector

type Dialector struct {
	*Config
}

func (Dialector) BindVarTo

func (d Dialector) BindVarTo(writer clause.Writer, stmt *gorm.Statement, v interface{})

func (Dialector) ClauseBuilders

func (d Dialector) ClauseBuilders() map[string]clause.ClauseBuilder

func (Dialector) DataTypeOf

func (dialector Dialector) DataTypeOf(field *schema.Field) string

func (Dialector) DefaultValueOf

func (d Dialector) DefaultValueOf(*schema.Field) clause.Expression

func (Dialector) DummyTableName

func (d Dialector) DummyTableName() string

func (Dialector) Explain

func (d Dialector) Explain(rawSQL string, vars ...interface{}) string

func (Dialector) Initialize

func (d Dialector) Initialize(db *gorm.DB) (err error)

func (Dialector) Migrator

func (d Dialector) Migrator(db *gorm.DB) gorm.Migrator

func (Dialector) Name

func (d Dialector) Name() string

func (Dialector) QuoteTo

func (d Dialector) QuoteTo(writer clause.Writer, str string)

func (Dialector) RollbackTo

func (dialector Dialector) RollbackTo(tx *gorm.DB, name string) error

func (Dialector) SavePoint

func (dialector Dialector) SavePoint(tx *gorm.DB, name string) error

type Migrator

type Migrator struct {
	migrator.Migrator
	Dialector
}

func (Migrator) AlterColumn

func (m Migrator) AlterColumn(value interface{}, field string) error

func (Migrator) ColumnTypes

func (m Migrator) ColumnTypes(value interface{}) ([]gorm.ColumnType, error)

ColumnTypes column types return columnTypes,error

func (Migrator) CreateConstraint

func (m Migrator) CreateConstraint(value interface{}, name string) error

func (Migrator) CreateTable

func (m Migrator) CreateTable(values ...interface{}) (err error)

func (Migrator) CurrentDatabase

func (m Migrator) CurrentDatabase() (name string)

func (Migrator) CurrentSchema

func (m Migrator) CurrentSchema(table string) (string, string)

func (Migrator) DropConstraint

func (m Migrator) DropConstraint(value interface{}, name string) error

func (Migrator) DropIndex

func (m Migrator) DropIndex(value interface{}, name string) error

func (Migrator) DropTable

func (m Migrator) DropTable(values ...interface{}) error

func (Migrator) FullDataTypeOf

func (m Migrator) FullDataTypeOf(field *schema.Field) (expr clause.Expr)

func (Migrator) GetTypeAliases

func (m Migrator) GetTypeAliases(databaseTypeName string) []string

func (Migrator) HasColumn

func (m Migrator) HasColumn(value interface{}, field string) bool

func (Migrator) HasConstraint

func (m Migrator) HasConstraint(value interface{}, name string) bool

func (Migrator) HasIndex

func (m Migrator) HasIndex(value interface{}, name string) bool

func (Migrator) HasTable

func (m Migrator) HasTable(value interface{}) bool

func (Migrator) RenameIndex

func (m Migrator) RenameIndex(value interface{}, oldName, newName string) error

func (Migrator) RenameTable

func (m Migrator) RenameTable(oldName, newName interface{}) (err error)

func (Migrator) TryRemoveOnUpdate

func (m Migrator) TryRemoveOnUpdate(values ...interface{}) error

type Returning

type Returning struct {
	Columns []clause.Column
	Args    []Arg
}

func (Returning) Build

func (returning Returning) Build(builder clause.Builder)

Build build where clause

func (Returning) MergeClause

func (returning Returning) MergeClause(clause *clause.Clause)

MergeClause merge order by clauses

func (Returning) Name

func (returning Returning) Name() string

Name where clause name