statement.go

// Copyright 2014-2021 Aerospike, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package aerospike

import xornd "github.com/aerospike/aerospike-client-go/types/rand"

// Statement encapsulates query statement parameters.
type Statement struct {
	// Namespace determines query Namespace
	Namespace string

	// SetName determines query Set name (Optional)
	SetName string

	// IndexName determines query index name (Optional)
	// If not set, the server will determine the index from the filter's bin name.
	IndexName string

	// BinNames detemines bin names (optional)
	BinNames []string

	// Filter determines query index filter (Optional).
	// This filter is applied to the secondary index on query.
	// Query index filters must reference a bin which has a secondary index defined.
	Filter *Filter

	packageName  string
	functionName string
	functionArgs []Value

	// Ordered list of predicate expressions
	predExps []PredExp

	// TaskId determines query task id. (Optional)
	// This value is not used anymore and will be removed later.
	TaskId uint64

	// determines if the query should return data
	returnData bool
}

// NewStatement initializes a new Statement instance.
func NewStatement(ns string, set string, binNames ...string) *Statement {
	return &Statement{
		Namespace:  ns,
		SetName:    set,
		BinNames:   binNames,
		returnData: true,
		TaskId:     xornd.Uint64(),
	}
}

// SetFilter Sets a filter for the statement.
// Aerospike Server currently only supports using a single filter per statement/query.
func (stmt *Statement) SetFilter(filter *Filter) error {
	stmt.Filter = filter

	return nil
}

// SetPredExp sets low-level predicate expressions for the statement in postfix notation.
// Supported only by Aerospike Server v3.12+.
// Predicate expression filters are applied on the query results on the server.
// Predicate expression filters may occur on any bin in the record.
// To learn how to use this API, consult predexp_test.go file.
//
// Postfix notation is described here: http://wiki.c2.com/?PostfixNotation
//
// Example: (c >= 11 and c <= 20) or (d > 3 and (d < 5)
//
//  stmt.SetPredExp(
//    NewPredExpIntegerValue(11),
//    NewPredExpIntegerBin("c"),
//    NewPredExpIntegerGreaterEq(),
//    NewPredExpIntegerValue(20),
//    NewPredExpIntegerBin("c"),
//    NewPredExpIntegerLessEq(),
//    NewPredExpAnd(2),
//    NewPredExpIntegerValue(3),
//    NewPredExpIntegerBin("d"),
//    NewPredExpIntegerGreater(),
//    NewPredExpIntegerValue(5),
//    NewPredExpIntegerBin("d"),
//    NewPredExpIntegerLess(),
//    NewPredExpAnd(2),
//    NewPredExpOr(2)
//  );
//
//  // Record last update time > 2017-01-15
//  stmt.SetPredExp(
//    NewIntegerValue(time.Date(2017, 0, 15, 0, 0, 0, 0, time.UTC).UnixNano()),
//    NewPredExpRecLastUpdate(),
//    NewPredExpIntegerGreater(),
//  );
// NOTE: This feature is deprecated on Aerospike servers and will be removed in the future.
// It has been replaced by FilterExpressions.
func (stmt *Statement) SetPredExp(predexp ...PredExp) error {
	stmt.predExps = predexp
	return nil
}

// SetAggregateFunction sets aggregation function parameters.
// This function will be called on both the server
// and client for each selected item.
func (stmt *Statement) SetAggregateFunction(packageName string, functionName string, functionArgs []Value, returnData bool) {
	stmt.packageName = packageName
	stmt.functionName = functionName
	stmt.functionArgs = functionArgs
	stmt.returnData = returnData
}

// IsScan determines is the Statement is a full namespace/set scan or a selective Query.
func (stmt *Statement) IsScan() bool {
	return stmt.Filter == nil
}

// Always set the taskID client-side to a non-zero random value
func (stmt *Statement) prepare(returnData bool) {
	stmt.returnData = returnData
}