Documentation
¶
Overview ¶
Package vanilla provides a re-usable table API.
Index ¶
- Constants
- type Record
- type RecordTable
- func (tbl RecordTable) BeginTx(opts *sql.TxOptions) (RecordTable, error)
- func (tbl RecordTable) Constraints() constraint.Constraints
- func (tbl RecordTable) Ctx() context.Context
- func (tbl RecordTable) DB() sqlapi.SqlDB
- func (tbl RecordTable) Database() sqlapi.Database
- func (tbl RecordTable) Dialect() dialect.Dialect
- func (tbl RecordTable) Execer() sqlapi.Execer
- func (tbl RecordTable) IsTx() bool
- func (tbl RecordTable) Logger() sqlapi.Logger
- func (tbl RecordTable) Name() sqlapi.TableName
- func (tbl RecordTable) PkColumn() string
- func (tbl RecordTable) Query(query string, args ...interface{}) (sqlapi.SqlRows, error)
- func (tbl RecordTable) QueryOneNullFloat64(req require.Requirement, query string, args ...interface{}) (result sql.NullFloat64, err error)
- func (tbl RecordTable) QueryOneNullInt64(req require.Requirement, query string, args ...interface{}) (result sql.NullInt64, err error)
- func (tbl RecordTable) QueryOneNullString(req require.Requirement, query string, args ...interface{}) (result sql.NullString, err error)
- func (tbl RecordTable) SetPkColumn(pk string) RecordTable
- func (tbl RecordTable) Tx() sqlapi.SqlTx
- func (tbl RecordTable) Using(tx sqlapi.SqlTx) RecordTable
- func (tbl RecordTable) WithConstraint(cc ...constraint.Constraint) RecordTable
- func (tbl RecordTable) WithContext(ctx context.Context) RecordTable
- func (tbl RecordTable) WithPrefix(pfx string) RecordTable
Constants ¶
const NumRecordColumns = 1
NumRecordColumns is the total number of columns in Record.
const NumRecordDataColumns = 0
NumRecordDataColumns is the number of columns in Record not including the auto-increment key.
const RecordColumnNames = "id"
RecordColumnNames is the list of columns in Record.
const RecordDataColumnNames = ""
RecordDataColumnNames is the list of data columns in Record.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Record ¶
type Record struct {
Id int64 `sql:"pk: true, auto: true"`
}
Record provides access to the primary key only; all other database columns are ignored. This is useful in situations where identity is the only concern.
type RecordTable ¶
type RecordTable struct {
// contains filtered or unexported fields
}
RecordTable holds a given table name with the database reference, providing access methods below. The Prefix field is often blank but can be used to hold a table name prefix (e.g. ending in '_'). Or it can specify the name of the schema, in which case it should have a trailing '.'.
func CopyTableAsRecordTable ¶
func CopyTableAsRecordTable(origin sqlapi.Table) RecordTable
CopyTableAsRecordTable copies a table instance, retaining the name etc but providing methods appropriate for 'Record'. It doesn't copy the constraints of the original table.
It serves to provide methods appropriate for 'Record'. This is most useful when this is used to represent a join result. In such cases, there won't be any need for DDL methods, nor Exec, Insert, Update or Delete.
func NewRecordTable ¶
func NewRecordTable(name string, d sqlapi.Database) RecordTable
NewRecordTable returns a new table instance. If a blank table name is supplied, the default name "records" will be used instead. The request context is initialised with the background.
func (RecordTable) BeginTx ¶
func (tbl RecordTable) BeginTx(opts *sql.TxOptions) (RecordTable, error)
BeginTx starts a transaction using the table's context. This context is used until the transaction is committed or rolled back.
If this context is cancelled, the sql package will roll back the transaction. In this case, Tx.Commit will then return an error.
The provided TxOptions is optional and may be nil if defaults should be used. If a non-default isolation level is used that the driver doesn't support, an error will be returned.
Panics if the Execer is not SqlDB.
func (RecordTable) Constraints ¶
func (tbl RecordTable) Constraints() constraint.Constraints
Constraints returns the table's constraints.
func (RecordTable) Ctx ¶
func (tbl RecordTable) Ctx() context.Context
Ctx gets the current request context.
func (RecordTable) DB ¶
func (tbl RecordTable) DB() sqlapi.SqlDB
DB gets the wrapped database handle, provided this is not within a transaction. Panics if it is in the wrong state - use IsTx() if necessary.
func (RecordTable) Database ¶
func (tbl RecordTable) Database() sqlapi.Database
Database gets the shared database information.
func (RecordTable) Dialect ¶
func (tbl RecordTable) Dialect() dialect.Dialect
Dialect gets the database dialect.
func (RecordTable) Execer ¶
func (tbl RecordTable) Execer() sqlapi.Execer
Execer gets the wrapped database or transaction handle.
func (RecordTable) IsTx ¶
func (tbl RecordTable) IsTx() bool
IsTx tests whether this is within a transaction.
func (RecordTable) Logger ¶
func (tbl RecordTable) Logger() sqlapi.Logger
Logger gets the trace logger.
func (RecordTable) PkColumn ¶
func (tbl RecordTable) PkColumn() string
PkColumn gets the column name used as a primary key.
func (RecordTable) Query ¶
func (tbl RecordTable) Query(query string, args ...interface{}) (sqlapi.SqlRows, error)
Query is the low-level request method for this table. The query is logged using whatever logger is configured. If an error arises, this too is logged.
If you need a context other than the background, use WithContext before calling Query.
The args are for any placeholder parameters in the query.
The caller must call rows.Close() on the result.
Wrap the result in *sqlapi.Rows if you need to access its data as a map.
func (RecordTable) QueryOneNullFloat64 ¶
func (tbl RecordTable) QueryOneNullFloat64(req require.Requirement, query string, args ...interface{}) (result sql.NullFloat64, err error)
QueryOneNullFloat64 is a low-level access method for one float64. This can be used for 'AVG(...)' queries and such like. If the query selected many rows, only the first is returned; the rest are discarded. If not found, the result will be invalid.
Note that this applies ReplaceTableName to the query string.
The args are for any placeholder parameters in the query.
func (RecordTable) QueryOneNullInt64 ¶
func (tbl RecordTable) QueryOneNullInt64(req require.Requirement, query string, args ...interface{}) (result sql.NullInt64, err error)
QueryOneNullInt64 is a low-level access method for one int64. This can be used for 'COUNT(1)' queries and such like. If the query selected many rows, only the first is returned; the rest are discarded. If not found, the result will be invalid.
Note that this applies ReplaceTableName to the query string.
The args are for any placeholder parameters in the query.
func (RecordTable) QueryOneNullString ¶
func (tbl RecordTable) QueryOneNullString(req require.Requirement, query string, args ...interface{}) (result sql.NullString, err error)
QueryOneNullString is a low-level access method for one string. This can be used for function queries and such like. If the query selected many rows, only the first is returned; the rest are discarded. If not found, the result will be invalid.
Note that this applies ReplaceTableName to the query string.
The args are for any placeholder parameters in the query.
func (RecordTable) SetPkColumn ¶
func (tbl RecordTable) SetPkColumn(pk string) RecordTable
SetPkColumn sets the name of the primary key column. It defaults to "id". The result is a modified copy of the table; the original is unchanged.
func (RecordTable) Tx ¶
func (tbl RecordTable) Tx() sqlapi.SqlTx
Tx gets the wrapped transaction handle, provided this is within a transaction. Panics if it is in the wrong state - use IsTx() if necessary.
func (RecordTable) Using ¶
func (tbl RecordTable) Using(tx sqlapi.SqlTx) RecordTable
Using returns a modified Table using the transaction supplied. This is needed when making multiple queries across several tables within a single transaction. The result is a modified copy of the table; the original is unchanged.
func (RecordTable) WithConstraint ¶
func (tbl RecordTable) WithConstraint(cc ...constraint.Constraint) RecordTable
WithConstraint returns a modified Table with added data consistency constraints.
func (RecordTable) WithContext ¶
func (tbl RecordTable) WithContext(ctx context.Context) RecordTable
WithContext sets the context for subsequent queries via this table. The result is a modified copy of the table; the original is unchanged.
The shared context in the *Database is not altered by this method. So it is possible to use different contexts for different (groups of) queries.
func (RecordTable) WithPrefix ¶
func (tbl RecordTable) WithPrefix(pfx string) RecordTable
WithPrefix sets the table name prefix for subsequent queries. The result is a modified copy of the table; the original is unchanged.
Source Files