firestore

Documentation

Index

• Constants
• func AddDocIDToResults(selectStmt *query.Select, results []map[string]interface{})
• func FindDocIDInWhere(qualify *expr.Qualify, args []interface{}) (string, bool, error)
• func FindDocIDValueInInsert(insertStmt *insert.Statement, args []interface{}) (string, bool, error)
• func HasDocIDInColumns(columns []string) bool
• func IsDocIDColumn(columnName string) bool
• type Config
  • func NewConfig() *Config
  • func ParseDSN(dsn string) (*Config, error)
• type Driver
  • func (d *Driver) Open(dsn string) (driver.Conn, error)
• type Result
  • func (r *Result) LastInsertId() (int64, error)
  • func (r *Result) RowsAffected() (int64, error)
• type Rows
  • func NewRows(results []map[string]interface{}, dryRun bool, selectStmt *query.Select) *Rows
  • func (r *Rows) Close() error
  • func (r *Rows) ColumnTypeDatabaseTypeName(index int) string
  • func (r *Rows) ColumnTypeNullable(index int) (nullable, ok bool)
  • func (r *Rows) ColumnTypeScanType(index int) reflect.Type
  • func (r *Rows) Columns() []string
  • func (r *Rows) Next(dest []driver.Value) error
• type Statement
  • func (s *Statement) Close() error
  • func (s *Statement) Exec(args []driver.Value) (driver.Result, error)
  • func (s *Statement) ExecContext(ctx context.Context, args []driver.NamedValue) (driver.Result, error)
  • func (s *Statement) NumInput() int
  • func (s *Statement) Query(args []driver.Value) (driver.Rows, error)
  • func (s *Statement) QueryContext(ctx context.Context, args []driver.NamedValue) (driver.Rows, error)
• type SubCollection

Constants

const DocIDColumn = "id"

Functions

func AddDocIDToResults

func AddDocIDToResults(selectStmt *query.Select, results []map[string]interface{})

AddDocIDToResults adds document ID to query results

func FindDocIDInWhere

func FindDocIDInWhere(qualify *expr.Qualify, args []interface{}) (string, bool, error)

FindDocIDInWhere extracts document ID from WHERE docid = 'value' clause

func FindDocIDValueInInsert

func FindDocIDValueInInsert(insertStmt *insert.Statement, args []interface{}) (string, bool, error)

FindDocIDValueInInsert finds the document ID value in the INSERT statement values

func HasDocIDInColumns

func HasDocIDInColumns(columns []string) bool

HasDocIDInColumns checks if the document ID column is present in the column list

func IsDocIDColumn

func IsDocIDColumn(columnName string) bool

IsDocIDColumn checks if a column name is the document ID column

Types

type Config

type Config struct {
	CredentialsFile string // Username
	Endpoint        string
	APIKey          string
	CredentialJSON  []byte
	CredentialsURL  string
	CredID          string //scy secret resource ID
	CredentialsKey  string
	UserAgent       string
	ProjectID       string // project ID
	QuotaProject    string
	Scopes          []string
	Location        string
	App             string
	url.Values
}

Config is a configuration parsed from a DSN string. If a new Config is created instead of being parsed from a DSN string, the NewConfig function should be used, which sets default values.

func NewConfig

func NewConfig() *Config

NewConfig creates a new Config and sets default values.

func ParseDSN

func ParseDSN(dsn string) (*Config, error)

ParseDSN parses the DSN string to a Config

type Driver

type Driver struct{}

Driver is the Firestore driver structure

func (*Driver) Open

func (d *Driver) Open(dsn string) (driver.Conn, error)

Open establishes a new connection to the Firestore database

type Result

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

func (*Result) LastInsertId

func (r *Result) LastInsertId() (int64, error)

func (*Result) RowsAffected

func (r *Result) RowsAffected() (int64, error)

type Rows

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

Rows represents a result set for a SQL query

func NewRows

func NewRows(results []map[string]interface{}, dryRun bool, selectStmt *query.Select) *Rows

NewRows creates a new result set from map values

func (*Rows) Close

func (r *Rows) Close() error

Close closes the rows iterator

func (*Rows) ColumnTypeDatabaseTypeName

func (r *Rows) ColumnTypeDatabaseTypeName(index int) string

ColumnTypeDatabaseTypeName returns the database type name of the column

func (*Rows) ColumnTypeNullable

func (r *Rows) ColumnTypeNullable(index int) (nullable, ok bool)

ColumnTypeNullable reports whether the column may be null ColumnTypeNullable reports whether the column may be null

func (*Rows) ColumnTypeScanType

func (r *Rows) ColumnTypeScanType(index int) reflect.Type

ColumnTypeScanType returns the ScanType of the column at the given index

func (*Rows) Columns

func (r *Rows) Columns() []string

Columns returns the names of the columns

func (*Rows) Next

func (r *Rows) Next(dest []driver.Value) error

Next moves the cursor to the next row

type Statement

type Statement struct {
	SQL string
	// contains filtered or unexported fields
}

func (*Statement) Close

func (s *Statement) Close() error

Close closes the statement

func (*Statement) Exec

func (s *Statement) Exec(args []driver.Value) (driver.Result, error)

Exec executes a non-query statement

func (*Statement) ExecContext

func (s *Statement) ExecContext(ctx context.Context, args []driver.NamedValue) (driver.Result, error)

ExecContext executes a non-query statement with context

func (*Statement) NumInput

func (s *Statement) NumInput() int

NumInput returns the number of placeholder parameters

func (*Statement) Query

func (s *Statement) Query(args []driver.Value) (driver.Rows, error)

Query runs query

func (*Statement) QueryContext

func (s *Statement) QueryContext(ctx context.Context, args []driver.NamedValue) (driver.Rows, error)

QueryContext executes a query statement with context

type SubCollection

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

SubCollection represents a subcollection reference