arango

Documentation

Index

• Constants
• func Open(config *Config) gorm.Dialector
• type Config
• type Dialector
  • func (dialector Dialector) BindVarTo(writer gormClause.Writer, stmt *gorm.Statement, v interface{})
  • func (dialector Dialector) CreateDatabaseIfNeeded(ctx context.Context, databaseName string) (driver.Database, error)
  • func (dialector Dialector) DataTypeOf(field *schema.Field) string
  • func (dialector Dialector) DatabaseExists(ctx context.Context, databaseName string) (bool, error)
  • func (dialector Dialector) DefaultValueOf(field *schema.Field) gormClause.Expression
  • func (dialector Dialector) Explain(sql string, vars ...interface{}) string
  • func (dialector Dialector) Initialize(db *gorm.DB) error
  • func (dialector Dialector) Migrator(db *gorm.DB) gorm.Migrator
  • func (dialector Dialector) Name() string
  • func (dialector Dialector) QuoteTo(writer gormClause.Writer, str string)
• type Migrator
  • func (m Migrator) AutoMigrate(values ...interface{}) error
  • func (m Migrator) CreateTable(values ...interface{}) error
  • func (m Migrator) CurrentDatabase() (name string)
  • func (m Migrator) DropTable(values ...interface{}) error
  • func (m Migrator) HasTable(value interface{}) bool

Constants

const DriverName = "gorm-arango"

DriverName is the default driver name for ArangoDB.

Functions

func Open

func Open(config *Config) gorm.Dialector

Open creates the dialect based on ArangoDB configuration.

Types

type Config

type Config struct {
	URI                  string        // URI where to find the database server (including protocol and port).
	User                 string        // Database user name
	Password             string        // Database user password
	Database             string        // Database name to use.
	Timeout              time.Duration // Maximum duration to wait until the initial connection with the database is established.
	MaxConnectionRetries uint64        // Maximum number of connection retries.
}

Config for the database.

type Dialector

type Dialector struct {
	DriverName string
	Config     *Config
	Conn       gorm.ConnPool

	Connection driver.Connection
	Client     driver.Client
	Database   driver.Database
}

Dialector GORM ArangoDB dialector

func (Dialector) BindVarTo

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

BindVarTo ...

func (Dialector) CreateDatabaseIfNeeded

func (dialector Dialector) CreateDatabaseIfNeeded(ctx context.Context, databaseName string) (driver.Database, error)

CreateDatabaseIfNeeded creates a database if it doesn't exist.

func (Dialector) DataTypeOf

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

DataTypeOf ...

func (Dialector) DatabaseExists

func (dialector Dialector) DatabaseExists(ctx context.Context, databaseName string) (bool, error)

DatabaseExists checks if a database exists.

func (Dialector) DefaultValueOf

func (dialector Dialector) DefaultValueOf(field *schema.Field) gormClause.Expression

DefaultValueOf ...

func (Dialector) Explain

func (dialector Dialector) Explain(sql string, vars ...interface{}) string

Explain ...

func (Dialector) Initialize

func (dialector Dialector) Initialize(db *gorm.DB) error

Initialize database based on dialector.Config.

func (Dialector) Migrator

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

Migrator ...

func (Dialector) Name

func (dialector Dialector) Name() string

Name returns the ArangoDB dialector name.

func (Dialector) QuoteTo

func (dialector Dialector) QuoteTo(writer gormClause.Writer, str string)

QuoteTo ...

type Migrator

type Migrator struct {
	migrator.Migrator
}

Migrator ...

func (Migrator) AutoMigrate

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

AutoMigrate ...

func (Migrator) CreateTable

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

CreateTable ...

func (Migrator) CurrentDatabase

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

CurrentDatabase ...

func (Migrator) DropTable

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

DropTable ...

func (Migrator) HasTable

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

HasTable ...