secondaryindex

Documentation

Index

• Variables
• func ArrayIndex_Range(indexName, bucketName, server string, low, high []interface{}, ...) (tc.ArrayIndexScanResponse, error)
• func BuildAllSecondaryIndexes(server string, indexActiveTimeoutSeconds int64) error
• func BuildIndex(indexName, bucketName, server string, indexActiveTimeoutSeconds int64) error
• func BuildIndexes(indexNames []string, bucketName, server string, ...) error
• func BuildIndexesAsync(defnIds []uint64, server string, indexActiveTimeoutSeconds int64) error
• func ChangeIndexerSettings(configKey string, configValue interface{}, ...) error
• func CountLookup(indexName, bucketName, server string, values []interface{}, ...) (int64, error)
• func CountRange(indexName, bucketName, server string, low, high []interface{}, ...) (int64, error)
• func CreateClient(server, serviceAddr string) (*qc.GsiClient, error)
• func CreateSecondaryIndex(indexName, bucketName, server, whereExpr string, indexFields []string, ...) error
• func CreateSecondaryIndex2(indexName, bucketName, server, whereExpr string, indexFields []string, ...) error
• func CreateSecondaryIndexAsync(indexName, bucketName, server, whereExpr string, indexFields []string, ...) error
• func DropAllSecondaryIndexes(server string) error
• func DropSecondaryIndex(indexName, bucketName, server string) error
• func DropSecondaryIndexByID(indexDefnID uint64, server string) error
• func DropSecondaryIndexWithClient(indexName, bucketName, server string, client *qc.GsiClient) error
• func GetDefnID(client *qc.GsiClient, bucket, indexName string) (defnID uint64, ok bool)
• func GetIndexHostNode(indexName, bucketName, serverUserName, serverPassword, hostaddress string) (string, error)
• func GetIndexHttpPort(indexHostAddress, serverUserName, serverPassword, hostaddress string) string
• func GetIndexStats(indexName, bucketName, serverUserName, serverPassword, hostaddress string) map[string]interface{}
• func GetIndexerNodesHttpAddresses(hostaddress string) ([]string, error)
• func GetStatsForIndexerHttpAddress(indexerHttpAddr, serverUserName, serverPassword string) map[string]interface{}
• func IndexExists(indexName, bucketName, server string) (bool, error)
• func IndexExistsWithClient(indexName, bucketName, server string, client *qc.GsiClient) bool
• func IndexState(indexName, bucketName, server string) (string, error)
• func Lookup(indexName, bucketName, server string, values []interface{}, distinct bool, ...) (tc.ScanResponse, error)
• func MultiScanCount(indexName, bucketName, server string, scans qc.Scans, distinct bool, ...) (int64, error)
• func N1QLCreateSecondaryIndex(indexName, bucketName, server, whereExpr string, indexFields []string, ...) error
• func N1QLLookup(indexName, bucketName, server string, values []interface{}, distinct bool, ...) (tc.ScanResponse, error)
• func N1QLMultiScanCount(indexName, bucketName, server string, scans qc.Scans, distinct bool, ...) (int64, error)
• func N1QLRange(indexName, bucketName, server string, low, high []interface{}, ...) (tc.ScanResponse, error)
• func N1QLScanAll(indexName, bucketName, server string, limit int64, consistency c.Consistency, ...) (tc.ScanResponse, error)
• func N1QLScans(indexName, bucketName, server string, scans qc.Scans, reverse, distinct bool, ...) (tc.ScanResponse, error)
• func Range(indexName, bucketName, server string, low, high []interface{}, ...) (tc.ScanResponse, error)
• func RangeStatistics(indexName, bucketName, server string, low, high []interface{}, ...) error
• func RangeWithClient(indexName, bucketName, server string, low, high []interface{}, ...) (tc.ScanResponse, error)
• func ScanAll(indexName, bucketName, server string, limit int64, consistency c.Consistency, ...) (tc.ScanResponse, error)
• func Scans(indexName, bucketName, server string, scans qc.Scans, reverse, distinct bool, ...) (tc.ScanResponse, error)
• func WaitForIndexOnline(n1qlclient datastore.Indexer, indexName string, index datastore.Index) (datastore.Index, error)
• func WaitTillAllIndexNodesActive(server string, indexerActiveTimeoutSeconds int64) error
• func WaitTillIndexActive(defnID uint64, client *qc.GsiClient, indexActiveTimeoutSeconds int64) error
• type IndexProperties

Variables

var CheckCollation = false

var DescCollation = false

var IndexUsing = "gsi"

var UseClient = "gsi"

Functions

func ArrayIndex_Range

func ArrayIndex_Range(indexName, bucketName, server string, low, high []interface{}, inclusion uint32,
	distinct bool, limit int64, consistency c.Consistency, vector *qc.TsConsistency) (tc.ArrayIndexScanResponse, error)

func BuildAllSecondaryIndexes

func BuildAllSecondaryIndexes(server string, indexActiveTimeoutSeconds int64) error

func BuildIndex

func BuildIndex(indexName, bucketName, server string, indexActiveTimeoutSeconds int64) error

Todo: Remove this function and update functional tests to use BuildIndexes

func BuildIndexes

func BuildIndexes(indexNames []string, bucketName, server string, indexActiveTimeoutSeconds int64) error

func BuildIndexesAsync

func BuildIndexesAsync(defnIds []uint64, server string, indexActiveTimeoutSeconds int64) error

func ChangeIndexerSettings

func ChangeIndexerSettings(configKey string, configValue interface{}, serverUserName, serverPassword, hostaddress string) error

func CountLookup

func CountLookup(indexName, bucketName, server string, values []interface{},
	consistency c.Consistency, vector *qc.TsConsistency) (int64, error)

func CountRange

func CountRange(indexName, bucketName, server string, low, high []interface{}, inclusion uint32,
	consistency c.Consistency, vector *qc.TsConsistency) (int64, error)

func CreateClient

func CreateClient(server, serviceAddr string) (*qc.GsiClient, error)

func CreateSecondaryIndex

func CreateSecondaryIndex(
	indexName, bucketName, server, whereExpr string, indexFields []string, isPrimary bool, with []byte,
	skipIfExists bool, indexActiveTimeoutSeconds int64, client *qc.GsiClient) error

Creates an index and waits for it to become active

func CreateSecondaryIndex2

func CreateSecondaryIndex2(
	indexName, bucketName, server, whereExpr string, indexFields []string, desc []bool, isPrimary bool, with []byte,
	skipIfExists bool, indexActiveTimeoutSeconds int64, client *qc.GsiClient) error

Creates an index and waits for it to become active

func CreateSecondaryIndexAsync

func CreateSecondaryIndexAsync(
	indexName, bucketName, server, whereExpr string, indexFields []string, isPrimary bool, with []byte,
	skipIfExists bool, client *qc.GsiClient) error

Creates an index and DOES NOT wait for it to become active

func DropAllSecondaryIndexes

func DropAllSecondaryIndexes(server string) error

func DropSecondaryIndex

func DropSecondaryIndex(indexName, bucketName, server string) error

func DropSecondaryIndexByID

func DropSecondaryIndexByID(indexDefnID uint64, server string) error

func DropSecondaryIndexWithClient

func DropSecondaryIndexWithClient(indexName, bucketName, server string, client *qc.GsiClient) error

func GetDefnID

func GetDefnID(client *qc.GsiClient, bucket, indexName string) (defnID uint64, ok bool)

func GetIndexHostNode

func GetIndexHostNode(indexName, bucketName, serverUserName, serverPassword, hostaddress string) (string, error)

func GetIndexHttpPort

func GetIndexHttpPort(indexHostAddress, serverUserName, serverPassword, hostaddress string) string

func GetIndexStats

func GetIndexStats(indexName, bucketName, serverUserName, serverPassword, hostaddress string) map[string]interface{}

func GetIndexerNodesHttpAddresses

func GetIndexerNodesHttpAddresses(hostaddress string) ([]string, error)

func GetStatsForIndexerHttpAddress

func GetStatsForIndexerHttpAddress(indexerHttpAddr, serverUserName, serverPassword string) map[string]interface{}

func IndexExists

func IndexExists(indexName, bucketName, server string) (bool, error)

func IndexExistsWithClient

func IndexExistsWithClient(indexName, bucketName, server string, client *qc.GsiClient) bool

func IndexState

func IndexState(indexName, bucketName, server string) (string, error)

func Lookup

func Lookup(indexName, bucketName, server string, values []interface{}, distinct bool, limit int64, consistency c.Consistency, vector *qc.TsConsistency) (tc.ScanResponse, error)

func MultiScanCount

func MultiScanCount(indexName, bucketName, server string, scans qc.Scans, distinct bool,
	consistency c.Consistency, vector *qc.TsConsistency) (int64, error)

func N1QLCreateSecondaryIndex

func N1QLCreateSecondaryIndex(
	indexName, bucketName, server, whereExpr string, indexFields []string, isPrimary bool, with []byte,
	skipIfExists bool, indexActiveTimeoutSeconds int64) error

Creates an index and waits for it to become active

func N1QLLookup

func N1QLLookup(indexName, bucketName, server string, values []interface{},
	distinct bool, limit int64, consistency c.Consistency, vector *qc.TsConsistency) (tc.ScanResponse, error)

func N1QLMultiScanCount

func N1QLMultiScanCount(indexName, bucketName, server string, scans qc.Scans, distinct bool,
	consistency c.Consistency, vector *qc.TsConsistency) (int64, error)

func N1QLRange

func N1QLRange(indexName, bucketName, server string, low, high []interface{}, inclusion uint32,
	distinct bool, limit int64, consistency c.Consistency, vector *qc.TsConsistency) (tc.ScanResponse, error)

func N1QLScanAll

func N1QLScanAll(indexName, bucketName, server string, limit int64,
	consistency c.Consistency, vector *qc.TsConsistency) (tc.ScanResponse, error)

func N1QLScans

func N1QLScans(indexName, bucketName, server string, scans qc.Scans, reverse, distinct bool,
	projection *qc.IndexProjection, offset, limit int64,
	consistency c.Consistency, vector *qc.TsConsistency) (tc.ScanResponse, error)

func Range

func Range(indexName, bucketName, server string, low, high []interface{}, inclusion uint32,
	distinct bool, limit int64, consistency c.Consistency, vector *qc.TsConsistency) (tc.ScanResponse, error)

func RangeStatistics

func RangeStatistics(indexName, bucketName, server string, low, high []interface{}, inclusion uint32) error

func RangeWithClient

func RangeWithClient(indexName, bucketName, server string, low, high []interface{}, inclusion uint32,
	distinct bool, limit int64, consistency c.Consistency, vector *qc.TsConsistency, client *qc.GsiClient) (tc.ScanResponse, error)

func ScanAll

func ScanAll(indexName, bucketName, server string, limit int64, consistency c.Consistency, vector *qc.TsConsistency) (tc.ScanResponse, error)

func Scans

func Scans(indexName, bucketName, server string, scans qc.Scans, reverse, distinct bool,
	projection *qc.IndexProjection, offset, limit int64,
	consistency c.Consistency, vector *qc.TsConsistency) (tc.ScanResponse, error)

func WaitForIndexOnline

func WaitForIndexOnline(n1qlclient datastore.Indexer, indexName string, index datastore.Index) (datastore.Index, error)

func WaitTillAllIndexNodesActive

func WaitTillAllIndexNodesActive(server string, indexerActiveTimeoutSeconds int64) error

func WaitTillIndexActive

func WaitTillIndexActive(defnID uint64, client *qc.GsiClient, indexActiveTimeoutSeconds int64) error

Types

type IndexProperties

type IndexProperties struct {
	HostNode      string
	HttpPort      string
	Bucket        string
	IndexFilePath string
}