database/tidb
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

kv: update comments

Browse Source
This commit is contained in:
xia
2015-12-03 19:22:46 +08:00
parent 2eb7b3154b
commit 39fe75facb
1 changed files with 14 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
kv/kv.go
View File

@ -261,11 +261,18 @@ type IndexIterator interface {
// Index is the interface for index data on KV store.
type Index interface {
Create(txn Transaction, indexedValues []interface{}, h int64) error // supports insert into statement
Delete(txn Transaction, indexedValues []interface{}, h int64) error // supports delete from statement
Drop(txn Transaction) error // supports drop table, drop index statements
Exist(txn Transaction, indexedValues []interface{}, h int64) (bool, int64, error) // supports check index exist
GenIndexKey(indexedValues []interface{}, h int64) (key []byte, distinct bool, err error) // supports index check
Seek(txn Transaction, indexedValues []interface{}) (iter IndexIterator, hit bool, err error) // supports where clause
SeekFirst(txn Transaction) (iter IndexIterator, err error) // supports aggregate min / ascending order by
// Create supports insert into statement.
Create(txn Transaction, indexedValues []interface{}, h int64) error
// Delete supports delete from statement.
Delete(txn Transaction, indexedValues []interface{}, h int64) error
// Drop supports drop table, drop index statements.
Drop(txn Transaction) error
// Exist supports check index exists or not.
Exist(txn Transaction, indexedValues []interface{}, h int64) (bool, int64, error)
// GenIndexKey generates an index key.
GenIndexKey(indexedValues []interface{}, h int64) (key []byte, distinct bool, err error)
// Seek supports where clause.
Seek(txn Transaction, indexedValues []interface{}) (iter IndexIterator, hit bool, err error)
// SeekFirst supports aggregate min and ascend order by.
SeekFirst(txn Transaction) (iter IndexIterator, err error)
}