mirror of https://gitee.com/bigwinds/arangodb
728 lines
30 KiB
C++
728 lines
30 KiB
C++
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief arango server
|
|
///
|
|
/// @file
|
|
///
|
|
/// DISCLAIMER
|
|
///
|
|
/// Copyright 2014 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 Dr. Frank Celler
|
|
/// @author Copyright 2014, ArangoDB GmbH, Cologne, Germany
|
|
/// @author Copyright 2011-2014, triAGENS GmbH, Cologne, Germany
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
#ifndef ARANGODB_REST_SERVER_ARANGO_SERVER_H
|
|
#define ARANGODB_REST_SERVER_ARANGO_SERVER_H 1
|
|
|
|
#include "Basics/Common.h"
|
|
|
|
#ifdef _WIN32
|
|
#include "Basics/win-utils.h"
|
|
#endif
|
|
|
|
#include "Aql/QueryRegistry.h"
|
|
#include "Rest/AnyServer.h"
|
|
#include "Rest/OperationMode.h"
|
|
#include "VocBase/vocbase.h"
|
|
|
|
struct TRI_server_t;
|
|
struct TRI_vocbase_defaults_s;
|
|
|
|
// -----------------------------------------------------------------------------
|
|
// --SECTION-- forward declarations
|
|
// -----------------------------------------------------------------------------
|
|
|
|
namespace triagens {
|
|
namespace basics {
|
|
class ThreadPool;
|
|
}
|
|
|
|
namespace rest {
|
|
class ApplicationDispatcher;
|
|
class ApplicationEndpointServer;
|
|
class ApplicationScheduler;
|
|
class AsyncJobManager;
|
|
class Dispatcher;
|
|
class HttpHandlerFactory;
|
|
class HttpServer;
|
|
class HttpsServer;
|
|
}
|
|
|
|
namespace arango {
|
|
class ApplicationV8;
|
|
class ApplicationCluster;
|
|
|
|
// -----------------------------------------------------------------------------
|
|
// --SECTION-- class ArangoServer
|
|
// -----------------------------------------------------------------------------
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief ArangoDB server
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
class ArangoServer : public rest::AnyServer {
|
|
private:
|
|
ArangoServer (const ArangoServer&);
|
|
ArangoServer& operator= (const ArangoServer&);
|
|
|
|
// -----------------------------------------------------------------------------
|
|
// --SECTION-- constructors and destructors
|
|
// -----------------------------------------------------------------------------
|
|
|
|
public:
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief constructor
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
ArangoServer (int, char**);
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief destructor
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
~ArangoServer ();
|
|
|
|
// -----------------------------------------------------------------------------
|
|
// --SECTION-- AnyServer methods
|
|
// -----------------------------------------------------------------------------
|
|
|
|
public:
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// {@inheritDoc}
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
void buildApplicationServer ();
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// {@inheritDoc}
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
int startupServer ();
|
|
|
|
// -----------------------------------------------------------------------------
|
|
// --SECTION-- private methods
|
|
// -----------------------------------------------------------------------------
|
|
|
|
private:
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief run arbitrary checks at startup
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
void runStartupChecks ();
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief wait for the heartbeat thread to run
|
|
/// before the server responds to requests, the heartbeat thread should have
|
|
/// run at least once
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
void waitForHeartbeat ();
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief runs in server mode
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
int runServer (TRI_vocbase_t*);
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief runs in console mode
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
int runConsole (TRI_vocbase_t*);
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief runs unit tests
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
int runUnitTests (TRI_vocbase_t*);
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief runs script
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
int runScript (TRI_vocbase_t*);
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief opens all system databases
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
void openDatabases (bool,
|
|
bool,
|
|
bool);
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief closes all database
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
void closeDatabases ();
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief defineHandlers, define "_api" and "_admin" handlers
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
void defineHandlers (triagens::rest::HttpHandlerFactory* factory);
|
|
|
|
// -----------------------------------------------------------------------------
|
|
// --SECTION-- private variables
|
|
// -----------------------------------------------------------------------------
|
|
|
|
private:
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief number of command line arguments
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
int _argc;
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief command line arguments
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
char** _argv;
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief temporary path
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
std::string _tempPath;
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief application scheduler
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
rest::ApplicationScheduler* _applicationScheduler;
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief application dispatcher
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
rest::ApplicationDispatcher* _applicationDispatcher;
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief application endpoint server
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
rest::ApplicationEndpointServer* _applicationEndpointServer;
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief cluster application feature
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
triagens::arango::ApplicationCluster* _applicationCluster;
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief asynchronous job manager
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
rest::AsyncJobManager* _jobManager;
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief application V8
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
ApplicationV8* _applicationV8;
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief whether or not only requests to internal URLs need authentication
|
|
/// @startDocuBlock serverAuthenticateSystemOnly
|
|
/// `--server.authenticate-system-only boolean`
|
|
///
|
|
/// Controls whether incoming requests need authentication only if they are
|
|
/// directed to the ArangoDB's internal APIs and features, located at */_api/*,
|
|
/// */_admin/* etc.
|
|
///
|
|
/// IF the flag is set to *true*, then HTTP authentication is only
|
|
/// required for requests going to URLs starting with */_*, but not for other
|
|
/// URLs. The flag can thus be used to expose a user-made API without HTTP
|
|
/// authentication to the outside world, but to prevent the outside world from
|
|
/// using the ArangoDB API and the admin interface without authentication.
|
|
/// Note that checking the URL is performed after any database name prefix
|
|
/// has been removed. That means when the actual URL called is
|
|
/// */_db/_system/myapp/myaction*, the URL */myapp/myaction* will be used for
|
|
/// *authenticate-system-only* check.
|
|
///
|
|
/// The default is *false*.
|
|
///
|
|
/// Note that authentication still needs to be enabled for the server regularly
|
|
/// in order for HTTP authentication to be forced for the ArangoDB API and the
|
|
/// web interface. Setting only this flag is not enough.
|
|
///
|
|
/// You can control ArangoDB's general authentication feature with the
|
|
/// *--server.disable-authentication* flag.
|
|
/// @endDocuBlock
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
bool _authenticateSystemOnly;
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief disable authentication for ALL client requests
|
|
/// @startDocuBlock server_authentication
|
|
/// `--server.disable-authentication`
|
|
///
|
|
/// Setting value to true will turn off authentication on the server side
|
|
/// so all clients can execute any action without authorization and privilege
|
|
/// checks.
|
|
///
|
|
/// The default value is *false*.
|
|
/// @endDocuBlock
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
bool _disableAuthentication;
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief disable authentication for requests via UNIX domain sockets
|
|
/// @startDocuBlock serverAuthenticationDisable
|
|
/// `--server.disable-authentication-unix-sockets value`
|
|
///
|
|
/// Setting *value* to true will turn off authentication on the server side
|
|
/// for requests coming in via UNIX domain sockets. With this flag enabled,
|
|
/// clients located on the same host as the ArangoDB server can use UNIX domain
|
|
/// sockets to connect to the server without authentication.
|
|
/// Requests coming in by other means (e.g. TCP/IP) are not affected by this
|
|
/// option.
|
|
///
|
|
/// The default value is *false*.
|
|
///
|
|
/// **Note**: this option is only available on platforms that support UNIX domain
|
|
/// sockets.
|
|
/// @endDocuBlock
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
bool _disableAuthenticationUnixSockets;
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief number of dispatcher threads
|
|
/// @startDocuBlock serverThreads
|
|
/// `--server.threads number`
|
|
///
|
|
/// Specifies the *number* of threads that are spawned to handle HTTP REST
|
|
/// requests.
|
|
/// @endDocuBlock
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
int _dispatcherThreads;
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief number of additional dispatcher threads
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
std::vector<int> _additionalThreads;
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief maximum size of the dispatcher queue for asynchronous requests
|
|
/// @startDocuBlock schedulerMaximalQueueSize
|
|
/// `--scheduler.maximal-queue-size size`
|
|
///
|
|
/// Specifies the maximum *size* of the dispatcher queue for asynchronous
|
|
/// task execution. If the queue already contains *size* tasks, new tasks
|
|
/// will be rejected until other tasks are popped from the queue. Setting this
|
|
/// value may help preventing from running out of memory if the queue is filled
|
|
/// up faster than the server can process requests.
|
|
/// @endDocuBlock
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
int _dispatcherQueueSize;
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief number of V8 contexts for executing JavaScript actions
|
|
/// @startDocuBlock v8Contexts
|
|
/// `--server.v8-contexts number`
|
|
///
|
|
/// Specifies the *number* of V8 contexts that are created for executing
|
|
/// JavaScript code. More contexts allow execute more JavaScript actions in
|
|
/// parallel, provided that there are also enough threads available. Please
|
|
/// note that each V8 context will use a substantial amount of memory and
|
|
/// requires periodic CPU processing time for garbage collection.
|
|
/// @endDocuBlock
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
int _v8Contexts;
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief number of background threads for parallel index creation
|
|
/// @startDocuBlock indexThreads
|
|
/// `--database.index-threads`
|
|
///
|
|
/// Specifies the *number* of background threads for index creation. When a
|
|
/// collection contains extra indexes other than the primary index, these other
|
|
/// indexes can be built by multiple threads in parallel. The index threads
|
|
/// are shared among multiple collections and databases. Specifying a value of
|
|
/// *0* will turn off parallel building, meaning that indexes for each collection
|
|
/// are built sequentially by the thread that opened the collection.
|
|
/// If the number of index threads is greater than 1, it will also be used to
|
|
/// built the edge index of a collection in parallel (this also requires the
|
|
/// edge index in the collection to be split into multiple buckets).
|
|
/// @endDocuBlock
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
int _indexThreads;
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief path to the database
|
|
/// @startDocuBlock DatabaseDirectory
|
|
/// `--database.directory directory`
|
|
///
|
|
/// The directory containing the collections and datafiles. Defaults
|
|
/// to */var/lib/arango*. When specifying the database directory, please
|
|
/// make sure the directory is actually writable by the arangod process.
|
|
///
|
|
/// You should further not use a database directory which is provided by a
|
|
/// network filesystem such as NFS. The reason is that networked filesystems
|
|
/// might cause inconsistencies when there are multiple parallel readers or
|
|
/// writers or they lack features required by arangod (e.g. flock()).
|
|
///
|
|
/// `directory`
|
|
///
|
|
/// When using the command line version, you can simply supply the database
|
|
/// directory as argument.
|
|
///
|
|
/// @EXAMPLES
|
|
///
|
|
/// ```
|
|
/// > ./arangod --server.endpoint tcp://127.0.0.1:8529 --database.directory /tmp/vocbase
|
|
/// ```
|
|
/// @endDocuBlock
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
std::string _databasePath;
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief whether or not to enable the AQL query cache
|
|
/// @startDocuBlock queryCacheMode
|
|
/// `--database.query-cache-mode`
|
|
///
|
|
/// Toggles the AQL query cache behavior. Possible values are:
|
|
///
|
|
/// * *off*: do not use query cache
|
|
/// * *on*: always use query cache, except for queries that have their *cache*
|
|
/// attribute set to *false*
|
|
/// * *demand*: use query cache only for queries that have their *cache*
|
|
/// attribute set to *true*
|
|
/// set
|
|
/// @endDocuBlock
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
std::string _queryCacheMode;
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief maximum number of elements in the query cache per database
|
|
/// @startDocuBlock queryCacheMaxResults
|
|
/// `--database.query-cache-max-results`
|
|
///
|
|
/// Maximum number of query results that can be stored per database-specific
|
|
/// query cache. If a query is eligible for caching and the number of items in
|
|
/// the database's query cache is equal to this threshold value, another cached
|
|
/// query result will be removed from the cache.
|
|
///
|
|
/// This option only has an effect if the query cache mode is set to either
|
|
/// *on* or *demand*.
|
|
/// @endDocuBlock
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
uint64_t _queryCacheMaxResults;
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @startDocuBlock databaseMaximalJournalSize
|
|
///
|
|
/// `--database.maximal-journal-size size`
|
|
///
|
|
/// Maximal size of journal in bytes. Can be overwritten when creating a new
|
|
/// collection. Note that this also limits the maximal size of a single
|
|
/// document.
|
|
///
|
|
/// The default is *32MB*.
|
|
/// @endDocuBlock
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
TRI_voc_size_t _defaultMaximalSize;
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief default wait for sync behavior
|
|
/// @startDocuBlock databaseWaitForSync
|
|
/// `--database.wait-for-sync boolean`
|
|
///
|
|
/// Default wait-for-sync value. Can be overwritten when creating a new
|
|
/// collection.
|
|
///
|
|
/// The default is *false*.
|
|
/// @endDocuBlock
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
bool _defaultWaitForSync;
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief force syncing of collection properties to disk
|
|
/// @startDocuBlock databaseForceSyncProperties
|
|
/// `--database.force-sync-properties boolean`
|
|
///
|
|
/// Force syncing of collection properties to disk after creating a collection
|
|
/// or updating its properties.
|
|
///
|
|
/// If turned off, no fsync will happen for the collection and database
|
|
/// properties stored in `parameter.json` files in the file system. Turning
|
|
/// off this option will speed up workloads that create and drop a lot of
|
|
/// collections (e.g. test suites).
|
|
///
|
|
/// The default is *true*.
|
|
/// @endDocuBlock
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
bool _forceSyncProperties;
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief ignore datafile errors when loading collections
|
|
/// @startDocuBlock databaseIgnoreDatafileErrors
|
|
/// `--database.ignore-datafile-errors boolean`
|
|
///
|
|
/// If set to `false`, CRC mismatch and other errors in collection datafiles
|
|
/// will lead to a collection not being loaded at all. The collection in this
|
|
/// case becomes unavailable. If such collection needs to be loaded during WAL
|
|
/// recovery, the WAL recovery will also abort (if not forced with option
|
|
/// `--wal.ignore-recovery-errors true`).
|
|
///
|
|
/// Setting this flag to `false` protects users from unintentionally using a
|
|
/// collection with corrupted datafiles, from which only a subset of the
|
|
/// original data can be recovered. Working with such collection could lead
|
|
/// to data loss and follow up errors.
|
|
/// In order to access such collection, it is required to inspect and repair
|
|
/// the collection datafile with the datafile debugger (arango-dfdb).
|
|
///
|
|
/// If set to `true`, CRC mismatch and other errors during the loading of a
|
|
/// collection will lead to the datafile being partially loaded, up to the
|
|
/// position of the first error. All data up to until the invalid position
|
|
/// will be loaded. This will enable users to continue with collection datafiles
|
|
/// even if they are corrupted, but this will result in only a partial load
|
|
/// of the original data and potential follow up errors. The WAL recovery
|
|
/// will still abort when encountering a collection with a corrupted datafile,
|
|
/// at least if `--wal.ignore-recovery-errors` is not set to `true`.
|
|
///
|
|
/// The default value is *false*, so collections with corrupted datafiles will
|
|
/// not be loaded at all, preventing partial loads and follow up errors. However,
|
|
/// if such collection is required at server startup, during WAL recovery, the
|
|
/// server will abort the recovery and refuse to start.
|
|
/// @endDocuBlock
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
bool _ignoreDatafileErrors;
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief disable the replication applier on server startup
|
|
/// @startDocuBlock serverDisableReplicationApplier
|
|
/// `--server.disable-replication-applier flag`
|
|
///
|
|
/// If *true* the server will start with the replication applier turned off,
|
|
/// even if the replication applier is configured with the *autoStart* option.
|
|
/// Using the command-line option will not change the value of the *autoStart*
|
|
/// option in the applier configuration, but will suppress auto-starting the
|
|
/// replication applier just once.
|
|
///
|
|
/// If the option is not used, ArangoDB will read the applier configuration from
|
|
/// the file *REPLICATION-APPLIER-CONFIG* on startup, and use the value of the
|
|
/// *autoStart* attribute from this file.
|
|
///
|
|
/// The default is *false*.
|
|
/// @endDocuBlock
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
bool _disableReplicationApplier;
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief disable the query tracking feature
|
|
/// @startDocuBlock databaseDisableQueryTracking
|
|
/// `--database.disable-query-tracking flag`
|
|
///
|
|
/// If *true*, the server's query tracking feature will be disabled by default.
|
|
///
|
|
/// The default is *false*.
|
|
/// @endDocuBlock
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
bool _disableQueryTracking;
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief throw collection not loaded error
|
|
/// @startDocuBlock databaseThrowCollectionNotLoadedError
|
|
/// `--database.throw-collection-not-loaded-error flag`
|
|
///
|
|
/// Accessing a not-yet loaded collection will automatically load a collection
|
|
/// on first access. This flag controls what happens in case an operation
|
|
/// would need to wait for another thread to finalize loading a collection. If
|
|
/// set to *true*, then the first operation that accesses an unloaded collection
|
|
/// will load it. Further threads that try to access the same collection while
|
|
/// it is still loading will get an error (1238, *collection not loaded*). When
|
|
/// the initial operation has completed loading the collection, all operations
|
|
/// on the collection can be carried out normally, and error 1238 will not be
|
|
/// thrown.
|
|
///
|
|
/// If set to *false*, the first thread that accesses a not-yet loaded collection
|
|
/// will still load it. Other threads that try to access the collection while
|
|
/// loading will not fail with error 1238 but instead block until the collection
|
|
/// is fully loaded. This configuration might lead to all server threads being
|
|
/// blocked because they are all waiting for the same collection to complete
|
|
/// loading. Setting the option to *true* will prevent this from happening, but
|
|
/// requires clients to catch error 1238 and react on it (maybe by scheduling
|
|
/// a retry for later).
|
|
///
|
|
/// The default value is *false*.
|
|
/// @endDocuBlock
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
bool _throwCollectionNotLoadedError;
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief enable or disable the Foxx queues feature
|
|
/// @startDocuBlock foxxQueues
|
|
/// `--server.foxx-queues flag`
|
|
///
|
|
/// If *true*, the Foxx queues will be available and jobs in the queues will
|
|
/// be executed asynchronously.
|
|
///
|
|
/// The default is *true*.
|
|
/// When set to `false` the queue manager will be disabled and any jobs
|
|
/// are prevented from being processed, which may improve CPU load if you do not
|
|
/// plan to use Foxx queues at all.
|
|
/// @endDocuBlock
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
bool _foxxQueues;
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief poll interval for Foxx queues
|
|
/// @startDocuBlock foxxQueuesPollInterval
|
|
/// `--server.foxx-queues-poll-interval value`
|
|
///
|
|
/// The poll interval for the Foxx queues manager. The value is specified in
|
|
/// seconds. Lower values will mean more immediate and more frequent Foxx queue
|
|
/// job execution, but will make the queue thread wake up and query the
|
|
/// queues more often. When set to a low value, the queue thread might cause
|
|
/// CPU load.
|
|
///
|
|
/// The default is *1* second. If Foxx queues are not used much, then this value
|
|
/// may be increased to make the queues thread wake up less.
|
|
/// @endDocuBlock
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
double _foxxQueuesPollInterval;
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief unit tests
|
|
///
|
|
/// @CMDOPT{\--javascript.unit-tests @CA{test-file}}
|
|
///
|
|
/// Runs one or more unit tests.
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
std::vector<std::string> _unitTests;
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief files to jslint
|
|
///
|
|
/// @CMDOPT{\--jslint @CA{test-file}}
|
|
///
|
|
/// Runs jslint on one or more files.
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
std::vector<std::string> _jslint;
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief run script file
|
|
///
|
|
/// @CMDOPT{\--javascript.script @CA{script-file}}
|
|
///
|
|
/// Runs the script file.
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
std::vector<std::string> _scriptFile;
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief parameters to script file
|
|
///
|
|
/// @CMDOPT{\--javascript.script-parameter @CA{script-parameter}}
|
|
///
|
|
/// Parameter to script.
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
std::vector<std::string> _scriptParameters;
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief server default language for sorting strings
|
|
/// @startDocuBlock DefaultLanguage
|
|
/// `--default-language default-language`
|
|
///
|
|
/// The default language ist used for sorting and comparing strings.
|
|
/// The language value is a two-letter language code (ISO-639) or it is
|
|
/// composed by a two-letter language code with and a two letter country code
|
|
/// (ISO-3166). Valid languages are "de", "en", "en_US" or "en_UK".
|
|
///
|
|
/// The default default-language is set to be the system locale on that platform.
|
|
/// @endDocuBlock
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
std::string _defaultLanguage;
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief the server
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
TRI_server_t* _server;
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief the server
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
aql::QueryRegistry* _queryRegistry;
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief ptr to pair of _applicationV8 and _queryRegistry for _api/aql handler
|
|
/// this will be removed once we have a global struct with "everything useful"
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
std::pair<ApplicationV8*, aql::QueryRegistry*>* _pairForAqlHandler;
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief ptr to pair used for job manager rest handler
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
std::pair<triagens::rest::Dispatcher*, triagens::rest::AsyncJobManager*>* _pairForJobHandler;
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief thread pool for background parallel index creation
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
triagens::basics::ThreadPool* _indexPool;
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief use thread affinity
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
uint32_t _threadAffinity;
|
|
|
|
};
|
|
}
|
|
}
|
|
|
|
#endif
|
|
|
|
// -----------------------------------------------------------------------------
|
|
// --SECTION-- END-OF-FILE
|
|
// -----------------------------------------------------------------------------
|