api

type ConsistencyOverride struct {
	Value gocql.Consistency
}

type DataStore interface {

	// Execute a query and return a ResultSet
	Execute(ctx context.Context, stmt Statement) (ResultSet, error)

	// ExecuteBatch make a single RPC call for multiple statement execution.
	ExecuteBatch(ctx context.Context, stmts []Statement) error

	// NewQuery creates a QueryBuilder object
	NewQuery() QueryBuilder

	// Returns the name of this DataStore
	Name() string
}

type Decorator func(ef FuncType) FuncType

type EntityKey interface {

	// TableName returns the name of the table
	TableName() string

	// Filter returns a filtering condition that is applied to key columns.
	// This is typically what is in the "Where" clause of a query
	Filter() (cql string, args []interface{}, err error)
}

type FuncType func() error

type MultiTable interface {

	// NewKey creates a EntityKey object with the given values
	NewKey(obj interface{}, value ...[]interface{}) []EntityKey

	// NewRangeKey creates a EntityKey object representing a range query on key
	// columns
	NewRangeKey(obj interface{}, filters []RangeFilter) []EntityKey

	Get(ctx context.Context, keys []EntityKey, objs *[]interface{}, fields []string) error

	// Delete removes all the objects represented by the keys
	Delete(ctx context.Context, keys []EntityKey) error

	// UpSert adds the object to the store regardless of its prior existence.
	UpSert(ctx context.Context, objs *[]interface{}) error

	// CompareAndSet persists the object only when the record dose not already
	// exist.
	CompareAndSet(ctx context.Context, objs *[]interface{}) error
}

type QueryBuilder interface {

	// Select returns a select query
	Select(columns ...string) qb.SelectBuilder

	// Insert returns an insert query.
	Insert(into string) qb.InsertBuilder

	// Update returns a update query.
	Update(table string) qb.UpdateBuilder

	// Delete returns a delete query
	Delete(from string) qb.DeleteBuilder
}

type QueryOverrides struct {
	Consistency *ConsistencyOverride
}

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

type ResultSet interface {

	// All returns all results in a SliceMap and cleans up itself.
	All(ctx context.Context) ([]map[string]interface{}, error)

	// One is deprecated
	One(ctx context.Context, dest ...interface{}) bool

	// Close closes the underlying iterator and returns any errors
	// that happened during the query or the iteration.
	Close() error

	// Applied shows whether a set was done in a compare-and-set operation
	Applied() bool

	// Next returns the next row out of the ResultSet. Empty map indicates
	// the end of ResultSet
	Next(ctx context.Context) (map[string]interface{}, error)

	// PagingState returns the paging state for the query
	PagingState() []byte
}

type Statement interface {
	ToSQL() (string, []interface{}, error)
	ToUql() (string, []interface{}, map[string]interface{}, error)
	StmtType() qb.StmtType
	IsCAS() bool
	GetData() qb.StatementAccessor
}

type Table interface {

	// NewKey creates a EntityKey object with the given values
	NewKey(obj interface{}, value ...interface{}) EntityKey

	// NewRangeKey creates a EntityKey object representing a range query on key
	// columns
	NewRangeKey(obj interface{}, filter RangeFilter) EntityKey

	// Get retrieves the object by its key. fields parameter allows users to
	// specify a subset of columns that they want to retrieve. all fields
	// are retrieved if fields is nil
	Get(ctx context.Context, key EntityKey, obj *interface{}, fields []string) error

	// Delete removes the object represented by the key
	Delete(ctx context.Context, key EntityKey) error

	// UpSert adds the object to the store regardless of its prior existence.
	UpSert(ctx context.Context, obj *interface{}) error

	// CompareAndSet persists the object only when the record dose not already
	// exist.
	CompareAndSet(ctx context.Context, obj *interface{}) error
}