1
0
Fork 0
arangodb/arangod/Aql/Functions.h

419 lines
24 KiB
C++

////////////////////////////////////////////////////////////////////////////////
/// DISCLAIMER
///
/// Copyright 2014-2016 ArangoDB GmbH, Cologne, Germany
/// Copyright 2004-2014 triAGENS GmbH, Cologne, Germany
///
/// 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.
///
/// Copyright holder is ArangoDB GmbH, Cologne, Germany
///
/// @author Jan Steemann
////////////////////////////////////////////////////////////////////////////////
#ifndef ARANGOD_AQL_FUNCTIONS_H
#define ARANGOD_AQL_FUNCTIONS_H 1
#include "Basics/Common.h"
#include "Aql/AqlValue.h"
#include "Utils/AqlTransaction.h"
#include <functional>
#define TMPUSEVPACK 1
namespace arangodb {
namespace aql {
class Query;
typedef std::function<bool()> ExecutionCondition;
typedef std::vector<std::pair<AqlValue, TRI_document_collection_t const*>>
FunctionParameters;
typedef std::vector<AqlValue$> VPackFunctionParameters;
typedef std::function<AqlValue(arangodb::aql::Query*, arangodb::AqlTransaction*,
FunctionParameters const&)>
FunctionImplementation;
struct Functions {
//////////////////////////////////////////////////////////////////////////////
/// @brief called before a query starts
/// has the chance to set up any thread-local storage
//////////////////////////////////////////////////////////////////////////////
static void InitializeThreadContext();
//////////////////////////////////////////////////////////////////////////////
/// @brief called when a query ends
/// its responsibility is to clear any thread-local storage
//////////////////////////////////////////////////////////////////////////////
static void DestroyThreadContext();
static AqlValue IsNull(arangodb::aql::Query*, arangodb::AqlTransaction*,
FunctionParameters const&);
static AqlValue IsBool(arangodb::aql::Query*, arangodb::AqlTransaction*,
FunctionParameters const&);
static AqlValue IsNumber(arangodb::aql::Query*, arangodb::AqlTransaction*,
FunctionParameters const&);
static AqlValue IsString(arangodb::aql::Query*, arangodb::AqlTransaction*,
FunctionParameters const&);
static AqlValue IsArray(arangodb::aql::Query*, arangodb::AqlTransaction*,
FunctionParameters const&);
static AqlValue IsObject(arangodb::aql::Query*, arangodb::AqlTransaction*,
FunctionParameters const&);
static AqlValue ToNumber(arangodb::aql::Query*, arangodb::AqlTransaction*,
FunctionParameters const&);
static AqlValue ToString(arangodb::aql::Query*, arangodb::AqlTransaction*,
FunctionParameters const&);
static AqlValue ToBool(arangodb::aql::Query*, arangodb::AqlTransaction*,
FunctionParameters const&);
static AqlValue ToArray(arangodb::aql::Query*, arangodb::AqlTransaction*,
FunctionParameters const&);
static AqlValue Length(arangodb::aql::Query*, arangodb::AqlTransaction*,
FunctionParameters const&);
static AqlValue First(arangodb::aql::Query*, arangodb::AqlTransaction*,
FunctionParameters const&);
static AqlValue Last(arangodb::aql::Query*, arangodb::AqlTransaction*,
FunctionParameters const&);
static AqlValue Nth(arangodb::aql::Query*, arangodb::AqlTransaction*,
FunctionParameters const&);
static AqlValue Concat(arangodb::aql::Query*, arangodb::AqlTransaction*,
FunctionParameters const&);
static AqlValue Like(arangodb::aql::Query*, arangodb::AqlTransaction*,
FunctionParameters const&);
static AqlValue Passthru(arangodb::aql::Query*, arangodb::AqlTransaction*,
FunctionParameters const&);
static AqlValue Unset(arangodb::aql::Query*, arangodb::AqlTransaction*,
FunctionParameters const&);
static AqlValue UnsetRecursive(arangodb::aql::Query*,
arangodb::AqlTransaction*,
FunctionParameters const&);
static AqlValue Keep(arangodb::aql::Query*, arangodb::AqlTransaction*,
FunctionParameters const&);
static AqlValue Merge(arangodb::aql::Query*, arangodb::AqlTransaction*,
FunctionParameters const&);
static AqlValue MergeRecursive(arangodb::aql::Query*,
arangodb::AqlTransaction*,
FunctionParameters const&);
static AqlValue Has(arangodb::aql::Query*, arangodb::AqlTransaction*,
FunctionParameters const&);
static AqlValue Attributes(arangodb::aql::Query*, arangodb::AqlTransaction*,
FunctionParameters const&);
static AqlValue Values(arangodb::aql::Query*, arangodb::AqlTransaction*,
FunctionParameters const&);
static AqlValue Min(arangodb::aql::Query*, arangodb::AqlTransaction*,
FunctionParameters const&);
static AqlValue Max(arangodb::aql::Query*, arangodb::AqlTransaction*,
FunctionParameters const&);
static AqlValue Sum(arangodb::aql::Query*, arangodb::AqlTransaction*,
FunctionParameters const&);
static AqlValue Average(arangodb::aql::Query*, arangodb::AqlTransaction*,
FunctionParameters const&);
static AqlValue Md5(arangodb::aql::Query*, arangodb::AqlTransaction*,
FunctionParameters const&);
static AqlValue Sha1(arangodb::aql::Query*, arangodb::AqlTransaction*,
FunctionParameters const&);
static AqlValue Unique(arangodb::aql::Query*, arangodb::AqlTransaction*,
FunctionParameters const&);
static AqlValue SortedUnique(arangodb::aql::Query*, arangodb::AqlTransaction*,
FunctionParameters const&);
static AqlValue Union(arangodb::aql::Query*, arangodb::AqlTransaction*,
FunctionParameters const&);
static AqlValue UnionDistinct(arangodb::aql::Query*,
arangodb::AqlTransaction*,
FunctionParameters const&);
static AqlValue Intersection(arangodb::aql::Query*, arangodb::AqlTransaction*,
FunctionParameters const&);
static AqlValue Neighbors(arangodb::aql::Query*, arangodb::AqlTransaction*,
FunctionParameters const&);
static AqlValue Near(arangodb::aql::Query*, arangodb::AqlTransaction*,
FunctionParameters const&);
static AqlValue Within(arangodb::aql::Query*, arangodb::AqlTransaction*,
FunctionParameters const&);
static AqlValue Flatten(arangodb::aql::Query*, arangodb::AqlTransaction*,
FunctionParameters const&);
static AqlValue Zip(arangodb::aql::Query*, arangodb::AqlTransaction*,
FunctionParameters const&);
static AqlValue ParseIdentifier(arangodb::aql::Query*,
arangodb::AqlTransaction*,
FunctionParameters const&);
static AqlValue Minus(arangodb::aql::Query*, arangodb::AqlTransaction*,
FunctionParameters const&);
static AqlValue Document(arangodb::aql::Query*, arangodb::AqlTransaction*,
FunctionParameters const&);
static AqlValue Edges(arangodb::aql::Query*, arangodb::AqlTransaction*,
FunctionParameters const&);
static AqlValue Round(arangodb::aql::Query*, arangodb::AqlTransaction*,
FunctionParameters const&);
static AqlValue Abs(arangodb::aql::Query*, arangodb::AqlTransaction*,
FunctionParameters const&);
static AqlValue Ceil(arangodb::aql::Query*, arangodb::AqlTransaction*,
FunctionParameters const&);
static AqlValue Floor(arangodb::aql::Query*, arangodb::AqlTransaction*,
FunctionParameters const&);
static AqlValue Sqrt(arangodb::aql::Query*, arangodb::AqlTransaction*,
FunctionParameters const&);
static AqlValue Pow(arangodb::aql::Query*, arangodb::AqlTransaction*,
FunctionParameters const&);
static AqlValue Rand(arangodb::aql::Query*, arangodb::AqlTransaction*,
FunctionParameters const&);
static AqlValue FirstDocument(arangodb::aql::Query*,
arangodb::AqlTransaction*,
FunctionParameters const&);
static AqlValue FirstList(arangodb::aql::Query*, arangodb::AqlTransaction*,
FunctionParameters const&);
static AqlValue Push(arangodb::aql::Query*, arangodb::AqlTransaction*,
FunctionParameters const&);
static AqlValue Pop(arangodb::aql::Query*, arangodb::AqlTransaction*,
FunctionParameters const&);
static AqlValue Append(arangodb::aql::Query*, arangodb::AqlTransaction*,
FunctionParameters const&);
static AqlValue Unshift(arangodb::aql::Query*, arangodb::AqlTransaction*,
FunctionParameters const&);
static AqlValue Shift(arangodb::aql::Query*, arangodb::AqlTransaction*,
FunctionParameters const&);
static AqlValue RemoveValue(arangodb::aql::Query*, arangodb::AqlTransaction*,
FunctionParameters const&);
static AqlValue RemoveValues(arangodb::aql::Query*, arangodb::AqlTransaction*,
FunctionParameters const&);
static AqlValue RemoveNth(arangodb::aql::Query*, arangodb::AqlTransaction*,
FunctionParameters const&);
static AqlValue NotNull(arangodb::aql::Query*, arangodb::AqlTransaction*,
FunctionParameters const&);
static AqlValue CurrentDatabase(arangodb::aql::Query*,
arangodb::AqlTransaction*,
FunctionParameters const&);
static AqlValue CollectionCount(arangodb::aql::Query*,
arangodb::AqlTransaction*,
FunctionParameters const&);
static AqlValue VarianceSample(arangodb::aql::Query*,
arangodb::AqlTransaction*,
FunctionParameters const&);
static AqlValue VariancePopulation(arangodb::aql::Query*,
arangodb::AqlTransaction*,
FunctionParameters const&);
static AqlValue StdDevSample(arangodb::aql::Query*, arangodb::AqlTransaction*,
FunctionParameters const&);
static AqlValue StdDevPopulation(arangodb::aql::Query*,
arangodb::AqlTransaction*,
FunctionParameters const&);
static AqlValue Median(arangodb::aql::Query*, arangodb::AqlTransaction*,
FunctionParameters const&);
static AqlValue Percentile(arangodb::aql::Query*, arangodb::AqlTransaction*,
FunctionParameters const&);
static AqlValue Range(arangodb::aql::Query*, arangodb::AqlTransaction*,
FunctionParameters const&);
static AqlValue Position(arangodb::aql::Query*, arangodb::AqlTransaction*,
FunctionParameters const&);
static AqlValue Fulltext(arangodb::aql::Query*, arangodb::AqlTransaction*,
FunctionParameters const&);
static AqlValue IsSameCollection(arangodb::aql::Query*, arangodb::AqlTransaction*,
FunctionParameters const&);
static AqlValue$ IsNullVPack(arangodb::aql::Query*, arangodb::AqlTransaction*,
VPackFunctionParameters const&);
static AqlValue$ IsBoolVPack(arangodb::aql::Query*, arangodb::AqlTransaction*,
VPackFunctionParameters const&);
static AqlValue$ IsNumberVPack(arangodb::aql::Query*,
arangodb::AqlTransaction*,
VPackFunctionParameters const&);
static AqlValue$ IsStringVPack(arangodb::aql::Query*,
arangodb::AqlTransaction*,
VPackFunctionParameters const&);
static AqlValue$ IsArrayVPack(arangodb::aql::Query*,
arangodb::AqlTransaction*,
VPackFunctionParameters const&);
static AqlValue$ IsObjectVPack(arangodb::aql::Query*,
arangodb::AqlTransaction*,
VPackFunctionParameters const&);
static AqlValue$ ToNumberVPack(arangodb::aql::Query*,
arangodb::AqlTransaction*,
VPackFunctionParameters const&);
static AqlValue$ ToStringVPack(arangodb::aql::Query*,
arangodb::AqlTransaction*,
VPackFunctionParameters const&);
static AqlValue$ ToBoolVPack(arangodb::aql::Query*, arangodb::AqlTransaction*,
VPackFunctionParameters const&);
static AqlValue$ ToArrayVPack(arangodb::aql::Query*,
arangodb::AqlTransaction*,
VPackFunctionParameters const&);
static AqlValue$ LengthVPack(arangodb::aql::Query*, arangodb::AqlTransaction*,
VPackFunctionParameters const&);
static AqlValue$ FirstVPack(arangodb::aql::Query*, arangodb::AqlTransaction*,
VPackFunctionParameters const&);
static AqlValue$ LastVPack(arangodb::aql::Query*, arangodb::AqlTransaction*,
VPackFunctionParameters const&);
static AqlValue$ NthVPack(arangodb::aql::Query*, arangodb::AqlTransaction*,
VPackFunctionParameters const&);
static AqlValue$ ConcatVPack(arangodb::aql::Query*, arangodb::AqlTransaction*,
VPackFunctionParameters const&);
static AqlValue$ LikeVPack(arangodb::aql::Query*, arangodb::AqlTransaction*,
VPackFunctionParameters const&);
static AqlValue$ PassthruVPack(arangodb::aql::Query*,
arangodb::AqlTransaction*,
VPackFunctionParameters const&);
static AqlValue$ UnsetVPack(arangodb::aql::Query*, arangodb::AqlTransaction*,
VPackFunctionParameters const&);
static AqlValue$ UnsetRecursiveVPack(arangodb::aql::Query*,
arangodb::AqlTransaction*,
VPackFunctionParameters const&);
static AqlValue$ KeepVPack(arangodb::aql::Query*, arangodb::AqlTransaction*,
VPackFunctionParameters const&);
static AqlValue$ MergeVPack(arangodb::aql::Query*, arangodb::AqlTransaction*,
VPackFunctionParameters const&);
static AqlValue$ MergeRecursiveVPack(arangodb::aql::Query*,
arangodb::AqlTransaction*,
VPackFunctionParameters const&);
static AqlValue$ HasVPack(arangodb::aql::Query*, arangodb::AqlTransaction*,
VPackFunctionParameters const&);
static AqlValue$ AttributesVPack(arangodb::aql::Query*,
arangodb::AqlTransaction*,
VPackFunctionParameters const&);
static AqlValue$ ValuesVPack(arangodb::aql::Query*, arangodb::AqlTransaction*,
VPackFunctionParameters const&);
static AqlValue$ MinVPack(arangodb::aql::Query*, arangodb::AqlTransaction*,
VPackFunctionParameters const&);
static AqlValue$ MaxVPack(arangodb::aql::Query*, arangodb::AqlTransaction*,
VPackFunctionParameters const&);
static AqlValue$ SumVPack(arangodb::aql::Query*, arangodb::AqlTransaction*,
VPackFunctionParameters const&);
static AqlValue$ AverageVPack(arangodb::aql::Query*,
arangodb::AqlTransaction*,
VPackFunctionParameters const&);
static AqlValue$ Md5VPack(arangodb::aql::Query*, arangodb::AqlTransaction*,
VPackFunctionParameters const&);
static AqlValue$ Sha1VPack(arangodb::aql::Query*, arangodb::AqlTransaction*,
VPackFunctionParameters const&);
static AqlValue$ UniqueVPack(arangodb::aql::Query*, arangodb::AqlTransaction*,
VPackFunctionParameters const&);
static AqlValue$ SortedUniqueVPack(arangodb::aql::Query*,
arangodb::AqlTransaction*,
VPackFunctionParameters const&);
static AqlValue$ UnionVPack(arangodb::aql::Query*, arangodb::AqlTransaction*,
VPackFunctionParameters const&);
static AqlValue$ UnionDistinctVPack(arangodb::aql::Query*,
arangodb::AqlTransaction*,
VPackFunctionParameters const&);
static AqlValue$ IntersectionVPack(arangodb::aql::Query*,
arangodb::AqlTransaction*,
VPackFunctionParameters const&);
static AqlValue$ NeighborsVPack(arangodb::aql::Query*,
arangodb::AqlTransaction*,
VPackFunctionParameters const&);
static AqlValue$ NearVPack(arangodb::aql::Query*, arangodb::AqlTransaction*,
VPackFunctionParameters const&);
static AqlValue$ WithinVPack(arangodb::aql::Query*, arangodb::AqlTransaction*,
VPackFunctionParameters const&);
static AqlValue$ FlattenVPack(arangodb::aql::Query*,
arangodb::AqlTransaction*,
VPackFunctionParameters const&);
static AqlValue$ ZipVPack(arangodb::aql::Query*, arangodb::AqlTransaction*,
VPackFunctionParameters const&);
static AqlValue$ ParseIdentifierVPack(arangodb::aql::Query*,
arangodb::AqlTransaction*,
VPackFunctionParameters const&);
static AqlValue$ MinusVPack(arangodb::aql::Query*, arangodb::AqlTransaction*,
VPackFunctionParameters const&);
static AqlValue$ DocumentVPack(arangodb::aql::Query*,
arangodb::AqlTransaction*,
VPackFunctionParameters const&);
static AqlValue$ EdgesVPack(arangodb::aql::Query*, arangodb::AqlTransaction*,
VPackFunctionParameters const&);
static AqlValue$ RoundVPack(arangodb::aql::Query*, arangodb::AqlTransaction*,
VPackFunctionParameters const&);
static AqlValue$ AbsVPack(arangodb::aql::Query*, arangodb::AqlTransaction*,
VPackFunctionParameters const&);
static AqlValue$ CeilVPack(arangodb::aql::Query*, arangodb::AqlTransaction*,
VPackFunctionParameters const&);
static AqlValue$ FloorVPack(arangodb::aql::Query*, arangodb::AqlTransaction*,
VPackFunctionParameters const&);
static AqlValue$ SqrtVPack(arangodb::aql::Query*, arangodb::AqlTransaction*,
VPackFunctionParameters const&);
static AqlValue$ PowVPack(arangodb::aql::Query*, arangodb::AqlTransaction*,
VPackFunctionParameters const&);
static AqlValue$ RandVPack(arangodb::aql::Query*, arangodb::AqlTransaction*,
VPackFunctionParameters const&);
static AqlValue$ FirstDocumentVPack(arangodb::aql::Query*,
arangodb::AqlTransaction*,
VPackFunctionParameters const&);
static AqlValue$ FirstListVPack(arangodb::aql::Query*,
arangodb::AqlTransaction*,
VPackFunctionParameters const&);
static AqlValue$ PushVPack(arangodb::aql::Query*, arangodb::AqlTransaction*,
VPackFunctionParameters const&);
static AqlValue$ PopVPack(arangodb::aql::Query*, arangodb::AqlTransaction*,
VPackFunctionParameters const&);
static AqlValue$ AppendVPack(arangodb::aql::Query*, arangodb::AqlTransaction*,
VPackFunctionParameters const&);
static AqlValue$ UnshiftVPack(arangodb::aql::Query*,
arangodb::AqlTransaction*,
VPackFunctionParameters const&);
static AqlValue$ ShiftVPack(arangodb::aql::Query*, arangodb::AqlTransaction*,
VPackFunctionParameters const&);
static AqlValue$ RemoveValueVPack(arangodb::aql::Query*,
arangodb::AqlTransaction*,
VPackFunctionParameters const&);
static AqlValue$ RemoveValuesVPack(arangodb::aql::Query*,
arangodb::AqlTransaction*,
VPackFunctionParameters const&);
static AqlValue$ RemoveNthVPack(arangodb::aql::Query*,
arangodb::AqlTransaction*,
VPackFunctionParameters const&);
static AqlValue$ NotNullVPack(arangodb::aql::Query*,
arangodb::AqlTransaction*,
VPackFunctionParameters const&);
static AqlValue$ CurrentDatabaseVPack(arangodb::aql::Query*,
arangodb::AqlTransaction*,
VPackFunctionParameters const&);
static AqlValue$ CollectionCountVPack(arangodb::aql::Query*,
arangodb::AqlTransaction*,
VPackFunctionParameters const&);
static AqlValue$ VarianceSampleVPack(arangodb::aql::Query*,
arangodb::AqlTransaction*,
VPackFunctionParameters const&);
static AqlValue$ VariancePopulationVPack(arangodb::aql::Query*,
arangodb::AqlTransaction*,
VPackFunctionParameters const&);
static AqlValue$ StdDevSampleVPack(arangodb::aql::Query*,
arangodb::AqlTransaction*,
VPackFunctionParameters const&);
static AqlValue$ StdDevPopulationVPack(arangodb::aql::Query*,
arangodb::AqlTransaction*,
VPackFunctionParameters const&);
static AqlValue$ MedianVPack(arangodb::aql::Query*, arangodb::AqlTransaction*,
VPackFunctionParameters const&);
static AqlValue$ PercentileVPack(arangodb::aql::Query*,
arangodb::AqlTransaction*,
VPackFunctionParameters const&);
static AqlValue$ RangeVPack(arangodb::aql::Query*, arangodb::AqlTransaction*,
VPackFunctionParameters const&);
static AqlValue$ PositionVPack(arangodb::aql::Query*,
arangodb::AqlTransaction*,
VPackFunctionParameters const&);
static AqlValue$ FulltextVPack(arangodb::aql::Query*,
arangodb::AqlTransaction*,
VPackFunctionParameters const&);
static AqlValue$ IsSameCollectionVPack(arangodb::aql::Query*,
arangodb::AqlTransaction*,
VPackFunctionParameters const&);
};
}
}
#endif