From 01343450f08eadbe76cbf1c6351c5bb61731a2da Mon Sep 17 00:00:00 2001 From: Alan Plum Date: Tue, 12 Mar 2024 14:14:31 +0000 Subject: [PATCH] Update 8.8.0 docs via 9909a6bd8a899209c01dc65c10c4d52005c65d19 --- 8.8.0/.nojekyll | 1 + 8.8.0/assets/highlight.css | 141 + 8.8.0/assets/main.js | 58 + 8.8.0/assets/search.js | 1 + 8.8.0/assets/style.css | 1279 ++++++ 8.8.0/classes/analyzer.Analyzer.html | 173 + 8.8.0/classes/cursor.ArrayCursor.html | 489 ++ 8.8.0/classes/cursor.BatchedArrayCursor.html | 521 +++ 8.8.0/classes/database.Database.html | 3918 +++++++++++++++++ 8.8.0/classes/error.ArangoError.html | 191 + 8.8.0/classes/error.HttpError.html | 177 + 8.8.0/classes/graph.Graph.html | 478 ++ 8.8.0/classes/graph.GraphEdgeCollection.html | 330 ++ .../classes/graph.GraphVertexCollection.html | 333 ++ 8.8.0/classes/job.Job.html | 165 + 8.8.0/classes/route.Route.html | 469 ++ 8.8.0/classes/transaction.Transaction.html | 238 + 8.8.0/classes/view.View.html | 257 ++ 8.8.0/enums/collection.CollectionStatus.html | 112 + 8.8.0/enums/collection.CollectionType.html | 84 + 8.8.0/enums/database.LogLevel.html | 105 + .../functions/analyzer.isArangoAnalyzer.html | 113 + 8.8.0/functions/aql.aql.html | 106 + 8.8.0/functions/aql.isAqlLiteral.html | 77 + 8.8.0/functions/aql.isAqlQuery.html | 77 + 8.8.0/functions/aql.join.html | 94 + 8.8.0/functions/aql.literal.html | 91 + .../collection.collectionToString.html | 119 + .../collection.isArangoCollection.html | 118 + .../functions/database.isArangoDatabase.html | 133 + 8.8.0/functions/error.isArangoError.html | 74 + 8.8.0/functions/error.isSystemError.html | 72 + 8.8.0/functions/graph.isArangoGraph.html | 84 + 8.8.0/functions/index.arangojs.html | 98 + .../transaction.isArangoTransaction.html | 74 + 8.8.0/functions/view.isArangoView.html | 96 + 8.8.0/index.html | 264 ++ 8.8.0/interfaces/aql.AqlLiteral.html | 73 + 8.8.0/interfaces/aql.AqlQuery.html | 107 + .../collection.ArangoCollection.html | 92 + .../collection.DocumentCollection.html | 1356 ++++++ .../interfaces/collection.EdgeCollection.html | 1528 +++++++ 8.8.0/interfaces/cursor.CursorExtras.html | 110 + 8.8.0/interfaces/cursor.CursorStats.html | 202 + 8.8.0/interfaces/error.SystemError.html | 97 + ...ew.ArangoSearchViewStoredValueOptions.html | 105 + 8.8.0/modules.html | 69 + 8.8.0/modules/analyzer.html | 162 + 8.8.0/modules/aql.html | 91 + 8.8.0/modules/collection.html | 175 + 8.8.0/modules/connection.html | 92 + 8.8.0/modules/cursor.html | 78 + 8.8.0/modules/database.html | 206 + 8.8.0/modules/documents.html | 87 + 8.8.0/modules/error.html | 84 + 8.8.0/modules/foxx_manifest.html | 77 + 8.8.0/modules/graph.html | 104 + 8.8.0/modules/index.html | 92 + 8.8.0/modules/indexes.html | 113 + 8.8.0/modules/job.html | 64 + 8.8.0/modules/route.html | 69 + 8.8.0/modules/transaction.html | 84 + 8.8.0/modules/view.html | 130 + 8.8.0/types/analyzer.AnalyzerDescription.html | 102 + 8.8.0/types/analyzer.AnalyzerFeature.html | 102 + .../analyzer.AqlAnalyzerDescription.html | 102 + ...zer.ClassificationAnalyzerDescription.html | 102 + ...analyzer.CollationAnalyzerDescription.html | 102 + .../types/analyzer.CreateAnalyzerOptions.html | 102 + .../analyzer.CreateAqlAnalyzerOptions.html | 148 + ...r.CreateClassificationAnalyzerOptions.html | 132 + ...alyzer.CreateCollationAnalyzerOptions.html | 123 + ...alyzer.CreateDelimiterAnalyzerOptions.html | 119 + ...analyzer.CreateGeoJsonAnalyzerOptions.html | 138 + ...nalyzer.CreateGeoPointAnalyzerOptions.html | 140 + .../analyzer.CreateGeoS2AnalyzerOptions.html | 148 + ...nalyzer.CreateIdentityAnalyzerOptions.html | 118 + ...analyzer.CreateMinHashAnalyzerOptions.html | 126 + ...r.CreateMultiDelimiterAnalyzerOptions.html | 122 + ...CreateNearestNeighborsAnalyzerOptions.html | 127 + .../analyzer.CreateNgramAnalyzerOptions.html | 130 + .../analyzer.CreateNormAnalyzerOptions.html | 133 + ...nalyzer.CreatePipelineAnalyzerOptions.html | 122 + ...zer.CreateSegmentationAnalyzerOptions.html | 128 + .../analyzer.CreateStemAnalyzerOptions.html | 122 + ...alyzer.CreateStopwordsAnalyzerOptions.html | 127 + .../analyzer.CreateTextAnalyzerOptions.html | 161 + ...nalyzer.CreateWildcardAnalyzerOptions.html | 126 + ...analyzer.DelimiterAnalyzerDescription.html | 102 + .../analyzer.GenericAnalyzerDescription.html | 113 + .../analyzer.GeoJsonAnalyzerDescription.html | 102 + .../analyzer.GeoPointAnalyzerDescription.html | 102 + .../analyzer.GeoS2AnalyzerDescription.html | 102 + .../analyzer.IdentityAnalyzerDescription.html | 102 + .../analyzer.MinHashAnalyzerDescription.html | 102 + ...zer.MultiDelimiterAnalyzerDescription.html | 102 + ...r.NearestNeighborsAnalyzerDescription.html | 102 + .../analyzer.NgramAnalyzerDescription.html | 102 + .../analyzer.NormAnalyzerDescription.html | 102 + .../analyzer.PipelineAnalyzerDescription.html | 102 + ...lyzer.SegmentationAnalyzerDescription.html | 102 + .../analyzer.StemAnalyzerDescription.html | 102 + ...analyzer.StopwordsAnalyzerDescription.html | 102 + .../analyzer.TextAnalyzerDescription.html | 102 + .../analyzer.WildcardAnalyzerDescription.html | 102 + 8.8.0/types/aql.AqlValue.html | 67 + ...collection.CollectionBatchReadOptions.html | 116 + .../collection.CollectionChecksumOptions.html | 122 + .../collection.CollectionDropOptions.html | 117 + .../collection.CollectionEdgesOptions.html | 116 + .../collection.CollectionEdgesResult.html | 124 + .../collection.CollectionImportOptions.html | 148 + .../collection.CollectionImportResult.html | 138 + .../collection.CollectionInsertOptions.html | 155 + .../collection.CollectionKeyOptions.html | 128 + .../collection.CollectionKeyProperties.html | 130 + .../types/collection.CollectionMetadata.html | 126 + .../collection.CollectionProperties.html | 184 + ...ollection.CollectionPropertiesOptions.html | 139 + .../collection.CollectionReadOptions.html | 132 + .../collection.CollectionRemoveOptions.html | 139 + .../collection.CollectionReplaceOptions.html | 151 + .../collection.CollectionUpdateOptions.html | 164 + .../collection.ComputedValueOptions.html | 143 + .../collection.ComputedValueProperties.html | 138 + .../collection.CreateCollectionOptions.html | 186 + .../collection.DocumentExistsOptions.html | 120 + .../collection.DocumentOperationFailure.html | 122 + .../collection.DocumentOperationMetadata.html | 107 + 8.8.0/types/collection.KeyGenerator.html | 107 + 8.8.0/types/collection.SchemaOptions.html | 123 + 8.8.0/types/collection.SchemaProperties.html | 126 + 8.8.0/types/collection.ShardingStrategy.html | 107 + .../collection.SimpleQueryAllOptions.html | 139 + ...ollection.SimpleQueryByExampleOptions.html | 134 + ...collection.SimpleQueryFulltextOptions.html | 125 + .../types/collection.SimpleQueryListType.html | 111 + ...ion.SimpleQueryRemoveByExampleOptions.html | 123 + ...tion.SimpleQueryRemoveByExampleResult.html | 118 + ...ection.SimpleQueryRemoveByKeysOptions.html | 131 + ...lection.SimpleQueryRemoveByKeysResult.html | 131 + ...on.SimpleQueryReplaceByExampleOptions.html | 110 + ...ion.SimpleQueryReplaceByExampleResult.html | 118 + ...ion.SimpleQueryUpdateByExampleOptions.html | 136 + ...tion.SimpleQueryUpdateByExampleResult.html | 118 + 8.8.0/types/collection.TraversalOptions.html | 235 + 8.8.0/types/collection.ValidationLevel.html | 114 + 8.8.0/types/collection.WriteOperation.html | 107 + 8.8.0/types/connection.AgentOptions.html | 76 + 8.8.0/types/connection.ArangoApiResponse.html | 75 + .../connection.ArangoResponseMetadata.html | 81 + .../connection.BasicAuthCredentials.html | 81 + .../connection.BearerAuthCredentials.html | 77 + 8.8.0/types/connection.Config.html | 218 + 8.8.0/types/connection.Headers.html | 72 + .../connection.LoadBalancingStrategy.html | 81 + 8.8.0/types/connection.Params.html | 71 + .../types/connection.RequestInterceptors.html | 116 + 8.8.0/types/connection.RequestOptions.html | 127 + 8.8.0/types/connection.XhrOptions.html | 120 + 8.8.0/types/database.AccessLevel.html | 122 + 8.8.0/types/database.AqlUserFunction.html | 138 + 8.8.0/types/database.ArangoUser.html | 137 + 8.8.0/types/database.AstNode.html | 131 + .../types/database.ClusterImbalanceInfo.html | 191 + .../types/database.ClusterRebalanceMove.html | 143 + .../database.ClusterRebalanceOptions.html | 159 + .../database.ClusterRebalanceResult.html | 135 + .../types/database.ClusterRebalanceState.html | 122 + .../types/database.CreateDatabaseOptions.html | 147 + 8.8.0/types/database.CreateDatabaseUser.html | 143 + 8.8.0/types/database.CreateUserOptions.html | 143 + 8.8.0/types/database.DatabaseInfo.html | 157 + 8.8.0/types/database.ExplainOptions.html | 148 + 8.8.0/types/database.ExplainPlan.html | 153 + 8.8.0/types/database.ExplainStats.html | 145 + 8.8.0/types/database.HotBackupList.html | 129 + 8.8.0/types/database.HotBackupOptions.html | 150 + 8.8.0/types/database.HotBackupResult.html | 137 + .../types/database.InstallServiceOptions.html | 153 + 8.8.0/types/database.LogEntries.html | 137 + 8.8.0/types/database.LogEntriesOptions.html | 157 + 8.8.0/types/database.LogLevelLabel.html | 122 + 8.8.0/types/database.LogLevelSetting.html | 122 + 8.8.0/types/database.LogMessage.html | 135 + 8.8.0/types/database.LogSortDirection.html | 122 + 8.8.0/types/database.MultiExplainResult.html | 141 + .../database.MultiServiceDependency.html | 154 + 8.8.0/types/database.ParseResult.html | 141 + 8.8.0/types/database.QueryInfo.html | 165 + 8.8.0/types/database.QueryOptimizerRule.html | 142 + 8.8.0/types/database.QueryOptions.html | 278 ++ 8.8.0/types/database.QueryTracking.html | 150 + .../types/database.QueryTrackingOptions.html | 152 + 8.8.0/types/database.QueueTimeMetrics.html | 159 + .../types/database.ReplaceServiceOptions.html | 165 + .../types/database.ServiceConfiguration.html | 159 + 8.8.0/types/database.ServiceInfo.html | 170 + 8.8.0/types/database.ServiceSummary.html | 150 + .../database.ServiceTestDefaultReport.html | 135 + .../database.ServiceTestDefaultTest.html | 133 + 8.8.0/types/database.ServiceTestStats.html | 145 + .../database.ServiceTestStreamReport.html | 122 + .../types/database.ServiceTestStreamTest.html | 133 + 8.8.0/types/database.ServiceTestSuite.html | 131 + .../database.ServiceTestSuiteReport.html | 131 + .../types/database.ServiceTestSuiteTest.html | 133 + .../types/database.ServiceTestTapReport.html | 122 + .../database.ServiceTestXunitReport.html | 123 + .../types/database.ServiceTestXunitTest.html | 123 + 8.8.0/types/database.SingleExplainResult.html | 141 + .../database.SingleServiceDependency.html | 154 + 8.8.0/types/database.SwaggerJson.html | 143 + .../database.TransactionCollections.html | 141 + 8.8.0/types/database.TransactionDetails.html | 134 + 8.8.0/types/database.TransactionOptions.html | 152 + .../database.UninstallServiceOptions.html | 138 + .../types/database.UpgradeServiceOptions.html | 165 + .../database.UserAccessLevelOptions.html | 136 + 8.8.0/types/database.UserOptions.html | 139 + 8.8.0/types/database.VersionInfo.html | 144 + 8.8.0/types/documents.Document.html | 73 + 8.8.0/types/documents.DocumentData.html | 73 + 8.8.0/types/documents.DocumentMetadata.html | 85 + 8.8.0/types/documents.DocumentSelector.html | 71 + 8.8.0/types/documents.Edge.html | 73 + 8.8.0/types/documents.EdgeData.html | 73 + 8.8.0/types/documents.EdgeMetadata.html | 79 + 8.8.0/types/documents.ObjectWithId.html | 76 + 8.8.0/types/documents.ObjectWithKey.html | 76 + 8.8.0/types/documents.Patch.html | 76 + 8.8.0/types/foxx_manifest.Configuration.html | 81 + 8.8.0/types/foxx_manifest.Dependency.html | 85 + 8.8.0/types/foxx_manifest.File.html | 77 + 8.8.0/types/foxx_manifest.FoxxManifest.html | 137 + .../types/graph.AddEdgeDefinitionOptions.html | 79 + .../graph.AddVertexCollectionOptions.html | 79 + 8.8.0/types/graph.CreateGraphOptions.html | 126 + 8.8.0/types/graph.EdgeDefinition.html | 88 + 8.8.0/types/graph.EdgeDefinitionOptions.html | 88 + .../graph.GraphCollectionInsertOptions.html | 87 + .../graph.GraphCollectionReadOptions.html | 95 + .../graph.GraphCollectionRemoveOptions.html | 93 + .../graph.GraphCollectionReplaceOptions.html | 105 + 8.8.0/types/graph.GraphInfo.html | 123 + .../graph.ReplaceEdgeDefinitionOptions.html | 79 + .../indexes.EnsureFulltextIndexOptions.html | 109 + .../types/indexes.EnsureGeoIndexOptions.html | 81 + .../indexes.EnsureInvertedIndexOptions.html | 223 + .../types/indexes.EnsureMdiIndexOptions.html | 111 + .../indexes.EnsurePersistentIndexOptions.html | 137 + .../types/indexes.EnsureTtlIndexOptions.html | 107 + 8.8.0/types/indexes.FulltextIndex.html | 84 + 8.8.0/types/indexes.GenericIndex.html | 101 + 8.8.0/types/indexes.GeoIndex.html | 81 + 8.8.0/types/indexes.Index.html | 81 + 8.8.0/types/indexes.IndexSelector.html | 81 + 8.8.0/types/indexes.InvertedIndex.html | 81 + .../indexes.InvertedIndexFieldOptions.html | 133 + .../indexes.InvertedIndexNestedField.html | 95 + ...dexes.InvertedIndexNestedFieldOptions.html | 110 + ....InvertedIndexPrimarySortFieldOptions.html | 92 + ...dexes.InvertedIndexStoredValueOptions.html | 99 + 8.8.0/types/indexes.MdiIndex.html | 81 + 8.8.0/types/indexes.ObjectWithId.html | 86 + 8.8.0/types/indexes.ObjectWithName.html | 86 + 8.8.0/types/indexes.PersistentIndex.html | 81 + 8.8.0/types/indexes.PrimaryIndex.html | 81 + 8.8.0/types/indexes.TtlIndex.html | 81 + .../transaction.TransactionAbortOptions.html | 72 + .../transaction.TransactionCommitOptions.html | 72 + .../types/transaction.TransactionStatus.html | 75 + .../view.ArangoSearchViewDescription.html | 83 + 8.8.0/types/view.ArangoSearchViewLink.html | 102 + .../view.ArangoSearchViewLinkOptions.html | 133 + ...rangoSearchViewPatchPropertiesOptions.html | 85 + .../view.ArangoSearchViewProperties.html | 85 + ...iew.ArangoSearchViewPropertiesOptions.html | 115 + .../view.BytesAccumConsolidationPolicy.html | 100 + 8.8.0/types/view.Compression.html | 85 + .../view.CreateArangoSearchViewOptions.html | 85 + .../view.CreateSearchAliasViewOptions.html | 85 + 8.8.0/types/view.CreateViewOptions.html | 85 + 8.8.0/types/view.Direction.html | 85 + 8.8.0/types/view.GenericViewDescription.html | 100 + .../view.SearchAliasViewDescription.html | 83 + .../view.SearchAliasViewIndexOptions.html | 96 + ...view.SearchAliasViewPatchIndexOptions.html | 85 + ...SearchAliasViewPatchPropertiesOptions.html | 92 + .../types/view.SearchAliasViewProperties.html | 85 + ...view.SearchAliasViewPropertiesOptions.html | 92 + 8.8.0/types/view.TierConsolidationPolicy.html | 121 + 8.8.0/types/view.ViewDescription.html | 83 + .../view.ViewPatchPropertiesOptions.html | 85 + 8.8.0/types/view.ViewProperties.html | 83 + 8.8.0/types/view.ViewPropertiesOptions.html | 85 + _data/versions.json | 2 +- 297 files changed, 44063 insertions(+), 1 deletion(-) create mode 100644 8.8.0/.nojekyll create mode 100644 8.8.0/assets/highlight.css create mode 100644 8.8.0/assets/main.js create mode 100644 8.8.0/assets/search.js create mode 100644 8.8.0/assets/style.css create mode 100644 8.8.0/classes/analyzer.Analyzer.html create mode 100644 8.8.0/classes/cursor.ArrayCursor.html create mode 100644 8.8.0/classes/cursor.BatchedArrayCursor.html create mode 100644 8.8.0/classes/database.Database.html create mode 100644 8.8.0/classes/error.ArangoError.html create mode 100644 8.8.0/classes/error.HttpError.html create mode 100644 8.8.0/classes/graph.Graph.html create mode 100644 8.8.0/classes/graph.GraphEdgeCollection.html create mode 100644 8.8.0/classes/graph.GraphVertexCollection.html create mode 100644 8.8.0/classes/job.Job.html create mode 100644 8.8.0/classes/route.Route.html create mode 100644 8.8.0/classes/transaction.Transaction.html create mode 100644 8.8.0/classes/view.View.html create mode 100644 8.8.0/enums/collection.CollectionStatus.html create mode 100644 8.8.0/enums/collection.CollectionType.html create mode 100644 8.8.0/enums/database.LogLevel.html create mode 100644 8.8.0/functions/analyzer.isArangoAnalyzer.html create mode 100644 8.8.0/functions/aql.aql.html create mode 100644 8.8.0/functions/aql.isAqlLiteral.html create mode 100644 8.8.0/functions/aql.isAqlQuery.html create mode 100644 8.8.0/functions/aql.join.html create mode 100644 8.8.0/functions/aql.literal.html create mode 100644 8.8.0/functions/collection.collectionToString.html create mode 100644 8.8.0/functions/collection.isArangoCollection.html create mode 100644 8.8.0/functions/database.isArangoDatabase.html create mode 100644 8.8.0/functions/error.isArangoError.html create mode 100644 8.8.0/functions/error.isSystemError.html create mode 100644 8.8.0/functions/graph.isArangoGraph.html create mode 100644 8.8.0/functions/index.arangojs.html create mode 100644 8.8.0/functions/transaction.isArangoTransaction.html create mode 100644 8.8.0/functions/view.isArangoView.html create mode 100644 8.8.0/index.html create mode 100644 8.8.0/interfaces/aql.AqlLiteral.html create mode 100644 8.8.0/interfaces/aql.AqlQuery.html create mode 100644 8.8.0/interfaces/collection.ArangoCollection.html create mode 100644 8.8.0/interfaces/collection.DocumentCollection.html create mode 100644 8.8.0/interfaces/collection.EdgeCollection.html create mode 100644 8.8.0/interfaces/cursor.CursorExtras.html create mode 100644 8.8.0/interfaces/cursor.CursorStats.html create mode 100644 8.8.0/interfaces/error.SystemError.html create mode 100644 8.8.0/interfaces/view.ArangoSearchViewStoredValueOptions.html create mode 100644 8.8.0/modules.html create mode 100644 8.8.0/modules/analyzer.html create mode 100644 8.8.0/modules/aql.html create mode 100644 8.8.0/modules/collection.html create mode 100644 8.8.0/modules/connection.html create mode 100644 8.8.0/modules/cursor.html create mode 100644 8.8.0/modules/database.html create mode 100644 8.8.0/modules/documents.html create mode 100644 8.8.0/modules/error.html create mode 100644 8.8.0/modules/foxx_manifest.html create mode 100644 8.8.0/modules/graph.html create mode 100644 8.8.0/modules/index.html create mode 100644 8.8.0/modules/indexes.html create mode 100644 8.8.0/modules/job.html create mode 100644 8.8.0/modules/route.html create mode 100644 8.8.0/modules/transaction.html create mode 100644 8.8.0/modules/view.html create mode 100644 8.8.0/types/analyzer.AnalyzerDescription.html create mode 100644 8.8.0/types/analyzer.AnalyzerFeature.html create mode 100644 8.8.0/types/analyzer.AqlAnalyzerDescription.html create mode 100644 8.8.0/types/analyzer.ClassificationAnalyzerDescription.html create mode 100644 8.8.0/types/analyzer.CollationAnalyzerDescription.html create mode 100644 8.8.0/types/analyzer.CreateAnalyzerOptions.html create mode 100644 8.8.0/types/analyzer.CreateAqlAnalyzerOptions.html create mode 100644 8.8.0/types/analyzer.CreateClassificationAnalyzerOptions.html create mode 100644 8.8.0/types/analyzer.CreateCollationAnalyzerOptions.html create mode 100644 8.8.0/types/analyzer.CreateDelimiterAnalyzerOptions.html create mode 100644 8.8.0/types/analyzer.CreateGeoJsonAnalyzerOptions.html create mode 100644 8.8.0/types/analyzer.CreateGeoPointAnalyzerOptions.html create mode 100644 8.8.0/types/analyzer.CreateGeoS2AnalyzerOptions.html create mode 100644 8.8.0/types/analyzer.CreateIdentityAnalyzerOptions.html create mode 100644 8.8.0/types/analyzer.CreateMinHashAnalyzerOptions.html create mode 100644 8.8.0/types/analyzer.CreateMultiDelimiterAnalyzerOptions.html create mode 100644 8.8.0/types/analyzer.CreateNearestNeighborsAnalyzerOptions.html create mode 100644 8.8.0/types/analyzer.CreateNgramAnalyzerOptions.html create mode 100644 8.8.0/types/analyzer.CreateNormAnalyzerOptions.html create mode 100644 8.8.0/types/analyzer.CreatePipelineAnalyzerOptions.html create mode 100644 8.8.0/types/analyzer.CreateSegmentationAnalyzerOptions.html create mode 100644 8.8.0/types/analyzer.CreateStemAnalyzerOptions.html create mode 100644 8.8.0/types/analyzer.CreateStopwordsAnalyzerOptions.html create mode 100644 8.8.0/types/analyzer.CreateTextAnalyzerOptions.html create mode 100644 8.8.0/types/analyzer.CreateWildcardAnalyzerOptions.html create mode 100644 8.8.0/types/analyzer.DelimiterAnalyzerDescription.html create mode 100644 8.8.0/types/analyzer.GenericAnalyzerDescription.html create mode 100644 8.8.0/types/analyzer.GeoJsonAnalyzerDescription.html create mode 100644 8.8.0/types/analyzer.GeoPointAnalyzerDescription.html create mode 100644 8.8.0/types/analyzer.GeoS2AnalyzerDescription.html create mode 100644 8.8.0/types/analyzer.IdentityAnalyzerDescription.html create mode 100644 8.8.0/types/analyzer.MinHashAnalyzerDescription.html create mode 100644 8.8.0/types/analyzer.MultiDelimiterAnalyzerDescription.html create mode 100644 8.8.0/types/analyzer.NearestNeighborsAnalyzerDescription.html create mode 100644 8.8.0/types/analyzer.NgramAnalyzerDescription.html create mode 100644 8.8.0/types/analyzer.NormAnalyzerDescription.html create mode 100644 8.8.0/types/analyzer.PipelineAnalyzerDescription.html create mode 100644 8.8.0/types/analyzer.SegmentationAnalyzerDescription.html create mode 100644 8.8.0/types/analyzer.StemAnalyzerDescription.html create mode 100644 8.8.0/types/analyzer.StopwordsAnalyzerDescription.html create mode 100644 8.8.0/types/analyzer.TextAnalyzerDescription.html create mode 100644 8.8.0/types/analyzer.WildcardAnalyzerDescription.html create mode 100644 8.8.0/types/aql.AqlValue.html create mode 100644 8.8.0/types/collection.CollectionBatchReadOptions.html create mode 100644 8.8.0/types/collection.CollectionChecksumOptions.html create mode 100644 8.8.0/types/collection.CollectionDropOptions.html create mode 100644 8.8.0/types/collection.CollectionEdgesOptions.html create mode 100644 8.8.0/types/collection.CollectionEdgesResult.html create mode 100644 8.8.0/types/collection.CollectionImportOptions.html create mode 100644 8.8.0/types/collection.CollectionImportResult.html create mode 100644 8.8.0/types/collection.CollectionInsertOptions.html create mode 100644 8.8.0/types/collection.CollectionKeyOptions.html create mode 100644 8.8.0/types/collection.CollectionKeyProperties.html create mode 100644 8.8.0/types/collection.CollectionMetadata.html create mode 100644 8.8.0/types/collection.CollectionProperties.html create mode 100644 8.8.0/types/collection.CollectionPropertiesOptions.html create mode 100644 8.8.0/types/collection.CollectionReadOptions.html create mode 100644 8.8.0/types/collection.CollectionRemoveOptions.html create mode 100644 8.8.0/types/collection.CollectionReplaceOptions.html create mode 100644 8.8.0/types/collection.CollectionUpdateOptions.html create mode 100644 8.8.0/types/collection.ComputedValueOptions.html create mode 100644 8.8.0/types/collection.ComputedValueProperties.html create mode 100644 8.8.0/types/collection.CreateCollectionOptions.html create mode 100644 8.8.0/types/collection.DocumentExistsOptions.html create mode 100644 8.8.0/types/collection.DocumentOperationFailure.html create mode 100644 8.8.0/types/collection.DocumentOperationMetadata.html create mode 100644 8.8.0/types/collection.KeyGenerator.html create mode 100644 8.8.0/types/collection.SchemaOptions.html create mode 100644 8.8.0/types/collection.SchemaProperties.html create mode 100644 8.8.0/types/collection.ShardingStrategy.html create mode 100644 8.8.0/types/collection.SimpleQueryAllOptions.html create mode 100644 8.8.0/types/collection.SimpleQueryByExampleOptions.html create mode 100644 8.8.0/types/collection.SimpleQueryFulltextOptions.html create mode 100644 8.8.0/types/collection.SimpleQueryListType.html create mode 100644 8.8.0/types/collection.SimpleQueryRemoveByExampleOptions.html create mode 100644 8.8.0/types/collection.SimpleQueryRemoveByExampleResult.html create mode 100644 8.8.0/types/collection.SimpleQueryRemoveByKeysOptions.html create mode 100644 8.8.0/types/collection.SimpleQueryRemoveByKeysResult.html create mode 100644 8.8.0/types/collection.SimpleQueryReplaceByExampleOptions.html create mode 100644 8.8.0/types/collection.SimpleQueryReplaceByExampleResult.html create mode 100644 8.8.0/types/collection.SimpleQueryUpdateByExampleOptions.html create mode 100644 8.8.0/types/collection.SimpleQueryUpdateByExampleResult.html create mode 100644 8.8.0/types/collection.TraversalOptions.html create mode 100644 8.8.0/types/collection.ValidationLevel.html create mode 100644 8.8.0/types/collection.WriteOperation.html create mode 100644 8.8.0/types/connection.AgentOptions.html create mode 100644 8.8.0/types/connection.ArangoApiResponse.html create mode 100644 8.8.0/types/connection.ArangoResponseMetadata.html create mode 100644 8.8.0/types/connection.BasicAuthCredentials.html create mode 100644 8.8.0/types/connection.BearerAuthCredentials.html create mode 100644 8.8.0/types/connection.Config.html create mode 100644 8.8.0/types/connection.Headers.html create mode 100644 8.8.0/types/connection.LoadBalancingStrategy.html create mode 100644 8.8.0/types/connection.Params.html create mode 100644 8.8.0/types/connection.RequestInterceptors.html create mode 100644 8.8.0/types/connection.RequestOptions.html create mode 100644 8.8.0/types/connection.XhrOptions.html create mode 100644 8.8.0/types/database.AccessLevel.html create mode 100644 8.8.0/types/database.AqlUserFunction.html create mode 100644 8.8.0/types/database.ArangoUser.html create mode 100644 8.8.0/types/database.AstNode.html create mode 100644 8.8.0/types/database.ClusterImbalanceInfo.html create mode 100644 8.8.0/types/database.ClusterRebalanceMove.html create mode 100644 8.8.0/types/database.ClusterRebalanceOptions.html create mode 100644 8.8.0/types/database.ClusterRebalanceResult.html create mode 100644 8.8.0/types/database.ClusterRebalanceState.html create mode 100644 8.8.0/types/database.CreateDatabaseOptions.html create mode 100644 8.8.0/types/database.CreateDatabaseUser.html create mode 100644 8.8.0/types/database.CreateUserOptions.html create mode 100644 8.8.0/types/database.DatabaseInfo.html create mode 100644 8.8.0/types/database.ExplainOptions.html create mode 100644 8.8.0/types/database.ExplainPlan.html create mode 100644 8.8.0/types/database.ExplainStats.html create mode 100644 8.8.0/types/database.HotBackupList.html create mode 100644 8.8.0/types/database.HotBackupOptions.html create mode 100644 8.8.0/types/database.HotBackupResult.html create mode 100644 8.8.0/types/database.InstallServiceOptions.html create mode 100644 8.8.0/types/database.LogEntries.html create mode 100644 8.8.0/types/database.LogEntriesOptions.html create mode 100644 8.8.0/types/database.LogLevelLabel.html create mode 100644 8.8.0/types/database.LogLevelSetting.html create mode 100644 8.8.0/types/database.LogMessage.html create mode 100644 8.8.0/types/database.LogSortDirection.html create mode 100644 8.8.0/types/database.MultiExplainResult.html create mode 100644 8.8.0/types/database.MultiServiceDependency.html create mode 100644 8.8.0/types/database.ParseResult.html create mode 100644 8.8.0/types/database.QueryInfo.html create mode 100644 8.8.0/types/database.QueryOptimizerRule.html create mode 100644 8.8.0/types/database.QueryOptions.html create mode 100644 8.8.0/types/database.QueryTracking.html create mode 100644 8.8.0/types/database.QueryTrackingOptions.html create mode 100644 8.8.0/types/database.QueueTimeMetrics.html create mode 100644 8.8.0/types/database.ReplaceServiceOptions.html create mode 100644 8.8.0/types/database.ServiceConfiguration.html create mode 100644 8.8.0/types/database.ServiceInfo.html create mode 100644 8.8.0/types/database.ServiceSummary.html create mode 100644 8.8.0/types/database.ServiceTestDefaultReport.html create mode 100644 8.8.0/types/database.ServiceTestDefaultTest.html create mode 100644 8.8.0/types/database.ServiceTestStats.html create mode 100644 8.8.0/types/database.ServiceTestStreamReport.html create mode 100644 8.8.0/types/database.ServiceTestStreamTest.html create mode 100644 8.8.0/types/database.ServiceTestSuite.html create mode 100644 8.8.0/types/database.ServiceTestSuiteReport.html create mode 100644 8.8.0/types/database.ServiceTestSuiteTest.html create mode 100644 8.8.0/types/database.ServiceTestTapReport.html create mode 100644 8.8.0/types/database.ServiceTestXunitReport.html create mode 100644 8.8.0/types/database.ServiceTestXunitTest.html create mode 100644 8.8.0/types/database.SingleExplainResult.html create mode 100644 8.8.0/types/database.SingleServiceDependency.html create mode 100644 8.8.0/types/database.SwaggerJson.html create mode 100644 8.8.0/types/database.TransactionCollections.html create mode 100644 8.8.0/types/database.TransactionDetails.html create mode 100644 8.8.0/types/database.TransactionOptions.html create mode 100644 8.8.0/types/database.UninstallServiceOptions.html create mode 100644 8.8.0/types/database.UpgradeServiceOptions.html create mode 100644 8.8.0/types/database.UserAccessLevelOptions.html create mode 100644 8.8.0/types/database.UserOptions.html create mode 100644 8.8.0/types/database.VersionInfo.html create mode 100644 8.8.0/types/documents.Document.html create mode 100644 8.8.0/types/documents.DocumentData.html create mode 100644 8.8.0/types/documents.DocumentMetadata.html create mode 100644 8.8.0/types/documents.DocumentSelector.html create mode 100644 8.8.0/types/documents.Edge.html create mode 100644 8.8.0/types/documents.EdgeData.html create mode 100644 8.8.0/types/documents.EdgeMetadata.html create mode 100644 8.8.0/types/documents.ObjectWithId.html create mode 100644 8.8.0/types/documents.ObjectWithKey.html create mode 100644 8.8.0/types/documents.Patch.html create mode 100644 8.8.0/types/foxx_manifest.Configuration.html create mode 100644 8.8.0/types/foxx_manifest.Dependency.html create mode 100644 8.8.0/types/foxx_manifest.File.html create mode 100644 8.8.0/types/foxx_manifest.FoxxManifest.html create mode 100644 8.8.0/types/graph.AddEdgeDefinitionOptions.html create mode 100644 8.8.0/types/graph.AddVertexCollectionOptions.html create mode 100644 8.8.0/types/graph.CreateGraphOptions.html create mode 100644 8.8.0/types/graph.EdgeDefinition.html create mode 100644 8.8.0/types/graph.EdgeDefinitionOptions.html create mode 100644 8.8.0/types/graph.GraphCollectionInsertOptions.html create mode 100644 8.8.0/types/graph.GraphCollectionReadOptions.html create mode 100644 8.8.0/types/graph.GraphCollectionRemoveOptions.html create mode 100644 8.8.0/types/graph.GraphCollectionReplaceOptions.html create mode 100644 8.8.0/types/graph.GraphInfo.html create mode 100644 8.8.0/types/graph.ReplaceEdgeDefinitionOptions.html create mode 100644 8.8.0/types/indexes.EnsureFulltextIndexOptions.html create mode 100644 8.8.0/types/indexes.EnsureGeoIndexOptions.html create mode 100644 8.8.0/types/indexes.EnsureInvertedIndexOptions.html create mode 100644 8.8.0/types/indexes.EnsureMdiIndexOptions.html create mode 100644 8.8.0/types/indexes.EnsurePersistentIndexOptions.html create mode 100644 8.8.0/types/indexes.EnsureTtlIndexOptions.html create mode 100644 8.8.0/types/indexes.FulltextIndex.html create mode 100644 8.8.0/types/indexes.GenericIndex.html create mode 100644 8.8.0/types/indexes.GeoIndex.html create mode 100644 8.8.0/types/indexes.Index.html create mode 100644 8.8.0/types/indexes.IndexSelector.html create mode 100644 8.8.0/types/indexes.InvertedIndex.html create mode 100644 8.8.0/types/indexes.InvertedIndexFieldOptions.html create mode 100644 8.8.0/types/indexes.InvertedIndexNestedField.html create mode 100644 8.8.0/types/indexes.InvertedIndexNestedFieldOptions.html create mode 100644 8.8.0/types/indexes.InvertedIndexPrimarySortFieldOptions.html create mode 100644 8.8.0/types/indexes.InvertedIndexStoredValueOptions.html create mode 100644 8.8.0/types/indexes.MdiIndex.html create mode 100644 8.8.0/types/indexes.ObjectWithId.html create mode 100644 8.8.0/types/indexes.ObjectWithName.html create mode 100644 8.8.0/types/indexes.PersistentIndex.html create mode 100644 8.8.0/types/indexes.PrimaryIndex.html create mode 100644 8.8.0/types/indexes.TtlIndex.html create mode 100644 8.8.0/types/transaction.TransactionAbortOptions.html create mode 100644 8.8.0/types/transaction.TransactionCommitOptions.html create mode 100644 8.8.0/types/transaction.TransactionStatus.html create mode 100644 8.8.0/types/view.ArangoSearchViewDescription.html create mode 100644 8.8.0/types/view.ArangoSearchViewLink.html create mode 100644 8.8.0/types/view.ArangoSearchViewLinkOptions.html create mode 100644 8.8.0/types/view.ArangoSearchViewPatchPropertiesOptions.html create mode 100644 8.8.0/types/view.ArangoSearchViewProperties.html create mode 100644 8.8.0/types/view.ArangoSearchViewPropertiesOptions.html create mode 100644 8.8.0/types/view.BytesAccumConsolidationPolicy.html create mode 100644 8.8.0/types/view.Compression.html create mode 100644 8.8.0/types/view.CreateArangoSearchViewOptions.html create mode 100644 8.8.0/types/view.CreateSearchAliasViewOptions.html create mode 100644 8.8.0/types/view.CreateViewOptions.html create mode 100644 8.8.0/types/view.Direction.html create mode 100644 8.8.0/types/view.GenericViewDescription.html create mode 100644 8.8.0/types/view.SearchAliasViewDescription.html create mode 100644 8.8.0/types/view.SearchAliasViewIndexOptions.html create mode 100644 8.8.0/types/view.SearchAliasViewPatchIndexOptions.html create mode 100644 8.8.0/types/view.SearchAliasViewPatchPropertiesOptions.html create mode 100644 8.8.0/types/view.SearchAliasViewProperties.html create mode 100644 8.8.0/types/view.SearchAliasViewPropertiesOptions.html create mode 100644 8.8.0/types/view.TierConsolidationPolicy.html create mode 100644 8.8.0/types/view.ViewDescription.html create mode 100644 8.8.0/types/view.ViewPatchPropertiesOptions.html create mode 100644 8.8.0/types/view.ViewProperties.html create mode 100644 8.8.0/types/view.ViewPropertiesOptions.html diff --git a/8.8.0/.nojekyll b/8.8.0/.nojekyll new file mode 100644 index 000000000..e2ac6616a --- /dev/null +++ b/8.8.0/.nojekyll @@ -0,0 +1 @@ +TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false. \ No newline at end of file diff --git a/8.8.0/assets/highlight.css b/8.8.0/assets/highlight.css new file mode 100644 index 000000000..d4903f6be --- /dev/null +++ b/8.8.0/assets/highlight.css @@ -0,0 +1,141 @@ +:root { + --light-hl-0: #795E26; + --dark-hl-0: #DCDCAA; + --light-hl-1: #000000; + --dark-hl-1: #D4D4D4; + --light-hl-2: #A31515; + --dark-hl-2: #CE9178; + --light-hl-3: #0000FF; + --dark-hl-3: #569CD6; + --light-hl-4: #008000; + --dark-hl-4: #6A9955; + --light-hl-5: #001080; + --dark-hl-5: #9CDCFE; + --light-hl-6: #CD3131; + --dark-hl-6: #F44747; + --light-hl-7: #800000; + --dark-hl-7: #808080; + --light-hl-8: #800000; + --dark-hl-8: #569CD6; + --light-hl-9: #000000FF; + --dark-hl-9: #D4D4D4; + --light-hl-10: #E50000; + --dark-hl-10: #9CDCFE; + --light-hl-11: #0000FF; + --dark-hl-11: #CE9178; + --light-hl-12: #0070C1; + --dark-hl-12: #4FC1FF; + --light-hl-13: #AF00DB; + --dark-hl-13: #C586C0; + --light-hl-14: #098658; + --dark-hl-14: #B5CEA8; + --light-hl-15: #267F99; + --dark-hl-15: #4EC9B0; + --light-hl-16: #EE0000; + --dark-hl-16: #D7BA7D; + --light-code-background: #FFFFFF; + --dark-code-background: #1E1E1E; +} + +@media (prefers-color-scheme: light) { :root { + --hl-0: var(--light-hl-0); + --hl-1: var(--light-hl-1); + --hl-2: var(--light-hl-2); + --hl-3: var(--light-hl-3); + --hl-4: var(--light-hl-4); + --hl-5: var(--light-hl-5); + --hl-6: var(--light-hl-6); + --hl-7: var(--light-hl-7); + --hl-8: var(--light-hl-8); + --hl-9: var(--light-hl-9); + --hl-10: var(--light-hl-10); + --hl-11: var(--light-hl-11); + --hl-12: var(--light-hl-12); + --hl-13: var(--light-hl-13); + --hl-14: var(--light-hl-14); + --hl-15: var(--light-hl-15); + --hl-16: var(--light-hl-16); + --code-background: var(--light-code-background); +} } + +@media (prefers-color-scheme: dark) { :root { + --hl-0: var(--dark-hl-0); + --hl-1: var(--dark-hl-1); + --hl-2: var(--dark-hl-2); + --hl-3: var(--dark-hl-3); + --hl-4: var(--dark-hl-4); + --hl-5: var(--dark-hl-5); + --hl-6: var(--dark-hl-6); + --hl-7: var(--dark-hl-7); + --hl-8: var(--dark-hl-8); + --hl-9: var(--dark-hl-9); + --hl-10: var(--dark-hl-10); + --hl-11: var(--dark-hl-11); + --hl-12: var(--dark-hl-12); + --hl-13: var(--dark-hl-13); + --hl-14: var(--dark-hl-14); + --hl-15: var(--dark-hl-15); + --hl-16: var(--dark-hl-16); + --code-background: var(--dark-code-background); +} } + +:root[data-theme='light'] { + --hl-0: var(--light-hl-0); + --hl-1: var(--light-hl-1); + --hl-2: var(--light-hl-2); + --hl-3: var(--light-hl-3); + --hl-4: var(--light-hl-4); + --hl-5: var(--light-hl-5); + --hl-6: var(--light-hl-6); + --hl-7: var(--light-hl-7); + --hl-8: var(--light-hl-8); + --hl-9: var(--light-hl-9); + --hl-10: var(--light-hl-10); + --hl-11: var(--light-hl-11); + --hl-12: var(--light-hl-12); + --hl-13: var(--light-hl-13); + --hl-14: var(--light-hl-14); + --hl-15: var(--light-hl-15); + --hl-16: var(--light-hl-16); + --code-background: var(--light-code-background); +} + +:root[data-theme='dark'] { + --hl-0: var(--dark-hl-0); + --hl-1: var(--dark-hl-1); + --hl-2: var(--dark-hl-2); + --hl-3: var(--dark-hl-3); + --hl-4: var(--dark-hl-4); + --hl-5: var(--dark-hl-5); + --hl-6: var(--dark-hl-6); + --hl-7: var(--dark-hl-7); + --hl-8: var(--dark-hl-8); + --hl-9: var(--dark-hl-9); + --hl-10: var(--dark-hl-10); + --hl-11: var(--dark-hl-11); + --hl-12: var(--dark-hl-12); + --hl-13: var(--dark-hl-13); + --hl-14: var(--dark-hl-14); + --hl-15: var(--dark-hl-15); + --hl-16: var(--dark-hl-16); + --code-background: var(--dark-code-background); +} + +.hl-0 { color: var(--hl-0); } +.hl-1 { color: var(--hl-1); } +.hl-2 { color: var(--hl-2); } +.hl-3 { color: var(--hl-3); } +.hl-4 { color: var(--hl-4); } +.hl-5 { color: var(--hl-5); } +.hl-6 { color: var(--hl-6); } +.hl-7 { color: var(--hl-7); } +.hl-8 { color: var(--hl-8); } +.hl-9 { color: var(--hl-9); } +.hl-10 { color: var(--hl-10); } +.hl-11 { color: var(--hl-11); } +.hl-12 { color: var(--hl-12); } +.hl-13 { color: var(--hl-13); } +.hl-14 { color: var(--hl-14); } +.hl-15 { color: var(--hl-15); } +.hl-16 { color: var(--hl-16); } +pre, code { background: var(--code-background); } diff --git a/8.8.0/assets/main.js b/8.8.0/assets/main.js new file mode 100644 index 000000000..f7c83669c --- /dev/null +++ b/8.8.0/assets/main.js @@ -0,0 +1,58 @@ +"use strict"; +"use strict";(()=>{var Qe=Object.create;var ae=Object.defineProperty;var Pe=Object.getOwnPropertyDescriptor;var Ce=Object.getOwnPropertyNames;var Oe=Object.getPrototypeOf,Re=Object.prototype.hasOwnProperty;var _e=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var Me=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Ce(e))!Re.call(t,i)&&i!==n&&ae(t,i,{get:()=>e[i],enumerable:!(r=Pe(e,i))||r.enumerable});return t};var De=(t,e,n)=>(n=t!=null?Qe(Oe(t)):{},Me(e||!t||!t.__esModule?ae(n,"default",{value:t,enumerable:!0}):n,t));var de=_e((ce,he)=>{(function(){var t=function(e){var n=new t.Builder;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),n.searchPipeline.add(t.stemmer),e.call(n,n),n.build()};t.version="2.3.9";t.utils={},t.utils.warn=function(e){return function(n){e.console&&console.warn&&console.warn(n)}}(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var n=Object.create(null),r=Object.keys(e),i=0;i0){var h=t.utils.clone(n)||{};h.position=[a,l],h.index=s.length,s.push(new t.Token(r.slice(a,o),h))}a=o+1}}return s},t.tokenizer.separator=/[\s\-]+/;t.Pipeline=function(){this._stack=[]},t.Pipeline.registeredFunctions=Object.create(null),t.Pipeline.registerFunction=function(e,n){n in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+n),e.label=n,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var n=e.label&&e.label in this.registeredFunctions;n||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. +`,e)},t.Pipeline.load=function(e){var n=new t.Pipeline;return e.forEach(function(r){var i=t.Pipeline.registeredFunctions[r];if(i)n.add(i);else throw new Error("Cannot load unregistered function: "+r)}),n},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(n){t.Pipeline.warnIfFunctionNotRegistered(n),this._stack.push(n)},this)},t.Pipeline.prototype.after=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");r=r+1,this._stack.splice(r,0,n)},t.Pipeline.prototype.before=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");this._stack.splice(r,0,n)},t.Pipeline.prototype.remove=function(e){var n=this._stack.indexOf(e);n!=-1&&this._stack.splice(n,1)},t.Pipeline.prototype.run=function(e){for(var n=this._stack.length,r=0;r1&&(oe&&(r=s),o!=e);)i=r-n,s=n+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(ou?h+=2:a==u&&(n+=r[l+1]*i[h+1],l+=2,h+=2);return n},t.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},t.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),n=1,r=0;n0){var o=s.str.charAt(0),a;o in s.node.edges?a=s.node.edges[o]:(a=new t.TokenSet,s.node.edges[o]=a),s.str.length==1&&(a.final=!0),i.push({node:a,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(s.editsRemaining!=0){if("*"in s.node.edges)var u=s.node.edges["*"];else{var u=new t.TokenSet;s.node.edges["*"]=u}if(s.str.length==0&&(u.final=!0),i.push({node:u,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&i.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),s.str.length==1&&(s.node.final=!0),s.str.length>=1){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}s.str.length==1&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var h=s.str.charAt(0),m=s.str.charAt(1),v;m in s.node.edges?v=s.node.edges[m]:(v=new t.TokenSet,s.node.edges[m]=v),s.str.length==1&&(v.final=!0),i.push({node:v,editsRemaining:s.editsRemaining-1,str:h+s.str.slice(2)})}}}return r},t.TokenSet.fromString=function(e){for(var n=new t.TokenSet,r=n,i=0,s=e.length;i=e;n--){var r=this.uncheckedNodes[n],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r.char]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}};t.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},t.Index.prototype.search=function(e){return this.query(function(n){var r=new t.QueryParser(e,n);r.parse()})},t.Index.prototype.query=function(e){for(var n=new t.Query(this.fields),r=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),u=0;u1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,n){var r=e[this._ref],i=Object.keys(this._fields);this._documents[r]=n||{},this.documentCount+=1;for(var s=0;s=this.length)return t.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},t.QueryLexer.prototype.width=function(){return this.pos-this.start},t.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},t.QueryLexer.prototype.backup=function(){this.pos-=1},t.QueryLexer.prototype.acceptDigitRun=function(){var e,n;do e=this.next(),n=e.charCodeAt(0);while(n>47&&n<58);e!=t.QueryLexer.EOS&&this.backup()},t.QueryLexer.prototype.more=function(){return this.pos1&&(e.backup(),e.emit(t.QueryLexer.TERM)),e.ignore(),e.more())return t.QueryLexer.lexText},t.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.EDIT_DISTANCE),t.QueryLexer.lexText},t.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.BOOST),t.QueryLexer.lexText},t.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(t.QueryLexer.TERM)},t.QueryLexer.termSeparator=t.tokenizer.separator,t.QueryLexer.lexText=function(e){for(;;){var n=e.next();if(n==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(n.charCodeAt(0)==92){e.escapeCharacter();continue}if(n==":")return t.QueryLexer.lexField;if(n=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(n=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(n=="+"&&e.width()===1||n=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(n.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,n){this.lexer=new t.QueryLexer(e),this.query=n,this.currentClause={},this.lexemeIdx=0},t.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=t.QueryParser.parseClause;e;)e=e(this);return this.query},t.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},t.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},t.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},t.QueryParser.parseClause=function(e){var n=e.peekLexeme();if(n!=null)switch(n.type){case t.QueryLexer.PRESENCE:return t.QueryParser.parsePresence;case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expected either a field or a term, found "+n.type;throw n.str.length>=1&&(r+=" with value '"+n.str+"'"),new t.QueryParseError(r,n.start,n.end)}},t.QueryParser.parsePresence=function(e){var n=e.consumeLexeme();if(n!=null){switch(n.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var r="unrecognised presence operator'"+n.str+"'";throw new t.QueryParseError(r,n.start,n.end)}var i=e.peekLexeme();if(i==null){var r="expecting term or field, found nothing";throw new t.QueryParseError(r,n.start,n.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(r,i.start,i.end)}}},t.QueryParser.parseField=function(e){var n=e.consumeLexeme();if(n!=null){if(e.query.allFields.indexOf(n.str)==-1){var r=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+n.str+"', possible fields: "+r;throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.fields=[n.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,n.start,n.end)}switch(s.type){case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var i="expecting term, found '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseTerm=function(e){var n=e.consumeLexeme();if(n!=null){e.currentClause.term=n.str.toLowerCase(),n.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var r=e.peekLexeme();if(r==null){e.nextClause();return}switch(r.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+r.type+"'";throw new t.QueryParseError(i,r.start,r.end)}}},t.QueryParser.parseEditDistance=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="edit distance must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.editDistance=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseBoost=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="boost must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.boost=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},function(e,n){typeof define=="function"&&define.amd?define(n):typeof ce=="object"?he.exports=n():e.lunr=n()}(this,function(){return t})})()});var le=[];function B(t,e){le.push({selector:e,constructor:t})}var Y=class{constructor(){this.alwaysVisibleMember=null;this.createComponents(document.body),this.ensureFocusedElementVisible(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible())}createComponents(e){le.forEach(n=>{e.querySelectorAll(n.selector).forEach(r=>{r.dataset.hasInstance||(new n.constructor({el:r,app:this}),r.dataset.hasInstance=String(!0))})})}filterChanged(){this.ensureFocusedElementVisible()}ensureFocusedElementVisible(){this.alwaysVisibleMember&&(this.alwaysVisibleMember.classList.remove("always-visible"),this.alwaysVisibleMember.firstElementChild.remove(),this.alwaysVisibleMember=null);let e=document.getElementById(location.hash.substring(1));if(!e)return;let n=e.parentElement;for(;n&&n.tagName!=="SECTION";)n=n.parentElement;if(n&&n.offsetParent==null){this.alwaysVisibleMember=n,n.classList.add("always-visible");let r=document.createElement("p");r.classList.add("warning"),r.textContent="This member is normally hidden due to your filter settings.",n.prepend(r)}}};var I=class{constructor(e){this.el=e.el,this.app=e.app}};var J=class{constructor(){this.listeners={}}addEventListener(e,n){e in this.listeners||(this.listeners[e]=[]),this.listeners[e].push(n)}removeEventListener(e,n){if(!(e in this.listeners))return;let r=this.listeners[e];for(let i=0,s=r.length;i{let n=Date.now();return(...r)=>{n+e-Date.now()<0&&(t(...r),n=Date.now())}};var re=class extends J{constructor(){super();this.scrollTop=0;this.lastY=0;this.width=0;this.height=0;this.showToolbar=!0;this.toolbar=document.querySelector(".tsd-page-toolbar"),this.navigation=document.querySelector(".col-menu"),window.addEventListener("scroll",ne(()=>this.onScroll(),10)),window.addEventListener("resize",ne(()=>this.onResize(),10)),this.searchInput=document.querySelector("#tsd-search input"),this.searchInput&&this.searchInput.addEventListener("focus",()=>{this.hideShowToolbar()}),this.onResize(),this.onScroll()}triggerResize(){let n=new CustomEvent("resize",{detail:{width:this.width,height:this.height}});this.dispatchEvent(n)}onResize(){this.width=window.innerWidth||0,this.height=window.innerHeight||0;let n=new CustomEvent("resize",{detail:{width:this.width,height:this.height}});this.dispatchEvent(n)}onScroll(){this.scrollTop=window.scrollY||0;let n=new CustomEvent("scroll",{detail:{scrollTop:this.scrollTop}});this.dispatchEvent(n),this.hideShowToolbar()}hideShowToolbar(){let n=this.showToolbar;this.showToolbar=this.lastY>=this.scrollTop||this.scrollTop<=0||!!this.searchInput&&this.searchInput===document.activeElement,n!==this.showToolbar&&(this.toolbar.classList.toggle("tsd-page-toolbar--hide"),this.navigation?.classList.toggle("col-menu--hide")),this.lastY=this.scrollTop}},R=re;R.instance=new re;var X=class extends I{constructor(n){super(n);this.anchors=[];this.index=-1;R.instance.addEventListener("resize",()=>this.onResize()),R.instance.addEventListener("scroll",r=>this.onScroll(r)),this.createAnchors()}createAnchors(){let n=window.location.href;n.indexOf("#")!=-1&&(n=n.substring(0,n.indexOf("#"))),this.el.querySelectorAll("a").forEach(r=>{let i=r.href;if(i.indexOf("#")==-1||i.substring(0,n.length)!=n)return;let s=i.substring(i.indexOf("#")+1),o=document.querySelector("a.tsd-anchor[name="+s+"]"),a=r.parentNode;!o||!a||this.anchors.push({link:a,anchor:o,position:0})}),this.onResize()}onResize(){let n;for(let i=0,s=this.anchors.length;ii.position-s.position);let r=new CustomEvent("scroll",{detail:{scrollTop:R.instance.scrollTop}});this.onScroll(r)}onScroll(n){let r=n.detail.scrollTop+5,i=this.anchors,s=i.length-1,o=this.index;for(;o>-1&&i[o].position>r;)o-=1;for(;o-1&&this.anchors[this.index].link.classList.remove("focus"),this.index=o,this.index>-1&&this.anchors[this.index].link.classList.add("focus"))}};var ue=(t,e=100)=>{let n;return()=>{clearTimeout(n),n=setTimeout(()=>t(),e)}};var me=De(de());function ve(){let t=document.getElementById("tsd-search");if(!t)return;let e=document.getElementById("search-script");t.classList.add("loading"),e&&(e.addEventListener("error",()=>{t.classList.remove("loading"),t.classList.add("failure")}),e.addEventListener("load",()=>{t.classList.remove("loading"),t.classList.add("ready")}),window.searchData&&t.classList.remove("loading"));let n=document.querySelector("#tsd-search input"),r=document.querySelector("#tsd-search .results");if(!n||!r)throw new Error("The input field or the result list wrapper was not found");let i=!1;r.addEventListener("mousedown",()=>i=!0),r.addEventListener("mouseup",()=>{i=!1,t.classList.remove("has-focus")}),n.addEventListener("focus",()=>t.classList.add("has-focus")),n.addEventListener("blur",()=>{i||(i=!1,t.classList.remove("has-focus"))});let s={base:t.dataset.base+"/"};Fe(t,r,n,s)}function Fe(t,e,n,r){n.addEventListener("input",ue(()=>{He(t,e,n,r)},200));let i=!1;n.addEventListener("keydown",s=>{i=!0,s.key=="Enter"?Ve(e,n):s.key=="Escape"?n.blur():s.key=="ArrowUp"?pe(e,-1):s.key==="ArrowDown"?pe(e,1):i=!1}),n.addEventListener("keypress",s=>{i&&s.preventDefault()}),document.body.addEventListener("keydown",s=>{s.altKey||s.ctrlKey||s.metaKey||!n.matches(":focus")&&s.key==="/"&&(n.focus(),s.preventDefault())})}function Ae(t,e){t.index||window.searchData&&(e.classList.remove("loading"),e.classList.add("ready"),t.data=window.searchData,t.index=me.Index.load(window.searchData.index))}function He(t,e,n,r){if(Ae(r,t),!r.index||!r.data)return;e.textContent="";let i=n.value.trim(),s=i?r.index.search(`*${i}*`):[];for(let o=0;oa.score-o.score);for(let o=0,a=Math.min(10,s.length);o${fe(u.parent,i)}.${l}`);let h=document.createElement("li");h.classList.value=u.classes??"";let m=document.createElement("a");m.href=r.base+u.url,m.innerHTML=l,h.append(m),e.appendChild(h)}}function pe(t,e){let n=t.querySelector(".current");if(!n)n=t.querySelector(e==1?"li:first-child":"li:last-child"),n&&n.classList.add("current");else{let r=n;if(e===1)do r=r.nextElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);else do r=r.previousElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);r&&(n.classList.remove("current"),r.classList.add("current"))}}function Ve(t,e){let n=t.querySelector(".current");if(n||(n=t.querySelector("li:first-child")),n){let r=n.querySelector("a");r&&(window.location.href=r.href),e.blur()}}function fe(t,e){if(e==="")return t;let n=t.toLocaleLowerCase(),r=e.toLocaleLowerCase(),i=[],s=0,o=n.indexOf(r);for(;o!=-1;)i.push(ie(t.substring(s,o)),`${ie(t.substring(o,o+r.length))}`),s=o+r.length,o=n.indexOf(r,s);return i.push(ie(t.substring(s))),i.join("")}var Ne={"&":"&","<":"<",">":">","'":"'",'"':"""};function ie(t){return t.replace(/[&<>"'"]/g,e=>Ne[e])}var F="mousedown",ye="mousemove",j="mouseup",Z={x:0,y:0},ge=!1,se=!1,Be=!1,A=!1,xe=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(xe?"is-mobile":"not-mobile");xe&&"ontouchstart"in document.documentElement&&(Be=!0,F="touchstart",ye="touchmove",j="touchend");document.addEventListener(F,t=>{se=!0,A=!1;let e=F=="touchstart"?t.targetTouches[0]:t;Z.y=e.pageY||0,Z.x=e.pageX||0});document.addEventListener(ye,t=>{if(se&&!A){let e=F=="touchstart"?t.targetTouches[0]:t,n=Z.x-(e.pageX||0),r=Z.y-(e.pageY||0);A=Math.sqrt(n*n+r*r)>10}});document.addEventListener(j,()=>{se=!1});document.addEventListener("click",t=>{ge&&(t.preventDefault(),t.stopImmediatePropagation(),ge=!1)});var K=class extends I{constructor(n){super(n);this.className=this.el.dataset.toggle||"",this.el.addEventListener(j,r=>this.onPointerUp(r)),this.el.addEventListener("click",r=>r.preventDefault()),document.addEventListener(F,r=>this.onDocumentPointerDown(r)),document.addEventListener(j,r=>this.onDocumentPointerUp(r))}setActive(n){if(this.active==n)return;this.active=n,document.documentElement.classList.toggle("has-"+this.className,n),this.el.classList.toggle("active",n);let r=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(r),setTimeout(()=>document.documentElement.classList.remove(r),500)}onPointerUp(n){A||(this.setActive(!0),n.preventDefault())}onDocumentPointerDown(n){if(this.active){if(n.target.closest(".col-menu, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(n){if(!A&&this.active&&n.target.closest(".col-menu")){let r=n.target.closest("a");if(r){let i=window.location.href;i.indexOf("#")!=-1&&(i=i.substring(0,i.indexOf("#"))),r.href.substring(0,i.length)==i&&setTimeout(()=>this.setActive(!1),250)}}}};var oe;try{oe=localStorage}catch{oe={getItem(){return null},setItem(){}}}var Q=oe;var Le=document.head.appendChild(document.createElement("style"));Le.dataset.for="filters";var ee=class extends I{constructor(n){super(n);this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),Le.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } +`}fromLocalStorage(){let n=Q.getItem(this.key);return n?n==="true":this.el.checked}setLocalStorage(n){Q.setItem(this.key,n.toString()),this.value=n,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),this.app.filterChanged(),document.querySelectorAll(".tsd-index-section").forEach(n=>{n.style.display="block";let r=Array.from(n.querySelectorAll(".tsd-index-link")).every(i=>i.offsetParent==null);n.style.display=r?"none":"block"})}};var te=class extends I{constructor(n){super(n);this.calculateHeights(),this.summary=this.el.querySelector(".tsd-accordion-summary"),this.icon=this.summary.querySelector("svg"),this.key=`tsd-accordion-${this.summary.textContent.replace(/\s+/g,"-").toLowerCase()}`,this.setLocalStorage(this.fromLocalStorage(),!0),this.summary.addEventListener("click",r=>this.toggleVisibility(r)),this.icon.style.transform=this.getIconRotation()}getIconRotation(n=this.el.open){return`rotate(${n?0:-90}deg)`}calculateHeights(){let n=this.el.open,{position:r,left:i}=this.el.style;this.el.style.position="fixed",this.el.style.left="-9999px",this.el.open=!0,this.expandedHeight=this.el.offsetHeight+"px",this.el.open=!1,this.collapsedHeight=this.el.offsetHeight+"px",this.el.open=n,this.el.style.height=n?this.expandedHeight:this.collapsedHeight,this.el.style.position=r,this.el.style.left=i}toggleVisibility(n){n.preventDefault(),this.el.style.overflow="hidden",this.el.open?this.collapse():this.expand()}expand(n=!0){this.el.open=!0,this.animate(this.collapsedHeight,this.expandedHeight,{opening:!0,duration:n?300:0})}collapse(n=!0){this.animate(this.expandedHeight,this.collapsedHeight,{opening:!1,duration:n?300:0})}animate(n,r,{opening:i,duration:s=300}){if(this.animation)return;let o={duration:s,easing:"ease"};this.animation=this.el.animate({height:[n,r]},o),this.icon.animate({transform:[this.icon.style.transform||this.getIconRotation(!i),this.getIconRotation(i)]},o).addEventListener("finish",()=>{this.icon.style.transform=this.getIconRotation(i)}),this.animation.addEventListener("finish",()=>this.animationEnd(i))}animationEnd(n){this.el.open=n,this.animation=void 0,this.el.style.height="auto",this.el.style.overflow="visible",this.setLocalStorage(n)}fromLocalStorage(){let n=Q.getItem(this.key);return n?n==="true":this.el.open}setLocalStorage(n,r=!1){this.fromLocalStorage()===n&&!r||(Q.setItem(this.key,n.toString()),this.el.open=n,this.handleValueChange(r))}handleValueChange(n=!1){this.fromLocalStorage()===this.el.open&&!n||(this.fromLocalStorage()?this.expand(!1):this.collapse(!1))}};function be(t){let e=Q.getItem("tsd-theme")||"os";t.value=e,Ee(e),t.addEventListener("change",()=>{Q.setItem("tsd-theme",t.value),Ee(t.value)})}function Ee(t){document.documentElement.dataset.theme=t}ve();B(X,".menu-highlight");B(K,"a[data-toggle]");B(te,".tsd-index-accordion");B(ee,".tsd-filter-item input[type=checkbox]");var we=document.getElementById("theme");we&&be(we);var je=new Y;Object.defineProperty(window,"app",{value:je});})(); +/*! Bundled license information: + +lunr/lunr.js: + (** + * lunr - http://lunrjs.com - A bit like Solr, but much smaller and not as bright - 2.3.9 + * Copyright (C) 2020 Oliver Nightingale + * @license MIT + *) + (*! + * lunr.utils + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Set + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.tokenizer + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Pipeline + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Vector + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.stemmer + * Copyright (C) 2020 Oliver Nightingale + * Includes code from - http://tartarus.org/~martin/PorterStemmer/js.txt + *) + (*! + * lunr.stopWordFilter + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.trimmer + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.TokenSet + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Index + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Builder + * Copyright (C) 2020 Oliver Nightingale + *) +*/ diff --git a/8.8.0/assets/search.js b/8.8.0/assets/search.js new file mode 100644 index 000000000..4b76e96a4 --- /dev/null +++ b/8.8.0/assets/search.js @@ -0,0 +1 @@ +window.searchData = JSON.parse("{\"kinds\":{\"2\":\"Module\",\"8\":\"Enumeration\",\"16\":\"Enumeration Member\",\"64\":\"Function\",\"128\":\"Class\",\"256\":\"Interface\",\"512\":\"Constructor\",\"1024\":\"Property\",\"2048\":\"Method\",\"65536\":\"Type literal\",\"262144\":\"Accessor\",\"4194304\":\"Type alias\",\"8388608\":\"Reference\"},\"rows\":[{\"kind\":2,\"name\":\"analyzer\",\"url\":\"modules/analyzer.html\",\"classes\":\"tsd-kind-module\"},{\"kind\":64,\"name\":\"isArangoAnalyzer\",\"url\":\"functions/analyzer.isArangoAnalyzer.html\",\"classes\":\"tsd-kind-function tsd-parent-kind-module\",\"parent\":\"analyzer\"},{\"kind\":4194304,\"name\":\"AnalyzerFeature\",\"url\":\"types/analyzer.AnalyzerFeature.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"analyzer\"},{\"kind\":4194304,\"name\":\"CreateAnalyzerOptions\",\"url\":\"types/analyzer.CreateAnalyzerOptions.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"analyzer\"},{\"kind\":4194304,\"name\":\"CreateIdentityAnalyzerOptions\",\"url\":\"types/analyzer.CreateIdentityAnalyzerOptions.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"analyzer\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/analyzer.CreateIdentityAnalyzerOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"analyzer.CreateIdentityAnalyzerOptions\"},{\"kind\":1024,\"name\":\"type\",\"url\":\"types/analyzer.CreateIdentityAnalyzerOptions.html#__type.type\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateIdentityAnalyzerOptions.__type\"},{\"kind\":1024,\"name\":\"features\",\"url\":\"types/analyzer.CreateIdentityAnalyzerOptions.html#__type.features\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateIdentityAnalyzerOptions.__type\"},{\"kind\":1024,\"name\":\"properties\",\"url\":\"types/analyzer.CreateIdentityAnalyzerOptions.html#__type.properties\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateIdentityAnalyzerOptions.__type\"},{\"kind\":4194304,\"name\":\"CreateDelimiterAnalyzerOptions\",\"url\":\"types/analyzer.CreateDelimiterAnalyzerOptions.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"analyzer\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/analyzer.CreateDelimiterAnalyzerOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"analyzer.CreateDelimiterAnalyzerOptions\"},{\"kind\":1024,\"name\":\"type\",\"url\":\"types/analyzer.CreateDelimiterAnalyzerOptions.html#__type.type\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateDelimiterAnalyzerOptions.__type\"},{\"kind\":1024,\"name\":\"features\",\"url\":\"types/analyzer.CreateDelimiterAnalyzerOptions.html#__type.features\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateDelimiterAnalyzerOptions.__type\"},{\"kind\":1024,\"name\":\"properties\",\"url\":\"types/analyzer.CreateDelimiterAnalyzerOptions.html#__type.properties\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateDelimiterAnalyzerOptions.__type\"},{\"kind\":4194304,\"name\":\"CreateMultiDelimiterAnalyzerOptions\",\"url\":\"types/analyzer.CreateMultiDelimiterAnalyzerOptions.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"analyzer\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/analyzer.CreateMultiDelimiterAnalyzerOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"analyzer.CreateMultiDelimiterAnalyzerOptions\"},{\"kind\":1024,\"name\":\"type\",\"url\":\"types/analyzer.CreateMultiDelimiterAnalyzerOptions.html#__type.type\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateMultiDelimiterAnalyzerOptions.__type\"},{\"kind\":1024,\"name\":\"features\",\"url\":\"types/analyzer.CreateMultiDelimiterAnalyzerOptions.html#__type.features\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateMultiDelimiterAnalyzerOptions.__type\"},{\"kind\":1024,\"name\":\"properties\",\"url\":\"types/analyzer.CreateMultiDelimiterAnalyzerOptions.html#__type.properties\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateMultiDelimiterAnalyzerOptions.__type\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/analyzer.CreateMultiDelimiterAnalyzerOptions.html#__type.properties.__type-1\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-property\",\"parent\":\"analyzer.CreateMultiDelimiterAnalyzerOptions.__type.properties\"},{\"kind\":1024,\"name\":\"delimiters\",\"url\":\"types/analyzer.CreateMultiDelimiterAnalyzerOptions.html#__type.properties.__type-1.delimiters\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateMultiDelimiterAnalyzerOptions.__type.properties.__type\"},{\"kind\":4194304,\"name\":\"CreateStemAnalyzerOptions\",\"url\":\"types/analyzer.CreateStemAnalyzerOptions.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"analyzer\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/analyzer.CreateStemAnalyzerOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"analyzer.CreateStemAnalyzerOptions\"},{\"kind\":1024,\"name\":\"type\",\"url\":\"types/analyzer.CreateStemAnalyzerOptions.html#__type.type\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateStemAnalyzerOptions.__type\"},{\"kind\":1024,\"name\":\"features\",\"url\":\"types/analyzer.CreateStemAnalyzerOptions.html#__type.features\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateStemAnalyzerOptions.__type\"},{\"kind\":1024,\"name\":\"properties\",\"url\":\"types/analyzer.CreateStemAnalyzerOptions.html#__type.properties\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateStemAnalyzerOptions.__type\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/analyzer.CreateStemAnalyzerOptions.html#__type.properties.__type-1\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-property\",\"parent\":\"analyzer.CreateStemAnalyzerOptions.__type.properties\"},{\"kind\":1024,\"name\":\"locale\",\"url\":\"types/analyzer.CreateStemAnalyzerOptions.html#__type.properties.__type-1.locale\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateStemAnalyzerOptions.__type.properties.__type\"},{\"kind\":4194304,\"name\":\"CreateNormAnalyzerOptions\",\"url\":\"types/analyzer.CreateNormAnalyzerOptions.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"analyzer\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/analyzer.CreateNormAnalyzerOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"analyzer.CreateNormAnalyzerOptions\"},{\"kind\":1024,\"name\":\"type\",\"url\":\"types/analyzer.CreateNormAnalyzerOptions.html#__type.type\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateNormAnalyzerOptions.__type\"},{\"kind\":1024,\"name\":\"features\",\"url\":\"types/analyzer.CreateNormAnalyzerOptions.html#__type.features\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateNormAnalyzerOptions.__type\"},{\"kind\":1024,\"name\":\"properties\",\"url\":\"types/analyzer.CreateNormAnalyzerOptions.html#__type.properties\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateNormAnalyzerOptions.__type\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/analyzer.CreateNormAnalyzerOptions.html#__type.properties.__type-1\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-property\",\"parent\":\"analyzer.CreateNormAnalyzerOptions.__type.properties\"},{\"kind\":1024,\"name\":\"locale\",\"url\":\"types/analyzer.CreateNormAnalyzerOptions.html#__type.properties.__type-1.locale\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateNormAnalyzerOptions.__type.properties.__type\"},{\"kind\":1024,\"name\":\"case\",\"url\":\"types/analyzer.CreateNormAnalyzerOptions.html#__type.properties.__type-1.case\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateNormAnalyzerOptions.__type.properties.__type\"},{\"kind\":1024,\"name\":\"accent\",\"url\":\"types/analyzer.CreateNormAnalyzerOptions.html#__type.properties.__type-1.accent\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateNormAnalyzerOptions.__type.properties.__type\"},{\"kind\":4194304,\"name\":\"CreateNgramAnalyzerOptions\",\"url\":\"types/analyzer.CreateNgramAnalyzerOptions.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"analyzer\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/analyzer.CreateNgramAnalyzerOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"analyzer.CreateNgramAnalyzerOptions\"},{\"kind\":1024,\"name\":\"type\",\"url\":\"types/analyzer.CreateNgramAnalyzerOptions.html#__type.type\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateNgramAnalyzerOptions.__type\"},{\"kind\":1024,\"name\":\"features\",\"url\":\"types/analyzer.CreateNgramAnalyzerOptions.html#__type.features\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateNgramAnalyzerOptions.__type\"},{\"kind\":1024,\"name\":\"properties\",\"url\":\"types/analyzer.CreateNgramAnalyzerOptions.html#__type.properties\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateNgramAnalyzerOptions.__type\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/analyzer.CreateNgramAnalyzerOptions.html#__type.properties.__type-1\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-property\",\"parent\":\"analyzer.CreateNgramAnalyzerOptions.__type.properties\"},{\"kind\":1024,\"name\":\"max\",\"url\":\"types/analyzer.CreateNgramAnalyzerOptions.html#__type.properties.__type-1.max\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateNgramAnalyzerOptions.__type.properties.__type\"},{\"kind\":1024,\"name\":\"min\",\"url\":\"types/analyzer.CreateNgramAnalyzerOptions.html#__type.properties.__type-1.min\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateNgramAnalyzerOptions.__type.properties.__type\"},{\"kind\":1024,\"name\":\"preserveOriginal\",\"url\":\"types/analyzer.CreateNgramAnalyzerOptions.html#__type.properties.__type-1.preserveOriginal\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateNgramAnalyzerOptions.__type.properties.__type\"},{\"kind\":4194304,\"name\":\"CreateTextAnalyzerOptions\",\"url\":\"types/analyzer.CreateTextAnalyzerOptions.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"analyzer\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/analyzer.CreateTextAnalyzerOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"analyzer.CreateTextAnalyzerOptions\"},{\"kind\":1024,\"name\":\"type\",\"url\":\"types/analyzer.CreateTextAnalyzerOptions.html#__type.type\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateTextAnalyzerOptions.__type\"},{\"kind\":1024,\"name\":\"features\",\"url\":\"types/analyzer.CreateTextAnalyzerOptions.html#__type.features\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateTextAnalyzerOptions.__type\"},{\"kind\":1024,\"name\":\"properties\",\"url\":\"types/analyzer.CreateTextAnalyzerOptions.html#__type.properties\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateTextAnalyzerOptions.__type\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/analyzer.CreateTextAnalyzerOptions.html#__type.properties.__type-1\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-property\",\"parent\":\"analyzer.CreateTextAnalyzerOptions.__type.properties\"},{\"kind\":1024,\"name\":\"locale\",\"url\":\"types/analyzer.CreateTextAnalyzerOptions.html#__type.properties.__type-1.locale\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateTextAnalyzerOptions.__type.properties.__type\"},{\"kind\":1024,\"name\":\"case\",\"url\":\"types/analyzer.CreateTextAnalyzerOptions.html#__type.properties.__type-1.case\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateTextAnalyzerOptions.__type.properties.__type\"},{\"kind\":1024,\"name\":\"stopwords\",\"url\":\"types/analyzer.CreateTextAnalyzerOptions.html#__type.properties.__type-1.stopwords\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateTextAnalyzerOptions.__type.properties.__type\"},{\"kind\":1024,\"name\":\"stopwordsPath\",\"url\":\"types/analyzer.CreateTextAnalyzerOptions.html#__type.properties.__type-1.stopwordsPath\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateTextAnalyzerOptions.__type.properties.__type\"},{\"kind\":1024,\"name\":\"accent\",\"url\":\"types/analyzer.CreateTextAnalyzerOptions.html#__type.properties.__type-1.accent\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateTextAnalyzerOptions.__type.properties.__type\"},{\"kind\":1024,\"name\":\"stemming\",\"url\":\"types/analyzer.CreateTextAnalyzerOptions.html#__type.properties.__type-1.stemming\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateTextAnalyzerOptions.__type.properties.__type\"},{\"kind\":1024,\"name\":\"edgeNgram\",\"url\":\"types/analyzer.CreateTextAnalyzerOptions.html#__type.properties.__type-1.edgeNgram\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateTextAnalyzerOptions.__type.properties.__type\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/analyzer.CreateTextAnalyzerOptions.html#__type.properties.__type-1.edgeNgram.__type-2\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-property\",\"parent\":\"analyzer.CreateTextAnalyzerOptions.__type.properties.__type.edgeNgram\"},{\"kind\":1024,\"name\":\"min\",\"url\":\"types/analyzer.CreateTextAnalyzerOptions.html#__type.properties.__type-1.edgeNgram.__type-2.min\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateTextAnalyzerOptions.__type.properties.__type.edgeNgram.__type\"},{\"kind\":1024,\"name\":\"max\",\"url\":\"types/analyzer.CreateTextAnalyzerOptions.html#__type.properties.__type-1.edgeNgram.__type-2.max\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateTextAnalyzerOptions.__type.properties.__type.edgeNgram.__type\"},{\"kind\":1024,\"name\":\"preserveOriginal\",\"url\":\"types/analyzer.CreateTextAnalyzerOptions.html#__type.properties.__type-1.edgeNgram.__type-2.preserveOriginal\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateTextAnalyzerOptions.__type.properties.__type.edgeNgram.__type\"},{\"kind\":4194304,\"name\":\"CreateSegmentationAnalyzerOptions\",\"url\":\"types/analyzer.CreateSegmentationAnalyzerOptions.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"analyzer\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/analyzer.CreateSegmentationAnalyzerOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"analyzer.CreateSegmentationAnalyzerOptions\"},{\"kind\":1024,\"name\":\"type\",\"url\":\"types/analyzer.CreateSegmentationAnalyzerOptions.html#__type.type\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateSegmentationAnalyzerOptions.__type\"},{\"kind\":1024,\"name\":\"features\",\"url\":\"types/analyzer.CreateSegmentationAnalyzerOptions.html#__type.features\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateSegmentationAnalyzerOptions.__type\"},{\"kind\":1024,\"name\":\"properties\",\"url\":\"types/analyzer.CreateSegmentationAnalyzerOptions.html#__type.properties\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateSegmentationAnalyzerOptions.__type\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/analyzer.CreateSegmentationAnalyzerOptions.html#__type.properties.__type-1\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-property\",\"parent\":\"analyzer.CreateSegmentationAnalyzerOptions.__type.properties\"},{\"kind\":1024,\"name\":\"break\",\"url\":\"types/analyzer.CreateSegmentationAnalyzerOptions.html#__type.properties.__type-1.break\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateSegmentationAnalyzerOptions.__type.properties.__type\"},{\"kind\":1024,\"name\":\"case\",\"url\":\"types/analyzer.CreateSegmentationAnalyzerOptions.html#__type.properties.__type-1.case\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateSegmentationAnalyzerOptions.__type.properties.__type\"},{\"kind\":4194304,\"name\":\"CreateAqlAnalyzerOptions\",\"url\":\"types/analyzer.CreateAqlAnalyzerOptions.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"analyzer\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/analyzer.CreateAqlAnalyzerOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"analyzer.CreateAqlAnalyzerOptions\"},{\"kind\":1024,\"name\":\"type\",\"url\":\"types/analyzer.CreateAqlAnalyzerOptions.html#__type.type\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateAqlAnalyzerOptions.__type\"},{\"kind\":1024,\"name\":\"features\",\"url\":\"types/analyzer.CreateAqlAnalyzerOptions.html#__type.features\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateAqlAnalyzerOptions.__type\"},{\"kind\":1024,\"name\":\"properties\",\"url\":\"types/analyzer.CreateAqlAnalyzerOptions.html#__type.properties\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateAqlAnalyzerOptions.__type\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/analyzer.CreateAqlAnalyzerOptions.html#__type.properties.__type-1\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-property\",\"parent\":\"analyzer.CreateAqlAnalyzerOptions.__type.properties\"},{\"kind\":1024,\"name\":\"queryString\",\"url\":\"types/analyzer.CreateAqlAnalyzerOptions.html#__type.properties.__type-1.queryString\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateAqlAnalyzerOptions.__type.properties.__type\"},{\"kind\":1024,\"name\":\"collapsePositions\",\"url\":\"types/analyzer.CreateAqlAnalyzerOptions.html#__type.properties.__type-1.collapsePositions\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateAqlAnalyzerOptions.__type.properties.__type\"},{\"kind\":1024,\"name\":\"keepNull\",\"url\":\"types/analyzer.CreateAqlAnalyzerOptions.html#__type.properties.__type-1.keepNull\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateAqlAnalyzerOptions.__type.properties.__type\"},{\"kind\":1024,\"name\":\"batchSize\",\"url\":\"types/analyzer.CreateAqlAnalyzerOptions.html#__type.properties.__type-1.batchSize\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateAqlAnalyzerOptions.__type.properties.__type\"},{\"kind\":1024,\"name\":\"memoryLimit\",\"url\":\"types/analyzer.CreateAqlAnalyzerOptions.html#__type.properties.__type-1.memoryLimit\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateAqlAnalyzerOptions.__type.properties.__type\"},{\"kind\":1024,\"name\":\"returnType\",\"url\":\"types/analyzer.CreateAqlAnalyzerOptions.html#__type.properties.__type-1.returnType\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateAqlAnalyzerOptions.__type.properties.__type\"},{\"kind\":4194304,\"name\":\"CreatePipelineAnalyzerOptions\",\"url\":\"types/analyzer.CreatePipelineAnalyzerOptions.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"analyzer\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/analyzer.CreatePipelineAnalyzerOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"analyzer.CreatePipelineAnalyzerOptions\"},{\"kind\":1024,\"name\":\"type\",\"url\":\"types/analyzer.CreatePipelineAnalyzerOptions.html#__type.type\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreatePipelineAnalyzerOptions.__type\"},{\"kind\":1024,\"name\":\"features\",\"url\":\"types/analyzer.CreatePipelineAnalyzerOptions.html#__type.features\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreatePipelineAnalyzerOptions.__type\"},{\"kind\":1024,\"name\":\"properties\",\"url\":\"types/analyzer.CreatePipelineAnalyzerOptions.html#__type.properties\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreatePipelineAnalyzerOptions.__type\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/analyzer.CreatePipelineAnalyzerOptions.html#__type.properties.__type-1\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-property\",\"parent\":\"analyzer.CreatePipelineAnalyzerOptions.__type.properties\"},{\"kind\":1024,\"name\":\"pipeline\",\"url\":\"types/analyzer.CreatePipelineAnalyzerOptions.html#__type.properties.__type-1.pipeline\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreatePipelineAnalyzerOptions.__type.properties.__type\"},{\"kind\":4194304,\"name\":\"CreateStopwordsAnalyzerOptions\",\"url\":\"types/analyzer.CreateStopwordsAnalyzerOptions.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"analyzer\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/analyzer.CreateStopwordsAnalyzerOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"analyzer.CreateStopwordsAnalyzerOptions\"},{\"kind\":1024,\"name\":\"type\",\"url\":\"types/analyzer.CreateStopwordsAnalyzerOptions.html#__type.type\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateStopwordsAnalyzerOptions.__type\"},{\"kind\":1024,\"name\":\"features\",\"url\":\"types/analyzer.CreateStopwordsAnalyzerOptions.html#__type.features\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateStopwordsAnalyzerOptions.__type\"},{\"kind\":1024,\"name\":\"properties\",\"url\":\"types/analyzer.CreateStopwordsAnalyzerOptions.html#__type.properties\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateStopwordsAnalyzerOptions.__type\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/analyzer.CreateStopwordsAnalyzerOptions.html#__type.properties.__type-1\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-property\",\"parent\":\"analyzer.CreateStopwordsAnalyzerOptions.__type.properties\"},{\"kind\":1024,\"name\":\"stopwords\",\"url\":\"types/analyzer.CreateStopwordsAnalyzerOptions.html#__type.properties.__type-1.stopwords\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateStopwordsAnalyzerOptions.__type.properties.__type\"},{\"kind\":1024,\"name\":\"hex\",\"url\":\"types/analyzer.CreateStopwordsAnalyzerOptions.html#__type.properties.__type-1.hex\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateStopwordsAnalyzerOptions.__type.properties.__type\"},{\"kind\":4194304,\"name\":\"CreateCollationAnalyzerOptions\",\"url\":\"types/analyzer.CreateCollationAnalyzerOptions.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"analyzer\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/analyzer.CreateCollationAnalyzerOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"analyzer.CreateCollationAnalyzerOptions\"},{\"kind\":1024,\"name\":\"type\",\"url\":\"types/analyzer.CreateCollationAnalyzerOptions.html#__type.type\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateCollationAnalyzerOptions.__type\"},{\"kind\":1024,\"name\":\"features\",\"url\":\"types/analyzer.CreateCollationAnalyzerOptions.html#__type.features\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateCollationAnalyzerOptions.__type\"},{\"kind\":1024,\"name\":\"properties\",\"url\":\"types/analyzer.CreateCollationAnalyzerOptions.html#__type.properties\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateCollationAnalyzerOptions.__type\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/analyzer.CreateCollationAnalyzerOptions.html#__type.properties.__type-1\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-property\",\"parent\":\"analyzer.CreateCollationAnalyzerOptions.__type.properties\"},{\"kind\":1024,\"name\":\"locale\",\"url\":\"types/analyzer.CreateCollationAnalyzerOptions.html#__type.properties.__type-1.locale\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateCollationAnalyzerOptions.__type.properties.__type\"},{\"kind\":4194304,\"name\":\"CreateMinHashAnalyzerOptions\",\"url\":\"types/analyzer.CreateMinHashAnalyzerOptions.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"analyzer\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/analyzer.CreateMinHashAnalyzerOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"analyzer.CreateMinHashAnalyzerOptions\"},{\"kind\":1024,\"name\":\"type\",\"url\":\"types/analyzer.CreateMinHashAnalyzerOptions.html#__type.type\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateMinHashAnalyzerOptions.__type\"},{\"kind\":1024,\"name\":\"features\",\"url\":\"types/analyzer.CreateMinHashAnalyzerOptions.html#__type.features\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateMinHashAnalyzerOptions.__type\"},{\"kind\":1024,\"name\":\"properties\",\"url\":\"types/analyzer.CreateMinHashAnalyzerOptions.html#__type.properties\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateMinHashAnalyzerOptions.__type\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/analyzer.CreateMinHashAnalyzerOptions.html#__type.properties.__type-1\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-property\",\"parent\":\"analyzer.CreateMinHashAnalyzerOptions.__type.properties\"},{\"kind\":1024,\"name\":\"analyzer\",\"url\":\"types/analyzer.CreateMinHashAnalyzerOptions.html#__type.properties.__type-1.analyzer\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateMinHashAnalyzerOptions.__type.properties.__type\"},{\"kind\":1024,\"name\":\"numHashes\",\"url\":\"types/analyzer.CreateMinHashAnalyzerOptions.html#__type.properties.__type-1.numHashes\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateMinHashAnalyzerOptions.__type.properties.__type\"},{\"kind\":4194304,\"name\":\"CreateClassificationAnalyzerOptions\",\"url\":\"types/analyzer.CreateClassificationAnalyzerOptions.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"analyzer\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/analyzer.CreateClassificationAnalyzerOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"analyzer.CreateClassificationAnalyzerOptions\"},{\"kind\":1024,\"name\":\"type\",\"url\":\"types/analyzer.CreateClassificationAnalyzerOptions.html#__type.type\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateClassificationAnalyzerOptions.__type\"},{\"kind\":1024,\"name\":\"features\",\"url\":\"types/analyzer.CreateClassificationAnalyzerOptions.html#__type.features\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateClassificationAnalyzerOptions.__type\"},{\"kind\":1024,\"name\":\"properties\",\"url\":\"types/analyzer.CreateClassificationAnalyzerOptions.html#__type.properties\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateClassificationAnalyzerOptions.__type\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/analyzer.CreateClassificationAnalyzerOptions.html#__type.properties.__type-1\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-property\",\"parent\":\"analyzer.CreateClassificationAnalyzerOptions.__type.properties\"},{\"kind\":1024,\"name\":\"model_location\",\"url\":\"types/analyzer.CreateClassificationAnalyzerOptions.html#__type.properties.__type-1.model_location\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateClassificationAnalyzerOptions.__type.properties.__type\"},{\"kind\":1024,\"name\":\"top_k\",\"url\":\"types/analyzer.CreateClassificationAnalyzerOptions.html#__type.properties.__type-1.top_k\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateClassificationAnalyzerOptions.__type.properties.__type\"},{\"kind\":1024,\"name\":\"threshold\",\"url\":\"types/analyzer.CreateClassificationAnalyzerOptions.html#__type.properties.__type-1.threshold\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateClassificationAnalyzerOptions.__type.properties.__type\"},{\"kind\":4194304,\"name\":\"CreateNearestNeighborsAnalyzerOptions\",\"url\":\"types/analyzer.CreateNearestNeighborsAnalyzerOptions.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"analyzer\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/analyzer.CreateNearestNeighborsAnalyzerOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"analyzer.CreateNearestNeighborsAnalyzerOptions\"},{\"kind\":1024,\"name\":\"type\",\"url\":\"types/analyzer.CreateNearestNeighborsAnalyzerOptions.html#__type.type\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateNearestNeighborsAnalyzerOptions.__type\"},{\"kind\":1024,\"name\":\"features\",\"url\":\"types/analyzer.CreateNearestNeighborsAnalyzerOptions.html#__type.features\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateNearestNeighborsAnalyzerOptions.__type\"},{\"kind\":1024,\"name\":\"properties\",\"url\":\"types/analyzer.CreateNearestNeighborsAnalyzerOptions.html#__type.properties\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateNearestNeighborsAnalyzerOptions.__type\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/analyzer.CreateNearestNeighborsAnalyzerOptions.html#__type.properties.__type-1\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-property\",\"parent\":\"analyzer.CreateNearestNeighborsAnalyzerOptions.__type.properties\"},{\"kind\":1024,\"name\":\"model_location\",\"url\":\"types/analyzer.CreateNearestNeighborsAnalyzerOptions.html#__type.properties.__type-1.model_location\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateNearestNeighborsAnalyzerOptions.__type.properties.__type\"},{\"kind\":1024,\"name\":\"top_k\",\"url\":\"types/analyzer.CreateNearestNeighborsAnalyzerOptions.html#__type.properties.__type-1.top_k\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateNearestNeighborsAnalyzerOptions.__type.properties.__type\"},{\"kind\":4194304,\"name\":\"CreateWildcardAnalyzerOptions\",\"url\":\"types/analyzer.CreateWildcardAnalyzerOptions.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"analyzer\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/analyzer.CreateWildcardAnalyzerOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"analyzer.CreateWildcardAnalyzerOptions\"},{\"kind\":1024,\"name\":\"type\",\"url\":\"types/analyzer.CreateWildcardAnalyzerOptions.html#__type.type\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateWildcardAnalyzerOptions.__type\"},{\"kind\":1024,\"name\":\"features\",\"url\":\"types/analyzer.CreateWildcardAnalyzerOptions.html#__type.features\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateWildcardAnalyzerOptions.__type\"},{\"kind\":1024,\"name\":\"properties\",\"url\":\"types/analyzer.CreateWildcardAnalyzerOptions.html#__type.properties\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateWildcardAnalyzerOptions.__type\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/analyzer.CreateWildcardAnalyzerOptions.html#__type.properties.__type-1\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-property\",\"parent\":\"analyzer.CreateWildcardAnalyzerOptions.__type.properties\"},{\"kind\":1024,\"name\":\"ngramSize\",\"url\":\"types/analyzer.CreateWildcardAnalyzerOptions.html#__type.properties.__type-1.ngramSize\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateWildcardAnalyzerOptions.__type.properties.__type\"},{\"kind\":1024,\"name\":\"analyzer\",\"url\":\"types/analyzer.CreateWildcardAnalyzerOptions.html#__type.properties.__type-1.analyzer\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateWildcardAnalyzerOptions.__type.properties.__type\"},{\"kind\":4194304,\"name\":\"CreateGeoJsonAnalyzerOptions\",\"url\":\"types/analyzer.CreateGeoJsonAnalyzerOptions.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"analyzer\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/analyzer.CreateGeoJsonAnalyzerOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"analyzer.CreateGeoJsonAnalyzerOptions\"},{\"kind\":1024,\"name\":\"type\",\"url\":\"types/analyzer.CreateGeoJsonAnalyzerOptions.html#__type.type-1\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateGeoJsonAnalyzerOptions.__type\"},{\"kind\":1024,\"name\":\"features\",\"url\":\"types/analyzer.CreateGeoJsonAnalyzerOptions.html#__type.features\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateGeoJsonAnalyzerOptions.__type\"},{\"kind\":1024,\"name\":\"properties\",\"url\":\"types/analyzer.CreateGeoJsonAnalyzerOptions.html#__type.properties\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateGeoJsonAnalyzerOptions.__type\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/analyzer.CreateGeoJsonAnalyzerOptions.html#__type.properties.__type-1\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-property\",\"parent\":\"analyzer.CreateGeoJsonAnalyzerOptions.__type.properties\"},{\"kind\":1024,\"name\":\"type\",\"url\":\"types/analyzer.CreateGeoJsonAnalyzerOptions.html#__type.properties.__type-1.type\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateGeoJsonAnalyzerOptions.__type.properties.__type\"},{\"kind\":1024,\"name\":\"options\",\"url\":\"types/analyzer.CreateGeoJsonAnalyzerOptions.html#__type.properties.__type-1.options\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateGeoJsonAnalyzerOptions.__type.properties.__type\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/analyzer.CreateGeoJsonAnalyzerOptions.html#__type.properties.__type-1.options.__type-2\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-property\",\"parent\":\"analyzer.CreateGeoJsonAnalyzerOptions.__type.properties.__type.options\"},{\"kind\":1024,\"name\":\"maxCells\",\"url\":\"types/analyzer.CreateGeoJsonAnalyzerOptions.html#__type.properties.__type-1.options.__type-2.maxCells\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateGeoJsonAnalyzerOptions.__type.properties.__type.options.__type\"},{\"kind\":1024,\"name\":\"minLevel\",\"url\":\"types/analyzer.CreateGeoJsonAnalyzerOptions.html#__type.properties.__type-1.options.__type-2.minLevel\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateGeoJsonAnalyzerOptions.__type.properties.__type.options.__type\"},{\"kind\":1024,\"name\":\"maxLevel\",\"url\":\"types/analyzer.CreateGeoJsonAnalyzerOptions.html#__type.properties.__type-1.options.__type-2.maxLevel\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateGeoJsonAnalyzerOptions.__type.properties.__type.options.__type\"},{\"kind\":4194304,\"name\":\"CreateGeoPointAnalyzerOptions\",\"url\":\"types/analyzer.CreateGeoPointAnalyzerOptions.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"analyzer\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/analyzer.CreateGeoPointAnalyzerOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"analyzer.CreateGeoPointAnalyzerOptions\"},{\"kind\":1024,\"name\":\"type\",\"url\":\"types/analyzer.CreateGeoPointAnalyzerOptions.html#__type.type\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateGeoPointAnalyzerOptions.__type\"},{\"kind\":1024,\"name\":\"features\",\"url\":\"types/analyzer.CreateGeoPointAnalyzerOptions.html#__type.features\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateGeoPointAnalyzerOptions.__type\"},{\"kind\":1024,\"name\":\"properties\",\"url\":\"types/analyzer.CreateGeoPointAnalyzerOptions.html#__type.properties\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateGeoPointAnalyzerOptions.__type\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/analyzer.CreateGeoPointAnalyzerOptions.html#__type.properties.__type-1\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-property\",\"parent\":\"analyzer.CreateGeoPointAnalyzerOptions.__type.properties\"},{\"kind\":1024,\"name\":\"latitude\",\"url\":\"types/analyzer.CreateGeoPointAnalyzerOptions.html#__type.properties.__type-1.latitude\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateGeoPointAnalyzerOptions.__type.properties.__type\"},{\"kind\":1024,\"name\":\"longitude\",\"url\":\"types/analyzer.CreateGeoPointAnalyzerOptions.html#__type.properties.__type-1.longitude\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateGeoPointAnalyzerOptions.__type.properties.__type\"},{\"kind\":1024,\"name\":\"options\",\"url\":\"types/analyzer.CreateGeoPointAnalyzerOptions.html#__type.properties.__type-1.options\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateGeoPointAnalyzerOptions.__type.properties.__type\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/analyzer.CreateGeoPointAnalyzerOptions.html#__type.properties.__type-1.options.__type-2\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-property\",\"parent\":\"analyzer.CreateGeoPointAnalyzerOptions.__type.properties.__type.options\"},{\"kind\":1024,\"name\":\"minCells\",\"url\":\"types/analyzer.CreateGeoPointAnalyzerOptions.html#__type.properties.__type-1.options.__type-2.minCells\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateGeoPointAnalyzerOptions.__type.properties.__type.options.__type\"},{\"kind\":1024,\"name\":\"minLevel\",\"url\":\"types/analyzer.CreateGeoPointAnalyzerOptions.html#__type.properties.__type-1.options.__type-2.minLevel\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateGeoPointAnalyzerOptions.__type.properties.__type.options.__type\"},{\"kind\":1024,\"name\":\"maxLevel\",\"url\":\"types/analyzer.CreateGeoPointAnalyzerOptions.html#__type.properties.__type-1.options.__type-2.maxLevel\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateGeoPointAnalyzerOptions.__type.properties.__type.options.__type\"},{\"kind\":4194304,\"name\":\"CreateGeoS2AnalyzerOptions\",\"url\":\"types/analyzer.CreateGeoS2AnalyzerOptions.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"analyzer\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/analyzer.CreateGeoS2AnalyzerOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"analyzer.CreateGeoS2AnalyzerOptions\"},{\"kind\":1024,\"name\":\"type\",\"url\":\"types/analyzer.CreateGeoS2AnalyzerOptions.html#__type.type-1\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateGeoS2AnalyzerOptions.__type\"},{\"kind\":1024,\"name\":\"features\",\"url\":\"types/analyzer.CreateGeoS2AnalyzerOptions.html#__type.features\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateGeoS2AnalyzerOptions.__type\"},{\"kind\":1024,\"name\":\"properties\",\"url\":\"types/analyzer.CreateGeoS2AnalyzerOptions.html#__type.properties\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateGeoS2AnalyzerOptions.__type\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/analyzer.CreateGeoS2AnalyzerOptions.html#__type.properties.__type-1\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-property\",\"parent\":\"analyzer.CreateGeoS2AnalyzerOptions.__type.properties\"},{\"kind\":1024,\"name\":\"type\",\"url\":\"types/analyzer.CreateGeoS2AnalyzerOptions.html#__type.properties.__type-1.type\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateGeoS2AnalyzerOptions.__type.properties.__type\"},{\"kind\":1024,\"name\":\"options\",\"url\":\"types/analyzer.CreateGeoS2AnalyzerOptions.html#__type.properties.__type-1.options\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateGeoS2AnalyzerOptions.__type.properties.__type\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/analyzer.CreateGeoS2AnalyzerOptions.html#__type.properties.__type-1.options.__type-2\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-property\",\"parent\":\"analyzer.CreateGeoS2AnalyzerOptions.__type.properties.__type.options\"},{\"kind\":1024,\"name\":\"maxCells\",\"url\":\"types/analyzer.CreateGeoS2AnalyzerOptions.html#__type.properties.__type-1.options.__type-2.maxCells\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateGeoS2AnalyzerOptions.__type.properties.__type.options.__type\"},{\"kind\":1024,\"name\":\"minLevel\",\"url\":\"types/analyzer.CreateGeoS2AnalyzerOptions.html#__type.properties.__type-1.options.__type-2.minLevel\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateGeoS2AnalyzerOptions.__type.properties.__type.options.__type\"},{\"kind\":1024,\"name\":\"maxLevel\",\"url\":\"types/analyzer.CreateGeoS2AnalyzerOptions.html#__type.properties.__type-1.options.__type-2.maxLevel\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateGeoS2AnalyzerOptions.__type.properties.__type.options.__type\"},{\"kind\":1024,\"name\":\"format\",\"url\":\"types/analyzer.CreateGeoS2AnalyzerOptions.html#__type.properties.__type-1.format\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.CreateGeoS2AnalyzerOptions.__type.properties.__type\"},{\"kind\":4194304,\"name\":\"GenericAnalyzerDescription\",\"url\":\"types/analyzer.GenericAnalyzerDescription.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"analyzer\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/analyzer.GenericAnalyzerDescription.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"analyzer.GenericAnalyzerDescription\"},{\"kind\":1024,\"name\":\"name\",\"url\":\"types/analyzer.GenericAnalyzerDescription.html#__type.name\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.GenericAnalyzerDescription.__type\"},{\"kind\":1024,\"name\":\"features\",\"url\":\"types/analyzer.GenericAnalyzerDescription.html#__type.features\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"analyzer.GenericAnalyzerDescription.__type\"},{\"kind\":4194304,\"name\":\"AnalyzerDescription\",\"url\":\"types/analyzer.AnalyzerDescription.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"analyzer\"},{\"kind\":4194304,\"name\":\"IdentityAnalyzerDescription\",\"url\":\"types/analyzer.IdentityAnalyzerDescription.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"analyzer\"},{\"kind\":4194304,\"name\":\"DelimiterAnalyzerDescription\",\"url\":\"types/analyzer.DelimiterAnalyzerDescription.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"analyzer\"},{\"kind\":4194304,\"name\":\"MultiDelimiterAnalyzerDescription\",\"url\":\"types/analyzer.MultiDelimiterAnalyzerDescription.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"analyzer\"},{\"kind\":4194304,\"name\":\"StemAnalyzerDescription\",\"url\":\"types/analyzer.StemAnalyzerDescription.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"analyzer\"},{\"kind\":4194304,\"name\":\"NormAnalyzerDescription\",\"url\":\"types/analyzer.NormAnalyzerDescription.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"analyzer\"},{\"kind\":4194304,\"name\":\"NgramAnalyzerDescription\",\"url\":\"types/analyzer.NgramAnalyzerDescription.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"analyzer\"},{\"kind\":4194304,\"name\":\"TextAnalyzerDescription\",\"url\":\"types/analyzer.TextAnalyzerDescription.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"analyzer\"},{\"kind\":4194304,\"name\":\"SegmentationAnalyzerDescription\",\"url\":\"types/analyzer.SegmentationAnalyzerDescription.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"analyzer\"},{\"kind\":4194304,\"name\":\"AqlAnalyzerDescription\",\"url\":\"types/analyzer.AqlAnalyzerDescription.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"analyzer\"},{\"kind\":4194304,\"name\":\"PipelineAnalyzerDescription\",\"url\":\"types/analyzer.PipelineAnalyzerDescription.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"analyzer\"},{\"kind\":4194304,\"name\":\"StopwordsAnalyzerDescription\",\"url\":\"types/analyzer.StopwordsAnalyzerDescription.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"analyzer\"},{\"kind\":4194304,\"name\":\"CollationAnalyzerDescription\",\"url\":\"types/analyzer.CollationAnalyzerDescription.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"analyzer\"},{\"kind\":4194304,\"name\":\"MinHashAnalyzerDescription\",\"url\":\"types/analyzer.MinHashAnalyzerDescription.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"analyzer\"},{\"kind\":4194304,\"name\":\"ClassificationAnalyzerDescription\",\"url\":\"types/analyzer.ClassificationAnalyzerDescription.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"analyzer\"},{\"kind\":4194304,\"name\":\"NearestNeighborsAnalyzerDescription\",\"url\":\"types/analyzer.NearestNeighborsAnalyzerDescription.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"analyzer\"},{\"kind\":4194304,\"name\":\"WildcardAnalyzerDescription\",\"url\":\"types/analyzer.WildcardAnalyzerDescription.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"analyzer\"},{\"kind\":4194304,\"name\":\"GeoJsonAnalyzerDescription\",\"url\":\"types/analyzer.GeoJsonAnalyzerDescription.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"analyzer\"},{\"kind\":4194304,\"name\":\"GeoPointAnalyzerDescription\",\"url\":\"types/analyzer.GeoPointAnalyzerDescription.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"analyzer\"},{\"kind\":4194304,\"name\":\"GeoS2AnalyzerDescription\",\"url\":\"types/analyzer.GeoS2AnalyzerDescription.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"analyzer\"},{\"kind\":128,\"name\":\"Analyzer\",\"url\":\"classes/analyzer.Analyzer.html\",\"classes\":\"tsd-kind-class tsd-parent-kind-module\",\"parent\":\"analyzer\"},{\"kind\":262144,\"name\":\"name\",\"url\":\"classes/analyzer.Analyzer.html#name\",\"classes\":\"tsd-kind-accessor tsd-parent-kind-class\",\"parent\":\"analyzer.Analyzer\"},{\"kind\":2048,\"name\":\"exists\",\"url\":\"classes/analyzer.Analyzer.html#exists\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"analyzer.Analyzer\"},{\"kind\":2048,\"name\":\"get\",\"url\":\"classes/analyzer.Analyzer.html#get\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"analyzer.Analyzer\"},{\"kind\":2048,\"name\":\"create\",\"url\":\"classes/analyzer.Analyzer.html#create\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"analyzer.Analyzer\"},{\"kind\":2048,\"name\":\"drop\",\"url\":\"classes/analyzer.Analyzer.html#drop\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"analyzer.Analyzer\"},{\"kind\":2,\"name\":\"aql\",\"url\":\"modules/aql.html\",\"classes\":\"tsd-kind-module\"},{\"kind\":64,\"name\":\"isAqlQuery\",\"url\":\"functions/aql.isAqlQuery.html\",\"classes\":\"tsd-kind-function tsd-parent-kind-module\",\"parent\":\"aql\"},{\"kind\":64,\"name\":\"isAqlLiteral\",\"url\":\"functions/aql.isAqlLiteral.html\",\"classes\":\"tsd-kind-function tsd-parent-kind-module\",\"parent\":\"aql\"},{\"kind\":64,\"name\":\"aql\",\"url\":\"functions/aql.aql.html\",\"classes\":\"tsd-kind-function tsd-parent-kind-module\",\"parent\":\"aql\"},{\"kind\":64,\"name\":\"literal\",\"url\":\"functions/aql.literal.html\",\"classes\":\"tsd-kind-function tsd-parent-kind-module\",\"parent\":\"aql\"},{\"kind\":64,\"name\":\"join\",\"url\":\"functions/aql.join.html\",\"classes\":\"tsd-kind-function tsd-parent-kind-module\",\"parent\":\"aql\"},{\"kind\":256,\"name\":\"AqlQuery\",\"url\":\"interfaces/aql.AqlQuery.html\",\"classes\":\"tsd-kind-interface tsd-parent-kind-module\",\"parent\":\"aql\"},{\"kind\":1024,\"name\":\"query\",\"url\":\"interfaces/aql.AqlQuery.html#query\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"aql.AqlQuery\"},{\"kind\":1024,\"name\":\"bindVars\",\"url\":\"interfaces/aql.AqlQuery.html#bindVars\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"aql.AqlQuery\"},{\"kind\":1024,\"name\":\"[type]\",\"url\":\"interfaces/aql.AqlQuery.html#_type_\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"aql.AqlQuery\"},{\"kind\":256,\"name\":\"AqlLiteral\",\"url\":\"interfaces/aql.AqlLiteral.html\",\"classes\":\"tsd-kind-interface tsd-parent-kind-module\",\"parent\":\"aql\"},{\"kind\":4194304,\"name\":\"AqlValue\",\"url\":\"types/aql.AqlValue.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"aql\"},{\"kind\":2,\"name\":\"collection\",\"url\":\"modules/collection.html\",\"classes\":\"tsd-kind-module\"},{\"kind\":64,\"name\":\"isArangoCollection\",\"url\":\"functions/collection.isArangoCollection.html\",\"classes\":\"tsd-kind-function tsd-parent-kind-module\",\"parent\":\"collection\"},{\"kind\":64,\"name\":\"collectionToString\",\"url\":\"functions/collection.collectionToString.html\",\"classes\":\"tsd-kind-function tsd-parent-kind-module\",\"parent\":\"collection\"},{\"kind\":256,\"name\":\"ArangoCollection\",\"url\":\"interfaces/collection.ArangoCollection.html\",\"classes\":\"tsd-kind-interface tsd-parent-kind-module\",\"parent\":\"collection\"},{\"kind\":1024,\"name\":\"name\",\"url\":\"interfaces/collection.ArangoCollection.html#name\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"collection.ArangoCollection\"},{\"kind\":8,\"name\":\"CollectionType\",\"url\":\"enums/collection.CollectionType.html\",\"classes\":\"tsd-kind-enum tsd-parent-kind-module\",\"parent\":\"collection\"},{\"kind\":16,\"name\":\"DOCUMENT_COLLECTION\",\"url\":\"enums/collection.CollectionType.html#DOCUMENT_COLLECTION\",\"classes\":\"tsd-kind-enum-member tsd-parent-kind-enum\",\"parent\":\"collection.CollectionType\"},{\"kind\":16,\"name\":\"EDGE_COLLECTION\",\"url\":\"enums/collection.CollectionType.html#EDGE_COLLECTION\",\"classes\":\"tsd-kind-enum-member tsd-parent-kind-enum\",\"parent\":\"collection.CollectionType\"},{\"kind\":8,\"name\":\"CollectionStatus\",\"url\":\"enums/collection.CollectionStatus.html\",\"classes\":\"tsd-kind-enum tsd-parent-kind-module\",\"parent\":\"collection\"},{\"kind\":16,\"name\":\"NEWBORN\",\"url\":\"enums/collection.CollectionStatus.html#NEWBORN\",\"classes\":\"tsd-kind-enum-member tsd-parent-kind-enum\",\"parent\":\"collection.CollectionStatus\"},{\"kind\":16,\"name\":\"UNLOADED\",\"url\":\"enums/collection.CollectionStatus.html#UNLOADED\",\"classes\":\"tsd-kind-enum-member tsd-parent-kind-enum\",\"parent\":\"collection.CollectionStatus\"},{\"kind\":16,\"name\":\"LOADED\",\"url\":\"enums/collection.CollectionStatus.html#LOADED\",\"classes\":\"tsd-kind-enum-member tsd-parent-kind-enum\",\"parent\":\"collection.CollectionStatus\"},{\"kind\":16,\"name\":\"UNLOADING\",\"url\":\"enums/collection.CollectionStatus.html#UNLOADING\",\"classes\":\"tsd-kind-enum-member tsd-parent-kind-enum\",\"parent\":\"collection.CollectionStatus\"},{\"kind\":16,\"name\":\"DELETED\",\"url\":\"enums/collection.CollectionStatus.html#DELETED\",\"classes\":\"tsd-kind-enum-member tsd-parent-kind-enum\",\"parent\":\"collection.CollectionStatus\"},{\"kind\":16,\"name\":\"LOADING\",\"url\":\"enums/collection.CollectionStatus.html#LOADING\",\"classes\":\"tsd-kind-enum-member tsd-parent-kind-enum\",\"parent\":\"collection.CollectionStatus\"},{\"kind\":4194304,\"name\":\"KeyGenerator\",\"url\":\"types/collection.KeyGenerator.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"collection\"},{\"kind\":4194304,\"name\":\"ShardingStrategy\",\"url\":\"types/collection.ShardingStrategy.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"collection\"},{\"kind\":4194304,\"name\":\"SimpleQueryListType\",\"url\":\"types/collection.SimpleQueryListType.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"collection\"},{\"kind\":4194304,\"name\":\"ValidationLevel\",\"url\":\"types/collection.ValidationLevel.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"collection\"},{\"kind\":4194304,\"name\":\"WriteOperation\",\"url\":\"types/collection.WriteOperation.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"collection\"},{\"kind\":4194304,\"name\":\"DocumentOperationFailure\",\"url\":\"types/collection.DocumentOperationFailure.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"collection\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/collection.DocumentOperationFailure.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"collection.DocumentOperationFailure\"},{\"kind\":1024,\"name\":\"error\",\"url\":\"types/collection.DocumentOperationFailure.html#__type.error\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.DocumentOperationFailure.__type\"},{\"kind\":1024,\"name\":\"errorMessage\",\"url\":\"types/collection.DocumentOperationFailure.html#__type.errorMessage\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.DocumentOperationFailure.__type\"},{\"kind\":1024,\"name\":\"errorNum\",\"url\":\"types/collection.DocumentOperationFailure.html#__type.errorNum\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.DocumentOperationFailure.__type\"},{\"kind\":4194304,\"name\":\"DocumentOperationMetadata\",\"url\":\"types/collection.DocumentOperationMetadata.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"collection\"},{\"kind\":4194304,\"name\":\"ComputedValueProperties\",\"url\":\"types/collection.ComputedValueProperties.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"collection\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/collection.ComputedValueProperties.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"collection.ComputedValueProperties\"},{\"kind\":1024,\"name\":\"name\",\"url\":\"types/collection.ComputedValueProperties.html#__type.name\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.ComputedValueProperties.__type\"},{\"kind\":1024,\"name\":\"expression\",\"url\":\"types/collection.ComputedValueProperties.html#__type.expression\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.ComputedValueProperties.__type\"},{\"kind\":1024,\"name\":\"overwrite\",\"url\":\"types/collection.ComputedValueProperties.html#__type.overwrite\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.ComputedValueProperties.__type\"},{\"kind\":1024,\"name\":\"computeOn\",\"url\":\"types/collection.ComputedValueProperties.html#__type.computeOn\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.ComputedValueProperties.__type\"},{\"kind\":1024,\"name\":\"keepNull\",\"url\":\"types/collection.ComputedValueProperties.html#__type.keepNull\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.ComputedValueProperties.__type\"},{\"kind\":1024,\"name\":\"failOnWarning\",\"url\":\"types/collection.ComputedValueProperties.html#__type.failOnWarning\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.ComputedValueProperties.__type\"},{\"kind\":4194304,\"name\":\"CollectionMetadata\",\"url\":\"types/collection.CollectionMetadata.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"collection\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/collection.CollectionMetadata.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"collection.CollectionMetadata\"},{\"kind\":1024,\"name\":\"name\",\"url\":\"types/collection.CollectionMetadata.html#__type.name\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CollectionMetadata.__type\"},{\"kind\":1024,\"name\":\"globallyUniqueId\",\"url\":\"types/collection.CollectionMetadata.html#__type.globallyUniqueId\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CollectionMetadata.__type\"},{\"kind\":1024,\"name\":\"status\",\"url\":\"types/collection.CollectionMetadata.html#__type.status\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CollectionMetadata.__type\"},{\"kind\":1024,\"name\":\"type\",\"url\":\"types/collection.CollectionMetadata.html#__type.type\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CollectionMetadata.__type\"},{\"kind\":4194304,\"name\":\"CollectionKeyProperties\",\"url\":\"types/collection.CollectionKeyProperties.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"collection\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/collection.CollectionKeyProperties.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"collection.CollectionKeyProperties\"},{\"kind\":1024,\"name\":\"type\",\"url\":\"types/collection.CollectionKeyProperties.html#__type.type\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CollectionKeyProperties.__type\"},{\"kind\":1024,\"name\":\"allowUserKeys\",\"url\":\"types/collection.CollectionKeyProperties.html#__type.allowUserKeys\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CollectionKeyProperties.__type\"},{\"kind\":1024,\"name\":\"increment\",\"url\":\"types/collection.CollectionKeyProperties.html#__type.increment\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CollectionKeyProperties.__type\"},{\"kind\":1024,\"name\":\"offset\",\"url\":\"types/collection.CollectionKeyProperties.html#__type.offset\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CollectionKeyProperties.__type\"},{\"kind\":1024,\"name\":\"lastValue\",\"url\":\"types/collection.CollectionKeyProperties.html#__type.lastValue\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CollectionKeyProperties.__type\"},{\"kind\":4194304,\"name\":\"SchemaProperties\",\"url\":\"types/collection.SchemaProperties.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"collection\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/collection.SchemaProperties.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"collection.SchemaProperties\"},{\"kind\":1024,\"name\":\"type\",\"url\":\"types/collection.SchemaProperties.html#__type.type\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.SchemaProperties.__type\"},{\"kind\":1024,\"name\":\"rule\",\"url\":\"types/collection.SchemaProperties.html#__type.rule\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.SchemaProperties.__type\"},{\"kind\":1024,\"name\":\"level\",\"url\":\"types/collection.SchemaProperties.html#__type.level\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.SchemaProperties.__type\"},{\"kind\":1024,\"name\":\"message\",\"url\":\"types/collection.SchemaProperties.html#__type.message\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.SchemaProperties.__type\"},{\"kind\":4194304,\"name\":\"CollectionProperties\",\"url\":\"types/collection.CollectionProperties.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"collection\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/collection.CollectionProperties.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"collection.CollectionProperties\"},{\"kind\":1024,\"name\":\"statusString\",\"url\":\"types/collection.CollectionProperties.html#__type.statusString\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CollectionProperties.__type\"},{\"kind\":1024,\"name\":\"waitForSync\",\"url\":\"types/collection.CollectionProperties.html#__type.waitForSync\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CollectionProperties.__type\"},{\"kind\":1024,\"name\":\"keyOptions\",\"url\":\"types/collection.CollectionProperties.html#__type.keyOptions\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CollectionProperties.__type\"},{\"kind\":1024,\"name\":\"schema\",\"url\":\"types/collection.CollectionProperties.html#__type.schema\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CollectionProperties.__type\"},{\"kind\":1024,\"name\":\"writeConcern\",\"url\":\"types/collection.CollectionProperties.html#__type.writeConcern\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CollectionProperties.__type\"},{\"kind\":1024,\"name\":\"numberOfShards\",\"url\":\"types/collection.CollectionProperties.html#__type.numberOfShards\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CollectionProperties.__type\"},{\"kind\":1024,\"name\":\"shardKeys\",\"url\":\"types/collection.CollectionProperties.html#__type.shardKeys\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CollectionProperties.__type\"},{\"kind\":1024,\"name\":\"replicationFactor\",\"url\":\"types/collection.CollectionProperties.html#__type.replicationFactor\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CollectionProperties.__type\"},{\"kind\":1024,\"name\":\"shardingStrategy\",\"url\":\"types/collection.CollectionProperties.html#__type.shardingStrategy\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CollectionProperties.__type\"},{\"kind\":1024,\"name\":\"distributeShardsLike\",\"url\":\"types/collection.CollectionProperties.html#__type.distributeShardsLike\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CollectionProperties.__type\"},{\"kind\":1024,\"name\":\"smartJoinAttribute\",\"url\":\"types/collection.CollectionProperties.html#__type.smartJoinAttribute\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CollectionProperties.__type\"},{\"kind\":1024,\"name\":\"smartGraphAttribute\",\"url\":\"types/collection.CollectionProperties.html#__type.smartGraphAttribute\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CollectionProperties.__type\"},{\"kind\":1024,\"name\":\"computedValues\",\"url\":\"types/collection.CollectionProperties.html#__type.computedValues\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CollectionProperties.__type\"},{\"kind\":1024,\"name\":\"cacheEnabled\",\"url\":\"types/collection.CollectionProperties.html#__type.cacheEnabled\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CollectionProperties.__type\"},{\"kind\":1024,\"name\":\"syncByRevision\",\"url\":\"types/collection.CollectionProperties.html#__type.syncByRevision\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CollectionProperties.__type\"},{\"kind\":1024,\"name\":\"isSmart\",\"url\":\"types/collection.CollectionProperties.html#__type.isSmart\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CollectionProperties.__type\"},{\"kind\":1024,\"name\":\"isDisjoint\",\"url\":\"types/collection.CollectionProperties.html#__type.isDisjoint\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CollectionProperties.__type\"},{\"kind\":4194304,\"name\":\"ComputedValueOptions\",\"url\":\"types/collection.ComputedValueOptions.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"collection\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/collection.ComputedValueOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"collection.ComputedValueOptions\"},{\"kind\":1024,\"name\":\"name\",\"url\":\"types/collection.ComputedValueOptions.html#__type.name\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.ComputedValueOptions.__type\"},{\"kind\":1024,\"name\":\"expression\",\"url\":\"types/collection.ComputedValueOptions.html#__type.expression\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.ComputedValueOptions.__type\"},{\"kind\":1024,\"name\":\"overwrite\",\"url\":\"types/collection.ComputedValueOptions.html#__type.overwrite\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.ComputedValueOptions.__type\"},{\"kind\":1024,\"name\":\"computeOn\",\"url\":\"types/collection.ComputedValueOptions.html#__type.computeOn\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.ComputedValueOptions.__type\"},{\"kind\":1024,\"name\":\"keepNull\",\"url\":\"types/collection.ComputedValueOptions.html#__type.keepNull\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.ComputedValueOptions.__type\"},{\"kind\":1024,\"name\":\"failOnWarning\",\"url\":\"types/collection.ComputedValueOptions.html#__type.failOnWarning\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.ComputedValueOptions.__type\"},{\"kind\":4194304,\"name\":\"SchemaOptions\",\"url\":\"types/collection.SchemaOptions.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"collection\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/collection.SchemaOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"collection.SchemaOptions\"},{\"kind\":1024,\"name\":\"rule\",\"url\":\"types/collection.SchemaOptions.html#__type.rule\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.SchemaOptions.__type\"},{\"kind\":1024,\"name\":\"level\",\"url\":\"types/collection.SchemaOptions.html#__type.level\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.SchemaOptions.__type\"},{\"kind\":1024,\"name\":\"message\",\"url\":\"types/collection.SchemaOptions.html#__type.message\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.SchemaOptions.__type\"},{\"kind\":4194304,\"name\":\"CollectionPropertiesOptions\",\"url\":\"types/collection.CollectionPropertiesOptions.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"collection\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/collection.CollectionPropertiesOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"collection.CollectionPropertiesOptions\"},{\"kind\":1024,\"name\":\"waitForSync\",\"url\":\"types/collection.CollectionPropertiesOptions.html#__type.waitForSync\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CollectionPropertiesOptions.__type\"},{\"kind\":1024,\"name\":\"replicationFactor\",\"url\":\"types/collection.CollectionPropertiesOptions.html#__type.replicationFactor\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CollectionPropertiesOptions.__type\"},{\"kind\":1024,\"name\":\"writeConcern\",\"url\":\"types/collection.CollectionPropertiesOptions.html#__type.writeConcern\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CollectionPropertiesOptions.__type\"},{\"kind\":1024,\"name\":\"schema\",\"url\":\"types/collection.CollectionPropertiesOptions.html#__type.schema\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CollectionPropertiesOptions.__type\"},{\"kind\":1024,\"name\":\"computedValues\",\"url\":\"types/collection.CollectionPropertiesOptions.html#__type.computedValues\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CollectionPropertiesOptions.__type\"},{\"kind\":1024,\"name\":\"cacheEnabled\",\"url\":\"types/collection.CollectionPropertiesOptions.html#__type.cacheEnabled\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CollectionPropertiesOptions.__type\"},{\"kind\":4194304,\"name\":\"CollectionChecksumOptions\",\"url\":\"types/collection.CollectionChecksumOptions.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"collection\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/collection.CollectionChecksumOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"collection.CollectionChecksumOptions\"},{\"kind\":1024,\"name\":\"withRevisions\",\"url\":\"types/collection.CollectionChecksumOptions.html#__type.withRevisions\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CollectionChecksumOptions.__type\"},{\"kind\":1024,\"name\":\"withData\",\"url\":\"types/collection.CollectionChecksumOptions.html#__type.withData\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CollectionChecksumOptions.__type\"},{\"kind\":4194304,\"name\":\"CollectionDropOptions\",\"url\":\"types/collection.CollectionDropOptions.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"collection\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/collection.CollectionDropOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"collection.CollectionDropOptions\"},{\"kind\":1024,\"name\":\"isSystem\",\"url\":\"types/collection.CollectionDropOptions.html#__type.isSystem\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CollectionDropOptions.__type\"},{\"kind\":4194304,\"name\":\"CollectionKeyOptions\",\"url\":\"types/collection.CollectionKeyOptions.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"collection\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/collection.CollectionKeyOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"collection.CollectionKeyOptions\"},{\"kind\":1024,\"name\":\"type\",\"url\":\"types/collection.CollectionKeyOptions.html#__type.type\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CollectionKeyOptions.__type\"},{\"kind\":1024,\"name\":\"allowUserKeys\",\"url\":\"types/collection.CollectionKeyOptions.html#__type.allowUserKeys\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CollectionKeyOptions.__type\"},{\"kind\":1024,\"name\":\"increment\",\"url\":\"types/collection.CollectionKeyOptions.html#__type.increment\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CollectionKeyOptions.__type\"},{\"kind\":1024,\"name\":\"offset\",\"url\":\"types/collection.CollectionKeyOptions.html#__type.offset\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CollectionKeyOptions.__type\"},{\"kind\":4194304,\"name\":\"CreateCollectionOptions\",\"url\":\"types/collection.CreateCollectionOptions.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"collection\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/collection.CreateCollectionOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"collection.CreateCollectionOptions\"},{\"kind\":1024,\"name\":\"waitForSync\",\"url\":\"types/collection.CreateCollectionOptions.html#__type.waitForSync\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CreateCollectionOptions.__type\"},{\"kind\":1024,\"name\":\"keyOptions\",\"url\":\"types/collection.CreateCollectionOptions.html#__type.keyOptions\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CreateCollectionOptions.__type\"},{\"kind\":1024,\"name\":\"schema\",\"url\":\"types/collection.CreateCollectionOptions.html#__type.schema\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CreateCollectionOptions.__type\"},{\"kind\":1024,\"name\":\"waitForSyncReplication\",\"url\":\"types/collection.CreateCollectionOptions.html#__type.waitForSyncReplication\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CreateCollectionOptions.__type\"},{\"kind\":1024,\"name\":\"enforceReplicationFactor\",\"url\":\"types/collection.CreateCollectionOptions.html#__type.enforceReplicationFactor\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CreateCollectionOptions.__type\"},{\"kind\":1024,\"name\":\"numberOfShards\",\"url\":\"types/collection.CreateCollectionOptions.html#__type.numberOfShards\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CreateCollectionOptions.__type\"},{\"kind\":1024,\"name\":\"shardKeys\",\"url\":\"types/collection.CreateCollectionOptions.html#__type.shardKeys\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CreateCollectionOptions.__type\"},{\"kind\":1024,\"name\":\"replicationFactor\",\"url\":\"types/collection.CreateCollectionOptions.html#__type.replicationFactor\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CreateCollectionOptions.__type\"},{\"kind\":1024,\"name\":\"writeConcern\",\"url\":\"types/collection.CreateCollectionOptions.html#__type.writeConcern\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CreateCollectionOptions.__type\"},{\"kind\":1024,\"name\":\"shardingStrategy\",\"url\":\"types/collection.CreateCollectionOptions.html#__type.shardingStrategy\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CreateCollectionOptions.__type\"},{\"kind\":1024,\"name\":\"distributeShardsLike\",\"url\":\"types/collection.CreateCollectionOptions.html#__type.distributeShardsLike\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CreateCollectionOptions.__type\"},{\"kind\":1024,\"name\":\"smartJoinAttribute\",\"url\":\"types/collection.CreateCollectionOptions.html#__type.smartJoinAttribute\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CreateCollectionOptions.__type\"},{\"kind\":1024,\"name\":\"smartGraphAttribute\",\"url\":\"types/collection.CreateCollectionOptions.html#__type.smartGraphAttribute\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CreateCollectionOptions.__type\"},{\"kind\":1024,\"name\":\"computedValues\",\"url\":\"types/collection.CreateCollectionOptions.html#__type.computedValues\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CreateCollectionOptions.__type\"},{\"kind\":1024,\"name\":\"cacheEnabled\",\"url\":\"types/collection.CreateCollectionOptions.html#__type.cacheEnabled\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CreateCollectionOptions.__type\"},{\"kind\":4194304,\"name\":\"DocumentExistsOptions\",\"url\":\"types/collection.DocumentExistsOptions.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"collection\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/collection.DocumentExistsOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"collection.DocumentExistsOptions\"},{\"kind\":1024,\"name\":\"ifMatch\",\"url\":\"types/collection.DocumentExistsOptions.html#__type.ifMatch\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.DocumentExistsOptions.__type\"},{\"kind\":1024,\"name\":\"ifNoneMatch\",\"url\":\"types/collection.DocumentExistsOptions.html#__type.ifNoneMatch\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.DocumentExistsOptions.__type\"},{\"kind\":4194304,\"name\":\"CollectionReadOptions\",\"url\":\"types/collection.CollectionReadOptions.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"collection\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/collection.CollectionReadOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"collection.CollectionReadOptions\"},{\"kind\":1024,\"name\":\"graceful\",\"url\":\"types/collection.CollectionReadOptions.html#__type.graceful\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CollectionReadOptions.__type\"},{\"kind\":1024,\"name\":\"allowDirtyRead\",\"url\":\"types/collection.CollectionReadOptions.html#__type.allowDirtyRead\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CollectionReadOptions.__type\"},{\"kind\":1024,\"name\":\"ifMatch\",\"url\":\"types/collection.CollectionReadOptions.html#__type.ifMatch\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CollectionReadOptions.__type\"},{\"kind\":1024,\"name\":\"ifNoneMatch\",\"url\":\"types/collection.CollectionReadOptions.html#__type.ifNoneMatch\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CollectionReadOptions.__type\"},{\"kind\":4194304,\"name\":\"CollectionBatchReadOptions\",\"url\":\"types/collection.CollectionBatchReadOptions.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"collection\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/collection.CollectionBatchReadOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"collection.CollectionBatchReadOptions\"},{\"kind\":1024,\"name\":\"allowDirtyRead\",\"url\":\"types/collection.CollectionBatchReadOptions.html#__type.allowDirtyRead\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CollectionBatchReadOptions.__type\"},{\"kind\":4194304,\"name\":\"CollectionInsertOptions\",\"url\":\"types/collection.CollectionInsertOptions.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"collection\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/collection.CollectionInsertOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"collection.CollectionInsertOptions\"},{\"kind\":1024,\"name\":\"waitForSync\",\"url\":\"types/collection.CollectionInsertOptions.html#__type.waitForSync\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CollectionInsertOptions.__type\"},{\"kind\":1024,\"name\":\"silent\",\"url\":\"types/collection.CollectionInsertOptions.html#__type.silent\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CollectionInsertOptions.__type\"},{\"kind\":1024,\"name\":\"returnNew\",\"url\":\"types/collection.CollectionInsertOptions.html#__type.returnNew\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CollectionInsertOptions.__type\"},{\"kind\":1024,\"name\":\"returnOld\",\"url\":\"types/collection.CollectionInsertOptions.html#__type.returnOld\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CollectionInsertOptions.__type\"},{\"kind\":1024,\"name\":\"overwriteMode\",\"url\":\"types/collection.CollectionInsertOptions.html#__type.overwriteMode\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CollectionInsertOptions.__type\"},{\"kind\":1024,\"name\":\"mergeObjects\",\"url\":\"types/collection.CollectionInsertOptions.html#__type.mergeObjects\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CollectionInsertOptions.__type\"},{\"kind\":1024,\"name\":\"refillIndexCaches\",\"url\":\"types/collection.CollectionInsertOptions.html#__type.refillIndexCaches\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CollectionInsertOptions.__type\"},{\"kind\":4194304,\"name\":\"CollectionReplaceOptions\",\"url\":\"types/collection.CollectionReplaceOptions.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"collection\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/collection.CollectionReplaceOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"collection.CollectionReplaceOptions\"},{\"kind\":1024,\"name\":\"waitForSync\",\"url\":\"types/collection.CollectionReplaceOptions.html#__type.waitForSync\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CollectionReplaceOptions.__type\"},{\"kind\":1024,\"name\":\"silent\",\"url\":\"types/collection.CollectionReplaceOptions.html#__type.silent\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CollectionReplaceOptions.__type\"},{\"kind\":1024,\"name\":\"returnNew\",\"url\":\"types/collection.CollectionReplaceOptions.html#__type.returnNew\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CollectionReplaceOptions.__type\"},{\"kind\":1024,\"name\":\"ignoreRevs\",\"url\":\"types/collection.CollectionReplaceOptions.html#__type.ignoreRevs\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CollectionReplaceOptions.__type\"},{\"kind\":1024,\"name\":\"returnOld\",\"url\":\"types/collection.CollectionReplaceOptions.html#__type.returnOld\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CollectionReplaceOptions.__type\"},{\"kind\":1024,\"name\":\"ifMatch\",\"url\":\"types/collection.CollectionReplaceOptions.html#__type.ifMatch\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CollectionReplaceOptions.__type\"},{\"kind\":1024,\"name\":\"refillIndexCaches\",\"url\":\"types/collection.CollectionReplaceOptions.html#__type.refillIndexCaches\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CollectionReplaceOptions.__type\"},{\"kind\":4194304,\"name\":\"CollectionUpdateOptions\",\"url\":\"types/collection.CollectionUpdateOptions.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"collection\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/collection.CollectionUpdateOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"collection.CollectionUpdateOptions\"},{\"kind\":1024,\"name\":\"waitForSync\",\"url\":\"types/collection.CollectionUpdateOptions.html#__type.waitForSync\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CollectionUpdateOptions.__type\"},{\"kind\":1024,\"name\":\"silent\",\"url\":\"types/collection.CollectionUpdateOptions.html#__type.silent\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CollectionUpdateOptions.__type\"},{\"kind\":1024,\"name\":\"returnNew\",\"url\":\"types/collection.CollectionUpdateOptions.html#__type.returnNew\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CollectionUpdateOptions.__type\"},{\"kind\":1024,\"name\":\"ignoreRevs\",\"url\":\"types/collection.CollectionUpdateOptions.html#__type.ignoreRevs\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CollectionUpdateOptions.__type\"},{\"kind\":1024,\"name\":\"returnOld\",\"url\":\"types/collection.CollectionUpdateOptions.html#__type.returnOld\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CollectionUpdateOptions.__type\"},{\"kind\":1024,\"name\":\"keepNull\",\"url\":\"types/collection.CollectionUpdateOptions.html#__type.keepNull\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CollectionUpdateOptions.__type\"},{\"kind\":1024,\"name\":\"mergeObjects\",\"url\":\"types/collection.CollectionUpdateOptions.html#__type.mergeObjects\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CollectionUpdateOptions.__type\"},{\"kind\":1024,\"name\":\"ifMatch\",\"url\":\"types/collection.CollectionUpdateOptions.html#__type.ifMatch\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CollectionUpdateOptions.__type\"},{\"kind\":1024,\"name\":\"refillIndexCaches\",\"url\":\"types/collection.CollectionUpdateOptions.html#__type.refillIndexCaches\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CollectionUpdateOptions.__type\"},{\"kind\":4194304,\"name\":\"CollectionRemoveOptions\",\"url\":\"types/collection.CollectionRemoveOptions.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"collection\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/collection.CollectionRemoveOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"collection.CollectionRemoveOptions\"},{\"kind\":1024,\"name\":\"waitForSync\",\"url\":\"types/collection.CollectionRemoveOptions.html#__type.waitForSync\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CollectionRemoveOptions.__type\"},{\"kind\":1024,\"name\":\"returnOld\",\"url\":\"types/collection.CollectionRemoveOptions.html#__type.returnOld\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CollectionRemoveOptions.__type\"},{\"kind\":1024,\"name\":\"silent\",\"url\":\"types/collection.CollectionRemoveOptions.html#__type.silent\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CollectionRemoveOptions.__type\"},{\"kind\":1024,\"name\":\"ifMatch\",\"url\":\"types/collection.CollectionRemoveOptions.html#__type.ifMatch\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CollectionRemoveOptions.__type\"},{\"kind\":1024,\"name\":\"refillIndexCaches\",\"url\":\"types/collection.CollectionRemoveOptions.html#__type.refillIndexCaches\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CollectionRemoveOptions.__type\"},{\"kind\":4194304,\"name\":\"CollectionImportOptions\",\"url\":\"types/collection.CollectionImportOptions.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"collection\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/collection.CollectionImportOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"collection.CollectionImportOptions\"},{\"kind\":1024,\"name\":\"fromPrefix\",\"url\":\"types/collection.CollectionImportOptions.html#__type.fromPrefix\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CollectionImportOptions.__type\"},{\"kind\":1024,\"name\":\"toPrefix\",\"url\":\"types/collection.CollectionImportOptions.html#__type.toPrefix\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CollectionImportOptions.__type\"},{\"kind\":1024,\"name\":\"overwrite\",\"url\":\"types/collection.CollectionImportOptions.html#__type.overwrite\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CollectionImportOptions.__type\"},{\"kind\":1024,\"name\":\"waitForSync\",\"url\":\"types/collection.CollectionImportOptions.html#__type.waitForSync\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CollectionImportOptions.__type\"},{\"kind\":1024,\"name\":\"onDuplicate\",\"url\":\"types/collection.CollectionImportOptions.html#__type.onDuplicate\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CollectionImportOptions.__type\"},{\"kind\":1024,\"name\":\"complete\",\"url\":\"types/collection.CollectionImportOptions.html#__type.complete\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CollectionImportOptions.__type\"},{\"kind\":1024,\"name\":\"details\",\"url\":\"types/collection.CollectionImportOptions.html#__type.details\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CollectionImportOptions.__type\"},{\"kind\":4194304,\"name\":\"CollectionEdgesOptions\",\"url\":\"types/collection.CollectionEdgesOptions.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"collection\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/collection.CollectionEdgesOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"collection.CollectionEdgesOptions\"},{\"kind\":1024,\"name\":\"allowDirtyRead\",\"url\":\"types/collection.CollectionEdgesOptions.html#__type.allowDirtyRead\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CollectionEdgesOptions.__type\"},{\"kind\":4194304,\"name\":\"SimpleQueryByExampleOptions\",\"url\":\"types/collection.SimpleQueryByExampleOptions.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"collection\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/collection.SimpleQueryByExampleOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"collection.SimpleQueryByExampleOptions\"},{\"kind\":1024,\"name\":\"skip\",\"url\":\"types/collection.SimpleQueryByExampleOptions.html#__type.skip\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.SimpleQueryByExampleOptions.__type\"},{\"kind\":1024,\"name\":\"limit\",\"url\":\"types/collection.SimpleQueryByExampleOptions.html#__type.limit\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.SimpleQueryByExampleOptions.__type\"},{\"kind\":1024,\"name\":\"batchSize\",\"url\":\"types/collection.SimpleQueryByExampleOptions.html#__type.batchSize\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.SimpleQueryByExampleOptions.__type\"},{\"kind\":1024,\"name\":\"ttl\",\"url\":\"types/collection.SimpleQueryByExampleOptions.html#__type.ttl\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.SimpleQueryByExampleOptions.__type\"},{\"kind\":4194304,\"name\":\"SimpleQueryAllOptions\",\"url\":\"types/collection.SimpleQueryAllOptions.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"collection\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/collection.SimpleQueryAllOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"collection.SimpleQueryAllOptions\"},{\"kind\":1024,\"name\":\"skip\",\"url\":\"types/collection.SimpleQueryAllOptions.html#__type.skip\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.SimpleQueryAllOptions.__type\"},{\"kind\":1024,\"name\":\"limit\",\"url\":\"types/collection.SimpleQueryAllOptions.html#__type.limit\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.SimpleQueryAllOptions.__type\"},{\"kind\":1024,\"name\":\"batchSize\",\"url\":\"types/collection.SimpleQueryAllOptions.html#__type.batchSize\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.SimpleQueryAllOptions.__type\"},{\"kind\":1024,\"name\":\"ttl\",\"url\":\"types/collection.SimpleQueryAllOptions.html#__type.ttl\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.SimpleQueryAllOptions.__type\"},{\"kind\":1024,\"name\":\"stream\",\"url\":\"types/collection.SimpleQueryAllOptions.html#__type.stream\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.SimpleQueryAllOptions.__type\"},{\"kind\":4194304,\"name\":\"SimpleQueryUpdateByExampleOptions\",\"url\":\"types/collection.SimpleQueryUpdateByExampleOptions.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"collection\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/collection.SimpleQueryUpdateByExampleOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"collection.SimpleQueryUpdateByExampleOptions\"},{\"kind\":1024,\"name\":\"keepNull\",\"url\":\"types/collection.SimpleQueryUpdateByExampleOptions.html#__type.keepNull\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.SimpleQueryUpdateByExampleOptions.__type\"},{\"kind\":1024,\"name\":\"waitForSync\",\"url\":\"types/collection.SimpleQueryUpdateByExampleOptions.html#__type.waitForSync\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.SimpleQueryUpdateByExampleOptions.__type\"},{\"kind\":1024,\"name\":\"limit\",\"url\":\"types/collection.SimpleQueryUpdateByExampleOptions.html#__type.limit\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.SimpleQueryUpdateByExampleOptions.__type\"},{\"kind\":1024,\"name\":\"mergeObjects\",\"url\":\"types/collection.SimpleQueryUpdateByExampleOptions.html#__type.mergeObjects\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.SimpleQueryUpdateByExampleOptions.__type\"},{\"kind\":4194304,\"name\":\"SimpleQueryRemoveByExampleOptions\",\"url\":\"types/collection.SimpleQueryRemoveByExampleOptions.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"collection\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/collection.SimpleQueryRemoveByExampleOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"collection.SimpleQueryRemoveByExampleOptions\"},{\"kind\":1024,\"name\":\"waitForSync\",\"url\":\"types/collection.SimpleQueryRemoveByExampleOptions.html#__type.waitForSync\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.SimpleQueryRemoveByExampleOptions.__type\"},{\"kind\":1024,\"name\":\"limit\",\"url\":\"types/collection.SimpleQueryRemoveByExampleOptions.html#__type.limit\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.SimpleQueryRemoveByExampleOptions.__type\"},{\"kind\":4194304,\"name\":\"SimpleQueryReplaceByExampleOptions\",\"url\":\"types/collection.SimpleQueryReplaceByExampleOptions.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"collection\"},{\"kind\":4194304,\"name\":\"SimpleQueryRemoveByKeysOptions\",\"url\":\"types/collection.SimpleQueryRemoveByKeysOptions.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"collection\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/collection.SimpleQueryRemoveByKeysOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"collection.SimpleQueryRemoveByKeysOptions\"},{\"kind\":1024,\"name\":\"returnOld\",\"url\":\"types/collection.SimpleQueryRemoveByKeysOptions.html#__type.returnOld\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.SimpleQueryRemoveByKeysOptions.__type\"},{\"kind\":1024,\"name\":\"silent\",\"url\":\"types/collection.SimpleQueryRemoveByKeysOptions.html#__type.silent\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.SimpleQueryRemoveByKeysOptions.__type\"},{\"kind\":1024,\"name\":\"waitForSync\",\"url\":\"types/collection.SimpleQueryRemoveByKeysOptions.html#__type.waitForSync\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.SimpleQueryRemoveByKeysOptions.__type\"},{\"kind\":4194304,\"name\":\"SimpleQueryFulltextOptions\",\"url\":\"types/collection.SimpleQueryFulltextOptions.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"collection\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/collection.SimpleQueryFulltextOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"collection.SimpleQueryFulltextOptions\"},{\"kind\":1024,\"name\":\"index\",\"url\":\"types/collection.SimpleQueryFulltextOptions.html#__type.index\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.SimpleQueryFulltextOptions.__type\"},{\"kind\":1024,\"name\":\"limit\",\"url\":\"types/collection.SimpleQueryFulltextOptions.html#__type.limit\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.SimpleQueryFulltextOptions.__type\"},{\"kind\":1024,\"name\":\"skip\",\"url\":\"types/collection.SimpleQueryFulltextOptions.html#__type.skip\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.SimpleQueryFulltextOptions.__type\"},{\"kind\":4194304,\"name\":\"TraversalOptions\",\"url\":\"types/collection.TraversalOptions.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"collection\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/collection.TraversalOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"collection.TraversalOptions\"},{\"kind\":1024,\"name\":\"init\",\"url\":\"types/collection.TraversalOptions.html#__type.init\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.TraversalOptions.__type\"},{\"kind\":1024,\"name\":\"filter\",\"url\":\"types/collection.TraversalOptions.html#__type.filter\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.TraversalOptions.__type\"},{\"kind\":1024,\"name\":\"sort\",\"url\":\"types/collection.TraversalOptions.html#__type.sort\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.TraversalOptions.__type\"},{\"kind\":1024,\"name\":\"visitor\",\"url\":\"types/collection.TraversalOptions.html#__type.visitor\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.TraversalOptions.__type\"},{\"kind\":1024,\"name\":\"expander\",\"url\":\"types/collection.TraversalOptions.html#__type.expander\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.TraversalOptions.__type\"},{\"kind\":1024,\"name\":\"direction\",\"url\":\"types/collection.TraversalOptions.html#__type.direction\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.TraversalOptions.__type\"},{\"kind\":1024,\"name\":\"itemOrder\",\"url\":\"types/collection.TraversalOptions.html#__type.itemOrder\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.TraversalOptions.__type\"},{\"kind\":1024,\"name\":\"strategy\",\"url\":\"types/collection.TraversalOptions.html#__type.strategy\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.TraversalOptions.__type\"},{\"kind\":1024,\"name\":\"order\",\"url\":\"types/collection.TraversalOptions.html#__type.order\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.TraversalOptions.__type\"},{\"kind\":1024,\"name\":\"uniqueness\",\"url\":\"types/collection.TraversalOptions.html#__type.uniqueness\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.TraversalOptions.__type\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/collection.TraversalOptions.html#__type.uniqueness.__type-1\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-property\",\"parent\":\"collection.TraversalOptions.__type.uniqueness\"},{\"kind\":1024,\"name\":\"vertices\",\"url\":\"types/collection.TraversalOptions.html#__type.uniqueness.__type-1.vertices\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.TraversalOptions.__type.uniqueness.__type\"},{\"kind\":1024,\"name\":\"edges\",\"url\":\"types/collection.TraversalOptions.html#__type.uniqueness.__type-1.edges\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.TraversalOptions.__type.uniqueness.__type\"},{\"kind\":1024,\"name\":\"minDepth\",\"url\":\"types/collection.TraversalOptions.html#__type.minDepth\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.TraversalOptions.__type\"},{\"kind\":1024,\"name\":\"maxDepth\",\"url\":\"types/collection.TraversalOptions.html#__type.maxDepth\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.TraversalOptions.__type\"},{\"kind\":1024,\"name\":\"maxIterations\",\"url\":\"types/collection.TraversalOptions.html#__type.maxIterations\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.TraversalOptions.__type\"},{\"kind\":4194304,\"name\":\"CollectionImportResult\",\"url\":\"types/collection.CollectionImportResult.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"collection\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/collection.CollectionImportResult.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"collection.CollectionImportResult\"},{\"kind\":1024,\"name\":\"error\",\"url\":\"types/collection.CollectionImportResult.html#__type.error\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CollectionImportResult.__type\"},{\"kind\":1024,\"name\":\"created\",\"url\":\"types/collection.CollectionImportResult.html#__type.created\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CollectionImportResult.__type\"},{\"kind\":1024,\"name\":\"errors\",\"url\":\"types/collection.CollectionImportResult.html#__type.errors\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CollectionImportResult.__type\"},{\"kind\":1024,\"name\":\"empty\",\"url\":\"types/collection.CollectionImportResult.html#__type.empty\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CollectionImportResult.__type\"},{\"kind\":1024,\"name\":\"updated\",\"url\":\"types/collection.CollectionImportResult.html#__type.updated\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CollectionImportResult.__type\"},{\"kind\":1024,\"name\":\"ignored\",\"url\":\"types/collection.CollectionImportResult.html#__type.ignored\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CollectionImportResult.__type\"},{\"kind\":1024,\"name\":\"details\",\"url\":\"types/collection.CollectionImportResult.html#__type.details\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CollectionImportResult.__type\"},{\"kind\":4194304,\"name\":\"CollectionEdgesResult\",\"url\":\"types/collection.CollectionEdgesResult.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"collection\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/collection.CollectionEdgesResult.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"collection.CollectionEdgesResult\"},{\"kind\":1024,\"name\":\"edges\",\"url\":\"types/collection.CollectionEdgesResult.html#__type.edges\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CollectionEdgesResult.__type\"},{\"kind\":1024,\"name\":\"stats\",\"url\":\"types/collection.CollectionEdgesResult.html#__type.stats\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CollectionEdgesResult.__type\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/collection.CollectionEdgesResult.html#__type.stats.__type-1\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-property\",\"parent\":\"collection.CollectionEdgesResult.__type.stats\"},{\"kind\":1024,\"name\":\"scannedIndex\",\"url\":\"types/collection.CollectionEdgesResult.html#__type.stats.__type-1.scannedIndex\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CollectionEdgesResult.__type.stats.__type\"},{\"kind\":1024,\"name\":\"filtered\",\"url\":\"types/collection.CollectionEdgesResult.html#__type.stats.__type-1.filtered\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.CollectionEdgesResult.__type.stats.__type\"},{\"kind\":4194304,\"name\":\"SimpleQueryRemoveByExampleResult\",\"url\":\"types/collection.SimpleQueryRemoveByExampleResult.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"collection\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/collection.SimpleQueryRemoveByExampleResult.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"collection.SimpleQueryRemoveByExampleResult\"},{\"kind\":1024,\"name\":\"deleted\",\"url\":\"types/collection.SimpleQueryRemoveByExampleResult.html#__type.deleted\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.SimpleQueryRemoveByExampleResult.__type\"},{\"kind\":4194304,\"name\":\"SimpleQueryReplaceByExampleResult\",\"url\":\"types/collection.SimpleQueryReplaceByExampleResult.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"collection\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/collection.SimpleQueryReplaceByExampleResult.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"collection.SimpleQueryReplaceByExampleResult\"},{\"kind\":1024,\"name\":\"replaced\",\"url\":\"types/collection.SimpleQueryReplaceByExampleResult.html#__type.replaced\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.SimpleQueryReplaceByExampleResult.__type\"},{\"kind\":4194304,\"name\":\"SimpleQueryUpdateByExampleResult\",\"url\":\"types/collection.SimpleQueryUpdateByExampleResult.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"collection\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/collection.SimpleQueryUpdateByExampleResult.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"collection.SimpleQueryUpdateByExampleResult\"},{\"kind\":1024,\"name\":\"updated\",\"url\":\"types/collection.SimpleQueryUpdateByExampleResult.html#__type.updated\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.SimpleQueryUpdateByExampleResult.__type\"},{\"kind\":4194304,\"name\":\"SimpleQueryRemoveByKeysResult\",\"url\":\"types/collection.SimpleQueryRemoveByKeysResult.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"collection\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/collection.SimpleQueryRemoveByKeysResult.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"collection.SimpleQueryRemoveByKeysResult\"},{\"kind\":1024,\"name\":\"removed\",\"url\":\"types/collection.SimpleQueryRemoveByKeysResult.html#__type.removed\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.SimpleQueryRemoveByKeysResult.__type\"},{\"kind\":1024,\"name\":\"ignored\",\"url\":\"types/collection.SimpleQueryRemoveByKeysResult.html#__type.ignored\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.SimpleQueryRemoveByKeysResult.__type\"},{\"kind\":1024,\"name\":\"old\",\"url\":\"types/collection.SimpleQueryRemoveByKeysResult.html#__type.old\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"collection.SimpleQueryRemoveByKeysResult.__type\"},{\"kind\":256,\"name\":\"DocumentCollection\",\"url\":\"interfaces/collection.DocumentCollection.html\",\"classes\":\"tsd-kind-interface tsd-parent-kind-module\",\"parent\":\"collection\"},{\"kind\":2048,\"name\":\"exists\",\"url\":\"interfaces/collection.DocumentCollection.html#exists\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"collection.DocumentCollection\"},{\"kind\":2048,\"name\":\"get\",\"url\":\"interfaces/collection.DocumentCollection.html#get\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"collection.DocumentCollection\"},{\"kind\":2048,\"name\":\"create\",\"url\":\"interfaces/collection.DocumentCollection.html#create\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"collection.DocumentCollection\"},{\"kind\":2048,\"name\":\"properties\",\"url\":\"interfaces/collection.DocumentCollection.html#properties\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"collection.DocumentCollection\"},{\"kind\":2048,\"name\":\"count\",\"url\":\"interfaces/collection.DocumentCollection.html#count\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"collection.DocumentCollection\"},{\"kind\":2048,\"name\":\"recalculateCount\",\"url\":\"interfaces/collection.DocumentCollection.html#recalculateCount\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"collection.DocumentCollection\"},{\"kind\":2048,\"name\":\"figures\",\"url\":\"interfaces/collection.DocumentCollection.html#figures\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"collection.DocumentCollection\"},{\"kind\":2048,\"name\":\"revision\",\"url\":\"interfaces/collection.DocumentCollection.html#revision\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"collection.DocumentCollection\"},{\"kind\":2048,\"name\":\"checksum\",\"url\":\"interfaces/collection.DocumentCollection.html#checksum\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"collection.DocumentCollection\"},{\"kind\":2048,\"name\":\"loadIndexes\",\"url\":\"interfaces/collection.DocumentCollection.html#loadIndexes\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"collection.DocumentCollection\"},{\"kind\":2048,\"name\":\"rename\",\"url\":\"interfaces/collection.DocumentCollection.html#rename\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"collection.DocumentCollection\"},{\"kind\":2048,\"name\":\"truncate\",\"url\":\"interfaces/collection.DocumentCollection.html#truncate\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"collection.DocumentCollection\"},{\"kind\":2048,\"name\":\"drop\",\"url\":\"interfaces/collection.DocumentCollection.html#drop\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"collection.DocumentCollection\"},{\"kind\":2048,\"name\":\"getResponsibleShard\",\"url\":\"interfaces/collection.DocumentCollection.html#getResponsibleShard\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"collection.DocumentCollection\"},{\"kind\":2048,\"name\":\"documentId\",\"url\":\"interfaces/collection.DocumentCollection.html#documentId\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"collection.DocumentCollection\"},{\"kind\":2048,\"name\":\"documentExists\",\"url\":\"interfaces/collection.DocumentCollection.html#documentExists\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"collection.DocumentCollection\"},{\"kind\":2048,\"name\":\"document\",\"url\":\"interfaces/collection.DocumentCollection.html#document\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"collection.DocumentCollection\"},{\"kind\":2048,\"name\":\"documents\",\"url\":\"interfaces/collection.DocumentCollection.html#documents\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"collection.DocumentCollection\"},{\"kind\":2048,\"name\":\"save\",\"url\":\"interfaces/collection.DocumentCollection.html#save\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"collection.DocumentCollection\"},{\"kind\":2048,\"name\":\"saveAll\",\"url\":\"interfaces/collection.DocumentCollection.html#saveAll\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"collection.DocumentCollection\"},{\"kind\":2048,\"name\":\"replace\",\"url\":\"interfaces/collection.DocumentCollection.html#replace\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"collection.DocumentCollection\"},{\"kind\":2048,\"name\":\"replaceAll\",\"url\":\"interfaces/collection.DocumentCollection.html#replaceAll\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"collection.DocumentCollection\"},{\"kind\":2048,\"name\":\"update\",\"url\":\"interfaces/collection.DocumentCollection.html#update\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"collection.DocumentCollection\"},{\"kind\":2048,\"name\":\"updateAll\",\"url\":\"interfaces/collection.DocumentCollection.html#updateAll\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"collection.DocumentCollection\"},{\"kind\":2048,\"name\":\"remove\",\"url\":\"interfaces/collection.DocumentCollection.html#remove\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"collection.DocumentCollection\"},{\"kind\":2048,\"name\":\"removeAll\",\"url\":\"interfaces/collection.DocumentCollection.html#removeAll\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"collection.DocumentCollection\"},{\"kind\":2048,\"name\":\"import\",\"url\":\"interfaces/collection.DocumentCollection.html#import\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"collection.DocumentCollection\"},{\"kind\":2048,\"name\":\"list\",\"url\":\"interfaces/collection.DocumentCollection.html#list\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"collection.DocumentCollection\"},{\"kind\":2048,\"name\":\"all\",\"url\":\"interfaces/collection.DocumentCollection.html#all\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"collection.DocumentCollection\"},{\"kind\":2048,\"name\":\"any\",\"url\":\"interfaces/collection.DocumentCollection.html#any\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"collection.DocumentCollection\"},{\"kind\":2048,\"name\":\"byExample\",\"url\":\"interfaces/collection.DocumentCollection.html#byExample\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"collection.DocumentCollection\"},{\"kind\":2048,\"name\":\"firstExample\",\"url\":\"interfaces/collection.DocumentCollection.html#firstExample\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"collection.DocumentCollection\"},{\"kind\":2048,\"name\":\"removeByExample\",\"url\":\"interfaces/collection.DocumentCollection.html#removeByExample\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"collection.DocumentCollection\"},{\"kind\":2048,\"name\":\"replaceByExample\",\"url\":\"interfaces/collection.DocumentCollection.html#replaceByExample\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"collection.DocumentCollection\"},{\"kind\":2048,\"name\":\"updateByExample\",\"url\":\"interfaces/collection.DocumentCollection.html#updateByExample\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"collection.DocumentCollection\"},{\"kind\":2048,\"name\":\"lookupByKeys\",\"url\":\"interfaces/collection.DocumentCollection.html#lookupByKeys\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"collection.DocumentCollection\"},{\"kind\":2048,\"name\":\"removeByKeys\",\"url\":\"interfaces/collection.DocumentCollection.html#removeByKeys\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"collection.DocumentCollection\"},{\"kind\":2048,\"name\":\"fulltext\",\"url\":\"interfaces/collection.DocumentCollection.html#fulltext\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"collection.DocumentCollection\"},{\"kind\":2048,\"name\":\"indexes\",\"url\":\"interfaces/collection.DocumentCollection.html#indexes\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"collection.DocumentCollection\"},{\"kind\":2048,\"name\":\"index\",\"url\":\"interfaces/collection.DocumentCollection.html#index\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"collection.DocumentCollection\"},{\"kind\":2048,\"name\":\"ensureIndex\",\"url\":\"interfaces/collection.DocumentCollection.html#ensureIndex\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"collection.DocumentCollection\"},{\"kind\":2048,\"name\":\"dropIndex\",\"url\":\"interfaces/collection.DocumentCollection.html#dropIndex\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"collection.DocumentCollection\"},{\"kind\":2048,\"name\":\"compact\",\"url\":\"interfaces/collection.DocumentCollection.html#compact\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"collection.DocumentCollection\"},{\"kind\":1024,\"name\":\"name\",\"url\":\"interfaces/collection.DocumentCollection.html#name\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"collection.DocumentCollection\"},{\"kind\":256,\"name\":\"EdgeCollection\",\"url\":\"interfaces/collection.EdgeCollection.html\",\"classes\":\"tsd-kind-interface tsd-parent-kind-module\",\"parent\":\"collection\"},{\"kind\":2048,\"name\":\"document\",\"url\":\"interfaces/collection.EdgeCollection.html#document\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"collection.EdgeCollection\"},{\"kind\":2048,\"name\":\"documents\",\"url\":\"interfaces/collection.EdgeCollection.html#documents\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"collection.EdgeCollection\"},{\"kind\":2048,\"name\":\"save\",\"url\":\"interfaces/collection.EdgeCollection.html#save\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"collection.EdgeCollection\"},{\"kind\":2048,\"name\":\"saveAll\",\"url\":\"interfaces/collection.EdgeCollection.html#saveAll\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"collection.EdgeCollection\"},{\"kind\":2048,\"name\":\"replace\",\"url\":\"interfaces/collection.EdgeCollection.html#replace\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"collection.EdgeCollection\"},{\"kind\":2048,\"name\":\"replaceAll\",\"url\":\"interfaces/collection.EdgeCollection.html#replaceAll\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"collection.EdgeCollection\"},{\"kind\":2048,\"name\":\"update\",\"url\":\"interfaces/collection.EdgeCollection.html#update\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"collection.EdgeCollection\"},{\"kind\":2048,\"name\":\"updateAll\",\"url\":\"interfaces/collection.EdgeCollection.html#updateAll\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"collection.EdgeCollection\"},{\"kind\":2048,\"name\":\"remove\",\"url\":\"interfaces/collection.EdgeCollection.html#remove\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"collection.EdgeCollection\"},{\"kind\":2048,\"name\":\"removeAll\",\"url\":\"interfaces/collection.EdgeCollection.html#removeAll\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"collection.EdgeCollection\"},{\"kind\":2048,\"name\":\"import\",\"url\":\"interfaces/collection.EdgeCollection.html#import\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"collection.EdgeCollection\"},{\"kind\":2048,\"name\":\"all\",\"url\":\"interfaces/collection.EdgeCollection.html#all\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"collection.EdgeCollection\"},{\"kind\":2048,\"name\":\"any\",\"url\":\"interfaces/collection.EdgeCollection.html#any\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"collection.EdgeCollection\"},{\"kind\":2048,\"name\":\"byExample\",\"url\":\"interfaces/collection.EdgeCollection.html#byExample\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"collection.EdgeCollection\"},{\"kind\":2048,\"name\":\"firstExample\",\"url\":\"interfaces/collection.EdgeCollection.html#firstExample\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"collection.EdgeCollection\"},{\"kind\":2048,\"name\":\"lookupByKeys\",\"url\":\"interfaces/collection.EdgeCollection.html#lookupByKeys\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"collection.EdgeCollection\"},{\"kind\":2048,\"name\":\"fulltext\",\"url\":\"interfaces/collection.EdgeCollection.html#fulltext\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"collection.EdgeCollection\"},{\"kind\":2048,\"name\":\"edges\",\"url\":\"interfaces/collection.EdgeCollection.html#edges\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"collection.EdgeCollection\"},{\"kind\":2048,\"name\":\"inEdges\",\"url\":\"interfaces/collection.EdgeCollection.html#inEdges\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"collection.EdgeCollection\"},{\"kind\":2048,\"name\":\"outEdges\",\"url\":\"interfaces/collection.EdgeCollection.html#outEdges\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"collection.EdgeCollection\"},{\"kind\":2048,\"name\":\"traversal\",\"url\":\"interfaces/collection.EdgeCollection.html#traversal\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"collection.EdgeCollection\"},{\"kind\":2048,\"name\":\"exists\",\"url\":\"interfaces/collection.EdgeCollection.html#exists\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"collection.EdgeCollection\"},{\"kind\":2048,\"name\":\"get\",\"url\":\"interfaces/collection.EdgeCollection.html#get\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"collection.EdgeCollection\"},{\"kind\":2048,\"name\":\"create\",\"url\":\"interfaces/collection.EdgeCollection.html#create\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"collection.EdgeCollection\"},{\"kind\":2048,\"name\":\"properties\",\"url\":\"interfaces/collection.EdgeCollection.html#properties\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"collection.EdgeCollection\"},{\"kind\":2048,\"name\":\"count\",\"url\":\"interfaces/collection.EdgeCollection.html#count\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"collection.EdgeCollection\"},{\"kind\":2048,\"name\":\"recalculateCount\",\"url\":\"interfaces/collection.EdgeCollection.html#recalculateCount\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"collection.EdgeCollection\"},{\"kind\":2048,\"name\":\"figures\",\"url\":\"interfaces/collection.EdgeCollection.html#figures\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"collection.EdgeCollection\"},{\"kind\":2048,\"name\":\"revision\",\"url\":\"interfaces/collection.EdgeCollection.html#revision\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"collection.EdgeCollection\"},{\"kind\":2048,\"name\":\"checksum\",\"url\":\"interfaces/collection.EdgeCollection.html#checksum\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"collection.EdgeCollection\"},{\"kind\":2048,\"name\":\"loadIndexes\",\"url\":\"interfaces/collection.EdgeCollection.html#loadIndexes\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"collection.EdgeCollection\"},{\"kind\":2048,\"name\":\"rename\",\"url\":\"interfaces/collection.EdgeCollection.html#rename\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"collection.EdgeCollection\"},{\"kind\":2048,\"name\":\"truncate\",\"url\":\"interfaces/collection.EdgeCollection.html#truncate\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"collection.EdgeCollection\"},{\"kind\":2048,\"name\":\"drop\",\"url\":\"interfaces/collection.EdgeCollection.html#drop\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"collection.EdgeCollection\"},{\"kind\":2048,\"name\":\"getResponsibleShard\",\"url\":\"interfaces/collection.EdgeCollection.html#getResponsibleShard\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"collection.EdgeCollection\"},{\"kind\":2048,\"name\":\"documentId\",\"url\":\"interfaces/collection.EdgeCollection.html#documentId\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"collection.EdgeCollection\"},{\"kind\":2048,\"name\":\"documentExists\",\"url\":\"interfaces/collection.EdgeCollection.html#documentExists\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"collection.EdgeCollection\"},{\"kind\":2048,\"name\":\"list\",\"url\":\"interfaces/collection.EdgeCollection.html#list\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"collection.EdgeCollection\"},{\"kind\":2048,\"name\":\"removeByExample\",\"url\":\"interfaces/collection.EdgeCollection.html#removeByExample\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"collection.EdgeCollection\"},{\"kind\":2048,\"name\":\"replaceByExample\",\"url\":\"interfaces/collection.EdgeCollection.html#replaceByExample\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"collection.EdgeCollection\"},{\"kind\":2048,\"name\":\"updateByExample\",\"url\":\"interfaces/collection.EdgeCollection.html#updateByExample\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"collection.EdgeCollection\"},{\"kind\":2048,\"name\":\"removeByKeys\",\"url\":\"interfaces/collection.EdgeCollection.html#removeByKeys\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"collection.EdgeCollection\"},{\"kind\":2048,\"name\":\"indexes\",\"url\":\"interfaces/collection.EdgeCollection.html#indexes\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"collection.EdgeCollection\"},{\"kind\":2048,\"name\":\"index\",\"url\":\"interfaces/collection.EdgeCollection.html#index\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"collection.EdgeCollection\"},{\"kind\":2048,\"name\":\"ensureIndex\",\"url\":\"interfaces/collection.EdgeCollection.html#ensureIndex\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"collection.EdgeCollection\"},{\"kind\":2048,\"name\":\"dropIndex\",\"url\":\"interfaces/collection.EdgeCollection.html#dropIndex\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"collection.EdgeCollection\"},{\"kind\":2048,\"name\":\"compact\",\"url\":\"interfaces/collection.EdgeCollection.html#compact\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface\",\"parent\":\"collection.EdgeCollection\"},{\"kind\":1024,\"name\":\"name\",\"url\":\"interfaces/collection.EdgeCollection.html#name\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"collection.EdgeCollection\"},{\"kind\":2,\"name\":\"connection\",\"url\":\"modules/connection.html\",\"classes\":\"tsd-kind-module\"},{\"kind\":4194304,\"name\":\"LoadBalancingStrategy\",\"url\":\"types/connection.LoadBalancingStrategy.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"connection\"},{\"kind\":4194304,\"name\":\"Headers\",\"url\":\"types/connection.Headers.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"connection\"},{\"kind\":4194304,\"name\":\"Params\",\"url\":\"types/connection.Params.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"connection\"},{\"kind\":4194304,\"name\":\"ArangoResponseMetadata\",\"url\":\"types/connection.ArangoResponseMetadata.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"connection\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/connection.ArangoResponseMetadata.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"connection.ArangoResponseMetadata\"},{\"kind\":1024,\"name\":\"error\",\"url\":\"types/connection.ArangoResponseMetadata.html#__type.error\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"connection.ArangoResponseMetadata.__type\"},{\"kind\":1024,\"name\":\"code\",\"url\":\"types/connection.ArangoResponseMetadata.html#__type.code\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"connection.ArangoResponseMetadata.__type\"},{\"kind\":4194304,\"name\":\"ArangoApiResponse\",\"url\":\"types/connection.ArangoApiResponse.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"connection\"},{\"kind\":4194304,\"name\":\"BasicAuthCredentials\",\"url\":\"types/connection.BasicAuthCredentials.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"connection\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/connection.BasicAuthCredentials.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"connection.BasicAuthCredentials\"},{\"kind\":1024,\"name\":\"username\",\"url\":\"types/connection.BasicAuthCredentials.html#__type.username\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"connection.BasicAuthCredentials.__type\"},{\"kind\":1024,\"name\":\"password\",\"url\":\"types/connection.BasicAuthCredentials.html#__type.password\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"connection.BasicAuthCredentials.__type\"},{\"kind\":4194304,\"name\":\"BearerAuthCredentials\",\"url\":\"types/connection.BearerAuthCredentials.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"connection\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/connection.BearerAuthCredentials.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"connection.BearerAuthCredentials\"},{\"kind\":1024,\"name\":\"token\",\"url\":\"types/connection.BearerAuthCredentials.html#__type.token\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"connection.BearerAuthCredentials.__type\"},{\"kind\":4194304,\"name\":\"XhrOptions\",\"url\":\"types/connection.XhrOptions.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"connection\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/connection.XhrOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"connection.XhrOptions\"},{\"kind\":1024,\"name\":\"maxSockets\",\"url\":\"types/connection.XhrOptions.html#__type.maxSockets\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"connection.XhrOptions.__type\"},{\"kind\":1024,\"name\":\"timeout\",\"url\":\"types/connection.XhrOptions.html#__type.timeout\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"connection.XhrOptions.__type\"},{\"kind\":1024,\"name\":\"beforeSend\",\"url\":\"types/connection.XhrOptions.html#__type.beforeSend\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"connection.XhrOptions.__type\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/connection.XhrOptions.html#__type.beforeSend.__type-1\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-property\",\"parent\":\"connection.XhrOptions.__type.beforeSend\"},{\"kind\":1024,\"name\":\"xhr\",\"url\":\"types/connection.XhrOptions.html#__type.xhr\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"connection.XhrOptions.__type\"},{\"kind\":1024,\"name\":\"useXdr\",\"url\":\"types/connection.XhrOptions.html#__type.useXdr\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"connection.XhrOptions.__type\"},{\"kind\":1024,\"name\":\"withCredentials\",\"url\":\"types/connection.XhrOptions.html#__type.withCredentials\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"connection.XhrOptions.__type\"},{\"kind\":4194304,\"name\":\"RequestInterceptors\",\"url\":\"types/connection.RequestInterceptors.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"connection\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/connection.RequestInterceptors.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"connection.RequestInterceptors\"},{\"kind\":1024,\"name\":\"before\",\"url\":\"types/connection.RequestInterceptors.html#__type.before\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"connection.RequestInterceptors.__type\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/connection.RequestInterceptors.html#__type.before.__type-3\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-property\",\"parent\":\"connection.RequestInterceptors.__type.before\"},{\"kind\":1024,\"name\":\"after\",\"url\":\"types/connection.RequestInterceptors.html#__type.after\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"connection.RequestInterceptors.__type\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/connection.RequestInterceptors.html#__type.after.__type-1\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-property\",\"parent\":\"connection.RequestInterceptors.__type.after\"},{\"kind\":4194304,\"name\":\"RequestOptions\",\"url\":\"types/connection.RequestOptions.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"connection\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/connection.RequestOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"connection.RequestOptions\"},{\"kind\":1024,\"name\":\"method\",\"url\":\"types/connection.RequestOptions.html#__type.method\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"connection.RequestOptions.__type\"},{\"kind\":1024,\"name\":\"body\",\"url\":\"types/connection.RequestOptions.html#__type.body\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"connection.RequestOptions.__type\"},{\"kind\":1024,\"name\":\"expectBinary\",\"url\":\"types/connection.RequestOptions.html#__type.expectBinary\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"connection.RequestOptions.__type\"},{\"kind\":1024,\"name\":\"isBinary\",\"url\":\"types/connection.RequestOptions.html#__type.isBinary\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"connection.RequestOptions.__type\"},{\"kind\":1024,\"name\":\"allowDirtyRead\",\"url\":\"types/connection.RequestOptions.html#__type.allowDirtyRead\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"connection.RequestOptions.__type\"},{\"kind\":1024,\"name\":\"retryOnConflict\",\"url\":\"types/connection.RequestOptions.html#__type.retryOnConflict\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"connection.RequestOptions.__type\"},{\"kind\":1024,\"name\":\"headers\",\"url\":\"types/connection.RequestOptions.html#__type.headers\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"connection.RequestOptions.__type\"},{\"kind\":1024,\"name\":\"timeout\",\"url\":\"types/connection.RequestOptions.html#__type.timeout\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"connection.RequestOptions.__type\"},{\"kind\":1024,\"name\":\"basePath\",\"url\":\"types/connection.RequestOptions.html#__type.basePath\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"connection.RequestOptions.__type\"},{\"kind\":1024,\"name\":\"path\",\"url\":\"types/connection.RequestOptions.html#__type.path\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"connection.RequestOptions.__type\"},{\"kind\":1024,\"name\":\"qs\",\"url\":\"types/connection.RequestOptions.html#__type.qs\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"connection.RequestOptions.__type\"},{\"kind\":4194304,\"name\":\"AgentOptions\",\"url\":\"types/connection.AgentOptions.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"connection\"},{\"kind\":4194304,\"name\":\"Config\",\"url\":\"types/connection.Config.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"connection\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/connection.Config.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"connection.Config\"},{\"kind\":1024,\"name\":\"databaseName\",\"url\":\"types/connection.Config.html#__type.databaseName\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"connection.Config.__type\"},{\"kind\":1024,\"name\":\"url\",\"url\":\"types/connection.Config.html#__type.url\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"connection.Config.__type\"},{\"kind\":1024,\"name\":\"auth\",\"url\":\"types/connection.Config.html#__type.auth\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"connection.Config.__type\"},{\"kind\":1024,\"name\":\"arangoVersion\",\"url\":\"types/connection.Config.html#__type.arangoVersion\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"connection.Config.__type\"},{\"kind\":1024,\"name\":\"loadBalancingStrategy\",\"url\":\"types/connection.Config.html#__type.loadBalancingStrategy\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"connection.Config.__type\"},{\"kind\":1024,\"name\":\"maxRetries\",\"url\":\"types/connection.Config.html#__type.maxRetries\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"connection.Config.__type\"},{\"kind\":1024,\"name\":\"retryOnConflict\",\"url\":\"types/connection.Config.html#__type.retryOnConflict\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"connection.Config.__type\"},{\"kind\":1024,\"name\":\"agent\",\"url\":\"types/connection.Config.html#__type.agent\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"connection.Config.__type\"},{\"kind\":1024,\"name\":\"agentOptions\",\"url\":\"types/connection.Config.html#__type.agentOptions\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"connection.Config.__type\"},{\"kind\":1024,\"name\":\"headers\",\"url\":\"types/connection.Config.html#__type.headers\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"connection.Config.__type\"},{\"kind\":1024,\"name\":\"precaptureStackTraces\",\"url\":\"types/connection.Config.html#__type.precaptureStackTraces\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"connection.Config.__type\"},{\"kind\":1024,\"name\":\"responseQueueTimeSamples\",\"url\":\"types/connection.Config.html#__type.responseQueueTimeSamples\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"connection.Config.__type\"},{\"kind\":2,\"name\":\"cursor\",\"url\":\"modules/cursor.html\",\"classes\":\"tsd-kind-module\"},{\"kind\":256,\"name\":\"CursorExtras\",\"url\":\"interfaces/cursor.CursorExtras.html\",\"classes\":\"tsd-kind-interface tsd-parent-kind-module\",\"parent\":\"cursor\"},{\"kind\":1024,\"name\":\"warnings\",\"url\":\"interfaces/cursor.CursorExtras.html#warnings\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"cursor.CursorExtras\"},{\"kind\":1024,\"name\":\"plan\",\"url\":\"interfaces/cursor.CursorExtras.html#plan\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"cursor.CursorExtras\"},{\"kind\":1024,\"name\":\"profile\",\"url\":\"interfaces/cursor.CursorExtras.html#profile\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"cursor.CursorExtras\"},{\"kind\":1024,\"name\":\"stats\",\"url\":\"interfaces/cursor.CursorExtras.html#stats\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"cursor.CursorExtras\"},{\"kind\":256,\"name\":\"CursorStats\",\"url\":\"interfaces/cursor.CursorStats.html\",\"classes\":\"tsd-kind-interface tsd-parent-kind-module\",\"parent\":\"cursor\"},{\"kind\":1024,\"name\":\"cacheHits\",\"url\":\"interfaces/cursor.CursorStats.html#cacheHits\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"cursor.CursorStats\"},{\"kind\":1024,\"name\":\"cacheMisses\",\"url\":\"interfaces/cursor.CursorStats.html#cacheMisses\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"cursor.CursorStats\"},{\"kind\":1024,\"name\":\"cursorsCreated\",\"url\":\"interfaces/cursor.CursorStats.html#cursorsCreated\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"cursor.CursorStats\"},{\"kind\":1024,\"name\":\"cursorsRearmed\",\"url\":\"interfaces/cursor.CursorStats.html#cursorsRearmed\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"cursor.CursorStats\"},{\"kind\":1024,\"name\":\"writesExecuted\",\"url\":\"interfaces/cursor.CursorStats.html#writesExecuted\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"cursor.CursorStats\"},{\"kind\":1024,\"name\":\"writesIgnored\",\"url\":\"interfaces/cursor.CursorStats.html#writesIgnored\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"cursor.CursorStats\"},{\"kind\":1024,\"name\":\"scannedFull\",\"url\":\"interfaces/cursor.CursorStats.html#scannedFull\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"cursor.CursorStats\"},{\"kind\":1024,\"name\":\"scannedIndex\",\"url\":\"interfaces/cursor.CursorStats.html#scannedIndex\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"cursor.CursorStats\"},{\"kind\":1024,\"name\":\"filtered\",\"url\":\"interfaces/cursor.CursorStats.html#filtered\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"cursor.CursorStats\"},{\"kind\":1024,\"name\":\"peakMemoryUsage\",\"url\":\"interfaces/cursor.CursorStats.html#peakMemoryUsage\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"cursor.CursorStats\"},{\"kind\":1024,\"name\":\"executionTime\",\"url\":\"interfaces/cursor.CursorStats.html#executionTime\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"cursor.CursorStats\"},{\"kind\":1024,\"name\":\"fullCount\",\"url\":\"interfaces/cursor.CursorStats.html#fullCount\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"cursor.CursorStats\"},{\"kind\":1024,\"name\":\"httpRequests\",\"url\":\"interfaces/cursor.CursorStats.html#httpRequests\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"cursor.CursorStats\"},{\"kind\":1024,\"name\":\"nodes\",\"url\":\"interfaces/cursor.CursorStats.html#nodes\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"cursor.CursorStats\"},{\"kind\":128,\"name\":\"BatchedArrayCursor\",\"url\":\"classes/cursor.BatchedArrayCursor.html\",\"classes\":\"tsd-kind-class tsd-parent-kind-module\",\"parent\":\"cursor\"},{\"kind\":262144,\"name\":\"items\",\"url\":\"classes/cursor.BatchedArrayCursor.html#items\",\"classes\":\"tsd-kind-accessor tsd-parent-kind-class\",\"parent\":\"cursor.BatchedArrayCursor\"},{\"kind\":262144,\"name\":\"extra\",\"url\":\"classes/cursor.BatchedArrayCursor.html#extra\",\"classes\":\"tsd-kind-accessor tsd-parent-kind-class\",\"parent\":\"cursor.BatchedArrayCursor\"},{\"kind\":262144,\"name\":\"count\",\"url\":\"classes/cursor.BatchedArrayCursor.html#count\",\"classes\":\"tsd-kind-accessor tsd-parent-kind-class\",\"parent\":\"cursor.BatchedArrayCursor\"},{\"kind\":262144,\"name\":\"hasMore\",\"url\":\"classes/cursor.BatchedArrayCursor.html#hasMore\",\"classes\":\"tsd-kind-accessor tsd-parent-kind-class\",\"parent\":\"cursor.BatchedArrayCursor\"},{\"kind\":262144,\"name\":\"hasNext\",\"url\":\"classes/cursor.BatchedArrayCursor.html#hasNext\",\"classes\":\"tsd-kind-accessor tsd-parent-kind-class\",\"parent\":\"cursor.BatchedArrayCursor\"},{\"kind\":2048,\"name\":\"loadAll\",\"url\":\"classes/cursor.BatchedArrayCursor.html#loadAll\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"cursor.BatchedArrayCursor\"},{\"kind\":2048,\"name\":\"all\",\"url\":\"classes/cursor.BatchedArrayCursor.html#all\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"cursor.BatchedArrayCursor\"},{\"kind\":2048,\"name\":\"next\",\"url\":\"classes/cursor.BatchedArrayCursor.html#next\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"cursor.BatchedArrayCursor\"},{\"kind\":2048,\"name\":\"forEach\",\"url\":\"classes/cursor.BatchedArrayCursor.html#forEach\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"cursor.BatchedArrayCursor\"},{\"kind\":2048,\"name\":\"map\",\"url\":\"classes/cursor.BatchedArrayCursor.html#map\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"cursor.BatchedArrayCursor\"},{\"kind\":2048,\"name\":\"flatMap\",\"url\":\"classes/cursor.BatchedArrayCursor.html#flatMap\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"cursor.BatchedArrayCursor\"},{\"kind\":2048,\"name\":\"reduce\",\"url\":\"classes/cursor.BatchedArrayCursor.html#reduce\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"cursor.BatchedArrayCursor\"},{\"kind\":2048,\"name\":\"kill\",\"url\":\"classes/cursor.BatchedArrayCursor.html#kill\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"cursor.BatchedArrayCursor\"},{\"kind\":2048,\"name\":\"[asyncIterator]\",\"url\":\"classes/cursor.BatchedArrayCursor.html#_asyncIterator_\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"cursor.BatchedArrayCursor\"},{\"kind\":128,\"name\":\"ArrayCursor\",\"url\":\"classes/cursor.ArrayCursor.html\",\"classes\":\"tsd-kind-class tsd-parent-kind-module\",\"parent\":\"cursor\"},{\"kind\":262144,\"name\":\"batches\",\"url\":\"classes/cursor.ArrayCursor.html#batches\",\"classes\":\"tsd-kind-accessor tsd-parent-kind-class\",\"parent\":\"cursor.ArrayCursor\"},{\"kind\":262144,\"name\":\"extra\",\"url\":\"classes/cursor.ArrayCursor.html#extra\",\"classes\":\"tsd-kind-accessor tsd-parent-kind-class\",\"parent\":\"cursor.ArrayCursor\"},{\"kind\":262144,\"name\":\"count\",\"url\":\"classes/cursor.ArrayCursor.html#count\",\"classes\":\"tsd-kind-accessor tsd-parent-kind-class\",\"parent\":\"cursor.ArrayCursor\"},{\"kind\":262144,\"name\":\"hasNext\",\"url\":\"classes/cursor.ArrayCursor.html#hasNext\",\"classes\":\"tsd-kind-accessor tsd-parent-kind-class\",\"parent\":\"cursor.ArrayCursor\"},{\"kind\":2048,\"name\":\"all\",\"url\":\"classes/cursor.ArrayCursor.html#all\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"cursor.ArrayCursor\"},{\"kind\":2048,\"name\":\"next\",\"url\":\"classes/cursor.ArrayCursor.html#next\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"cursor.ArrayCursor\"},{\"kind\":2048,\"name\":\"forEach\",\"url\":\"classes/cursor.ArrayCursor.html#forEach\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"cursor.ArrayCursor\"},{\"kind\":2048,\"name\":\"map\",\"url\":\"classes/cursor.ArrayCursor.html#map\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"cursor.ArrayCursor\"},{\"kind\":2048,\"name\":\"flatMap\",\"url\":\"classes/cursor.ArrayCursor.html#flatMap\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"cursor.ArrayCursor\"},{\"kind\":2048,\"name\":\"reduce\",\"url\":\"classes/cursor.ArrayCursor.html#reduce\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"cursor.ArrayCursor\"},{\"kind\":2048,\"name\":\"kill\",\"url\":\"classes/cursor.ArrayCursor.html#kill\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"cursor.ArrayCursor\"},{\"kind\":2048,\"name\":\"[asyncIterator]\",\"url\":\"classes/cursor.ArrayCursor.html#_asyncIterator_\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"cursor.ArrayCursor\"},{\"kind\":2,\"name\":\"database\",\"url\":\"modules/database.html\",\"classes\":\"tsd-kind-module\"},{\"kind\":64,\"name\":\"isArangoDatabase\",\"url\":\"functions/database.isArangoDatabase.html\",\"classes\":\"tsd-kind-function tsd-parent-kind-module\",\"parent\":\"database\"},{\"kind\":4194304,\"name\":\"TransactionCollections\",\"url\":\"types/database.TransactionCollections.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"database\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/database.TransactionCollections.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"database.TransactionCollections\"},{\"kind\":1024,\"name\":\"exclusive\",\"url\":\"types/database.TransactionCollections.html#__type.exclusive\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.TransactionCollections.__type\"},{\"kind\":1024,\"name\":\"write\",\"url\":\"types/database.TransactionCollections.html#__type.write\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.TransactionCollections.__type\"},{\"kind\":1024,\"name\":\"read\",\"url\":\"types/database.TransactionCollections.html#__type.read\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.TransactionCollections.__type\"},{\"kind\":4194304,\"name\":\"TransactionOptions\",\"url\":\"types/database.TransactionOptions.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"database\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/database.TransactionOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"database.TransactionOptions\"},{\"kind\":1024,\"name\":\"allowImplicit\",\"url\":\"types/database.TransactionOptions.html#__type.allowImplicit\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.TransactionOptions.__type\"},{\"kind\":1024,\"name\":\"allowDirtyRead\",\"url\":\"types/database.TransactionOptions.html#__type.allowDirtyRead\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.TransactionOptions.__type\"},{\"kind\":1024,\"name\":\"waitForSync\",\"url\":\"types/database.TransactionOptions.html#__type.waitForSync\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.TransactionOptions.__type\"},{\"kind\":1024,\"name\":\"lockTimeout\",\"url\":\"types/database.TransactionOptions.html#__type.lockTimeout\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.TransactionOptions.__type\"},{\"kind\":1024,\"name\":\"maxTransactionSize\",\"url\":\"types/database.TransactionOptions.html#__type.maxTransactionSize\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.TransactionOptions.__type\"},{\"kind\":4194304,\"name\":\"QueryOptions\",\"url\":\"types/database.QueryOptions.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"database\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/database.QueryOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"database.QueryOptions\"},{\"kind\":1024,\"name\":\"allowDirtyRead\",\"url\":\"types/database.QueryOptions.html#__type.allowDirtyRead\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.QueryOptions.__type\"},{\"kind\":1024,\"name\":\"allowRetry\",\"url\":\"types/database.QueryOptions.html#__type.allowRetry\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.QueryOptions.__type\"},{\"kind\":1024,\"name\":\"timeout\",\"url\":\"types/database.QueryOptions.html#__type.timeout\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.QueryOptions.__type\"},{\"kind\":1024,\"name\":\"retryOnConflict\",\"url\":\"types/database.QueryOptions.html#__type.retryOnConflict\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.QueryOptions.__type\"},{\"kind\":1024,\"name\":\"count\",\"url\":\"types/database.QueryOptions.html#__type.count\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.QueryOptions.__type\"},{\"kind\":1024,\"name\":\"batchSize\",\"url\":\"types/database.QueryOptions.html#__type.batchSize\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.QueryOptions.__type\"},{\"kind\":1024,\"name\":\"cache\",\"url\":\"types/database.QueryOptions.html#__type.cache\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.QueryOptions.__type\"},{\"kind\":1024,\"name\":\"memoryLimit\",\"url\":\"types/database.QueryOptions.html#__type.memoryLimit\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.QueryOptions.__type\"},{\"kind\":1024,\"name\":\"maxRuntime\",\"url\":\"types/database.QueryOptions.html#__type.maxRuntime\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.QueryOptions.__type\"},{\"kind\":1024,\"name\":\"ttl\",\"url\":\"types/database.QueryOptions.html#__type.ttl\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.QueryOptions.__type\"},{\"kind\":1024,\"name\":\"failOnWarning\",\"url\":\"types/database.QueryOptions.html#__type.failOnWarning\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.QueryOptions.__type\"},{\"kind\":1024,\"name\":\"profile\",\"url\":\"types/database.QueryOptions.html#__type.profile\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.QueryOptions.__type\"},{\"kind\":1024,\"name\":\"stream\",\"url\":\"types/database.QueryOptions.html#__type.stream\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.QueryOptions.__type\"},{\"kind\":1024,\"name\":\"maxWarningsCount\",\"url\":\"types/database.QueryOptions.html#__type.maxWarningsCount\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.QueryOptions.__type\"},{\"kind\":1024,\"name\":\"fullCount\",\"url\":\"types/database.QueryOptions.html#__type.fullCount\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.QueryOptions.__type\"},{\"kind\":1024,\"name\":\"fillBlockCache\",\"url\":\"types/database.QueryOptions.html#__type.fillBlockCache\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.QueryOptions.__type\"},{\"kind\":1024,\"name\":\"optimizer\",\"url\":\"types/database.QueryOptions.html#__type.optimizer\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.QueryOptions.__type\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/database.QueryOptions.html#__type.optimizer.__type-1\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-property\",\"parent\":\"database.QueryOptions.__type.optimizer\"},{\"kind\":1024,\"name\":\"rules\",\"url\":\"types/database.QueryOptions.html#__type.optimizer.__type-1.rules\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.QueryOptions.__type.optimizer.__type\"},{\"kind\":1024,\"name\":\"maxPlans\",\"url\":\"types/database.QueryOptions.html#__type.maxPlans\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.QueryOptions.__type\"},{\"kind\":1024,\"name\":\"maxNodesPerCallstack\",\"url\":\"types/database.QueryOptions.html#__type.maxNodesPerCallstack\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.QueryOptions.__type\"},{\"kind\":1024,\"name\":\"maxTransactionSize\",\"url\":\"types/database.QueryOptions.html#__type.maxTransactionSize\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.QueryOptions.__type\"},{\"kind\":1024,\"name\":\"intermediateCommitCount\",\"url\":\"types/database.QueryOptions.html#__type.intermediateCommitCount\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.QueryOptions.__type\"},{\"kind\":1024,\"name\":\"intermediateCommitSize\",\"url\":\"types/database.QueryOptions.html#__type.intermediateCommitSize\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.QueryOptions.__type\"},{\"kind\":1024,\"name\":\"skipInaccessibleCollections\",\"url\":\"types/database.QueryOptions.html#__type.skipInaccessibleCollections\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.QueryOptions.__type\"},{\"kind\":1024,\"name\":\"satelliteSyncWait\",\"url\":\"types/database.QueryOptions.html#__type.satelliteSyncWait\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.QueryOptions.__type\"},{\"kind\":4194304,\"name\":\"ExplainOptions\",\"url\":\"types/database.ExplainOptions.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"database\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/database.ExplainOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"database.ExplainOptions\"},{\"kind\":1024,\"name\":\"optimizer\",\"url\":\"types/database.ExplainOptions.html#__type.optimizer\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ExplainOptions.__type\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/database.ExplainOptions.html#__type.optimizer.__type-1\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-property\",\"parent\":\"database.ExplainOptions.__type.optimizer\"},{\"kind\":1024,\"name\":\"rules\",\"url\":\"types/database.ExplainOptions.html#__type.optimizer.__type-1.rules\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ExplainOptions.__type.optimizer.__type\"},{\"kind\":1024,\"name\":\"maxNumberOfPlans\",\"url\":\"types/database.ExplainOptions.html#__type.maxNumberOfPlans\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ExplainOptions.__type\"},{\"kind\":1024,\"name\":\"allPlans\",\"url\":\"types/database.ExplainOptions.html#__type.allPlans\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ExplainOptions.__type\"},{\"kind\":4194304,\"name\":\"TransactionDetails\",\"url\":\"types/database.TransactionDetails.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"database\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/database.TransactionDetails.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"database.TransactionDetails\"},{\"kind\":1024,\"name\":\"id\",\"url\":\"types/database.TransactionDetails.html#__type.id\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.TransactionDetails.__type\"},{\"kind\":1024,\"name\":\"state\",\"url\":\"types/database.TransactionDetails.html#__type.state\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.TransactionDetails.__type\"},{\"kind\":4194304,\"name\":\"ExplainPlan\",\"url\":\"types/database.ExplainPlan.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"database\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/database.ExplainPlan.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"database.ExplainPlan\"},{\"kind\":1024,\"name\":\"nodes\",\"url\":\"types/database.ExplainPlan.html#__type.nodes\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ExplainPlan.__type\"},{\"kind\":1024,\"name\":\"rules\",\"url\":\"types/database.ExplainPlan.html#__type.rules\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ExplainPlan.__type\"},{\"kind\":1024,\"name\":\"collections\",\"url\":\"types/database.ExplainPlan.html#__type.collections\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ExplainPlan.__type\"},{\"kind\":1024,\"name\":\"variables\",\"url\":\"types/database.ExplainPlan.html#__type.variables\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ExplainPlan.__type\"},{\"kind\":1024,\"name\":\"estimatedCost\",\"url\":\"types/database.ExplainPlan.html#__type.estimatedCost\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ExplainPlan.__type\"},{\"kind\":1024,\"name\":\"estimatedNrItems\",\"url\":\"types/database.ExplainPlan.html#__type.estimatedNrItems\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ExplainPlan.__type\"},{\"kind\":1024,\"name\":\"isModificationQuery\",\"url\":\"types/database.ExplainPlan.html#__type.isModificationQuery\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ExplainPlan.__type\"},{\"kind\":4194304,\"name\":\"ExplainStats\",\"url\":\"types/database.ExplainStats.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"database\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/database.ExplainStats.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"database.ExplainStats\"},{\"kind\":1024,\"name\":\"rulesExecuted\",\"url\":\"types/database.ExplainStats.html#__type.rulesExecuted\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ExplainStats.__type\"},{\"kind\":1024,\"name\":\"rulesSkipped\",\"url\":\"types/database.ExplainStats.html#__type.rulesSkipped\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ExplainStats.__type\"},{\"kind\":1024,\"name\":\"plansCreated\",\"url\":\"types/database.ExplainStats.html#__type.plansCreated\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ExplainStats.__type\"},{\"kind\":1024,\"name\":\"peakMemoryUsage\",\"url\":\"types/database.ExplainStats.html#__type.peakMemoryUsage\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ExplainStats.__type\"},{\"kind\":1024,\"name\":\"executionTime\",\"url\":\"types/database.ExplainStats.html#__type.executionTime\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ExplainStats.__type\"},{\"kind\":4194304,\"name\":\"SingleExplainResult\",\"url\":\"types/database.SingleExplainResult.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"database\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/database.SingleExplainResult.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"database.SingleExplainResult\"},{\"kind\":1024,\"name\":\"plan\",\"url\":\"types/database.SingleExplainResult.html#__type.plan\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.SingleExplainResult.__type\"},{\"kind\":1024,\"name\":\"cacheable\",\"url\":\"types/database.SingleExplainResult.html#__type.cacheable\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.SingleExplainResult.__type\"},{\"kind\":1024,\"name\":\"warnings\",\"url\":\"types/database.SingleExplainResult.html#__type.warnings\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.SingleExplainResult.__type\"},{\"kind\":1024,\"name\":\"stats\",\"url\":\"types/database.SingleExplainResult.html#__type.stats\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.SingleExplainResult.__type\"},{\"kind\":4194304,\"name\":\"MultiExplainResult\",\"url\":\"types/database.MultiExplainResult.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"database\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/database.MultiExplainResult.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"database.MultiExplainResult\"},{\"kind\":1024,\"name\":\"plans\",\"url\":\"types/database.MultiExplainResult.html#__type.plans\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.MultiExplainResult.__type\"},{\"kind\":1024,\"name\":\"cacheable\",\"url\":\"types/database.MultiExplainResult.html#__type.cacheable\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.MultiExplainResult.__type\"},{\"kind\":1024,\"name\":\"warnings\",\"url\":\"types/database.MultiExplainResult.html#__type.warnings\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.MultiExplainResult.__type\"},{\"kind\":1024,\"name\":\"stats\",\"url\":\"types/database.MultiExplainResult.html#__type.stats\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.MultiExplainResult.__type\"},{\"kind\":4194304,\"name\":\"AstNode\",\"url\":\"types/database.AstNode.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"database\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/database.AstNode.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"database.AstNode\"},{\"kind\":1024,\"name\":\"type\",\"url\":\"types/database.AstNode.html#__type.type\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.AstNode.__type\"},{\"kind\":1024,\"name\":\"subNodes\",\"url\":\"types/database.AstNode.html#__type.subNodes\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.AstNode.__type\"},{\"kind\":4194304,\"name\":\"ParseResult\",\"url\":\"types/database.ParseResult.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"database\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/database.ParseResult.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"database.ParseResult\"},{\"kind\":1024,\"name\":\"parsed\",\"url\":\"types/database.ParseResult.html#__type.parsed\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ParseResult.__type\"},{\"kind\":1024,\"name\":\"collections\",\"url\":\"types/database.ParseResult.html#__type.collections\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ParseResult.__type\"},{\"kind\":1024,\"name\":\"bindVars\",\"url\":\"types/database.ParseResult.html#__type.bindVars\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ParseResult.__type\"},{\"kind\":1024,\"name\":\"ast\",\"url\":\"types/database.ParseResult.html#__type.ast\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ParseResult.__type\"},{\"kind\":4194304,\"name\":\"QueryOptimizerRule\",\"url\":\"types/database.QueryOptimizerRule.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"database\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/database.QueryOptimizerRule.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"database.QueryOptimizerRule\"},{\"kind\":1024,\"name\":\"name\",\"url\":\"types/database.QueryOptimizerRule.html#__type.name\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.QueryOptimizerRule.__type\"},{\"kind\":1024,\"name\":\"flags\",\"url\":\"types/database.QueryOptimizerRule.html#__type.flags\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.QueryOptimizerRule.__type\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/database.QueryOptimizerRule.html#__type.flags.__type-1\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-property\",\"parent\":\"database.QueryOptimizerRule.__type.flags\"},{\"kind\":1024,\"name\":\"hidden\",\"url\":\"types/database.QueryOptimizerRule.html#__type.flags.__type-1.hidden\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.QueryOptimizerRule.__type.flags.__type\"},{\"kind\":1024,\"name\":\"clusterOnly\",\"url\":\"types/database.QueryOptimizerRule.html#__type.flags.__type-1.clusterOnly\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.QueryOptimizerRule.__type.flags.__type\"},{\"kind\":1024,\"name\":\"canBeDisabled\",\"url\":\"types/database.QueryOptimizerRule.html#__type.flags.__type-1.canBeDisabled\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.QueryOptimizerRule.__type.flags.__type\"},{\"kind\":1024,\"name\":\"canCreateAdditionalPlans\",\"url\":\"types/database.QueryOptimizerRule.html#__type.flags.__type-1.canCreateAdditionalPlans\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.QueryOptimizerRule.__type.flags.__type\"},{\"kind\":1024,\"name\":\"disabledByDefault\",\"url\":\"types/database.QueryOptimizerRule.html#__type.flags.__type-1.disabledByDefault\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.QueryOptimizerRule.__type.flags.__type\"},{\"kind\":1024,\"name\":\"enterpriseOnly\",\"url\":\"types/database.QueryOptimizerRule.html#__type.flags.__type-1.enterpriseOnly\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.QueryOptimizerRule.__type.flags.__type\"},{\"kind\":4194304,\"name\":\"QueryTracking\",\"url\":\"types/database.QueryTracking.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"database\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/database.QueryTracking.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"database.QueryTracking\"},{\"kind\":1024,\"name\":\"enabled\",\"url\":\"types/database.QueryTracking.html#__type.enabled\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.QueryTracking.__type\"},{\"kind\":1024,\"name\":\"maxQueryStringLength\",\"url\":\"types/database.QueryTracking.html#__type.maxQueryStringLength\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.QueryTracking.__type\"},{\"kind\":1024,\"name\":\"maxSlowQueries\",\"url\":\"types/database.QueryTracking.html#__type.maxSlowQueries\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.QueryTracking.__type\"},{\"kind\":1024,\"name\":\"slowQueryThreshold\",\"url\":\"types/database.QueryTracking.html#__type.slowQueryThreshold\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.QueryTracking.__type\"},{\"kind\":1024,\"name\":\"trackBindVars\",\"url\":\"types/database.QueryTracking.html#__type.trackBindVars\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.QueryTracking.__type\"},{\"kind\":1024,\"name\":\"trackSlowQueries\",\"url\":\"types/database.QueryTracking.html#__type.trackSlowQueries\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.QueryTracking.__type\"},{\"kind\":4194304,\"name\":\"QueryTrackingOptions\",\"url\":\"types/database.QueryTrackingOptions.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"database\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/database.QueryTrackingOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"database.QueryTrackingOptions\"},{\"kind\":1024,\"name\":\"enabled\",\"url\":\"types/database.QueryTrackingOptions.html#__type.enabled\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.QueryTrackingOptions.__type\"},{\"kind\":1024,\"name\":\"maxQueryStringLength\",\"url\":\"types/database.QueryTrackingOptions.html#__type.maxQueryStringLength\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.QueryTrackingOptions.__type\"},{\"kind\":1024,\"name\":\"maxSlowQueries\",\"url\":\"types/database.QueryTrackingOptions.html#__type.maxSlowQueries\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.QueryTrackingOptions.__type\"},{\"kind\":1024,\"name\":\"slowQueryThreshold\",\"url\":\"types/database.QueryTrackingOptions.html#__type.slowQueryThreshold\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.QueryTrackingOptions.__type\"},{\"kind\":1024,\"name\":\"trackBindVars\",\"url\":\"types/database.QueryTrackingOptions.html#__type.trackBindVars\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.QueryTrackingOptions.__type\"},{\"kind\":1024,\"name\":\"trackSlowQueries\",\"url\":\"types/database.QueryTrackingOptions.html#__type.trackSlowQueries\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.QueryTrackingOptions.__type\"},{\"kind\":4194304,\"name\":\"QueryInfo\",\"url\":\"types/database.QueryInfo.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"database\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/database.QueryInfo.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"database.QueryInfo\"},{\"kind\":1024,\"name\":\"id\",\"url\":\"types/database.QueryInfo.html#__type.id\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.QueryInfo.__type\"},{\"kind\":1024,\"name\":\"database\",\"url\":\"types/database.QueryInfo.html#__type.database\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.QueryInfo.__type\"},{\"kind\":1024,\"name\":\"user\",\"url\":\"types/database.QueryInfo.html#__type.user\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.QueryInfo.__type\"},{\"kind\":1024,\"name\":\"query\",\"url\":\"types/database.QueryInfo.html#__type.query\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.QueryInfo.__type\"},{\"kind\":1024,\"name\":\"bindVars\",\"url\":\"types/database.QueryInfo.html#__type.bindVars\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.QueryInfo.__type\"},{\"kind\":1024,\"name\":\"started\",\"url\":\"types/database.QueryInfo.html#__type.started\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.QueryInfo.__type\"},{\"kind\":1024,\"name\":\"runTime\",\"url\":\"types/database.QueryInfo.html#__type.runTime\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.QueryInfo.__type\"},{\"kind\":1024,\"name\":\"peakMemoryUsage\",\"url\":\"types/database.QueryInfo.html#__type.peakMemoryUsage\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.QueryInfo.__type\"},{\"kind\":1024,\"name\":\"state\",\"url\":\"types/database.QueryInfo.html#__type.state\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.QueryInfo.__type\"},{\"kind\":1024,\"name\":\"stream\",\"url\":\"types/database.QueryInfo.html#__type.stream\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.QueryInfo.__type\"},{\"kind\":4194304,\"name\":\"ClusterImbalanceInfo\",\"url\":\"types/database.ClusterImbalanceInfo.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"database\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/database.ClusterImbalanceInfo.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"database.ClusterImbalanceInfo\"},{\"kind\":1024,\"name\":\"leader\",\"url\":\"types/database.ClusterImbalanceInfo.html#__type.leader\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ClusterImbalanceInfo.__type\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/database.ClusterImbalanceInfo.html#__type.leader.__type-1\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-property\",\"parent\":\"database.ClusterImbalanceInfo.__type.leader\"},{\"kind\":1024,\"name\":\"weightUsed\",\"url\":\"types/database.ClusterImbalanceInfo.html#__type.leader.__type-1.weightUsed\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ClusterImbalanceInfo.__type.leader.__type\"},{\"kind\":1024,\"name\":\"targetWeight\",\"url\":\"types/database.ClusterImbalanceInfo.html#__type.leader.__type-1.targetWeight\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ClusterImbalanceInfo.__type.leader.__type\"},{\"kind\":1024,\"name\":\"numberShards\",\"url\":\"types/database.ClusterImbalanceInfo.html#__type.leader.__type-1.numberShards\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ClusterImbalanceInfo.__type.leader.__type\"},{\"kind\":1024,\"name\":\"leaderDupl\",\"url\":\"types/database.ClusterImbalanceInfo.html#__type.leader.__type-1.leaderDupl\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ClusterImbalanceInfo.__type.leader.__type\"},{\"kind\":1024,\"name\":\"totalWeight\",\"url\":\"types/database.ClusterImbalanceInfo.html#__type.leader.__type-1.totalWeight\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ClusterImbalanceInfo.__type.leader.__type\"},{\"kind\":1024,\"name\":\"imbalance\",\"url\":\"types/database.ClusterImbalanceInfo.html#__type.leader.__type-1.imbalance\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ClusterImbalanceInfo.__type.leader.__type\"},{\"kind\":1024,\"name\":\"totalShards\",\"url\":\"types/database.ClusterImbalanceInfo.html#__type.leader.__type-1.totalShards\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ClusterImbalanceInfo.__type.leader.__type\"},{\"kind\":1024,\"name\":\"shards\",\"url\":\"types/database.ClusterImbalanceInfo.html#__type.shards\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ClusterImbalanceInfo.__type\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/database.ClusterImbalanceInfo.html#__type.shards.__type-2\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-property\",\"parent\":\"database.ClusterImbalanceInfo.__type.shards\"},{\"kind\":1024,\"name\":\"sizeUsed\",\"url\":\"types/database.ClusterImbalanceInfo.html#__type.shards.__type-2.sizeUsed\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ClusterImbalanceInfo.__type.shards.__type\"},{\"kind\":1024,\"name\":\"targetSize\",\"url\":\"types/database.ClusterImbalanceInfo.html#__type.shards.__type-2.targetSize\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ClusterImbalanceInfo.__type.shards.__type\"},{\"kind\":1024,\"name\":\"numberShards\",\"url\":\"types/database.ClusterImbalanceInfo.html#__type.shards.__type-2.numberShards-1\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ClusterImbalanceInfo.__type.shards.__type\"},{\"kind\":1024,\"name\":\"totalUsed\",\"url\":\"types/database.ClusterImbalanceInfo.html#__type.shards.__type-2.totalUsed\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ClusterImbalanceInfo.__type.shards.__type\"},{\"kind\":1024,\"name\":\"totalShards\",\"url\":\"types/database.ClusterImbalanceInfo.html#__type.shards.__type-2.totalShards-1\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ClusterImbalanceInfo.__type.shards.__type\"},{\"kind\":1024,\"name\":\"totalShardsFromSystemCollections\",\"url\":\"types/database.ClusterImbalanceInfo.html#__type.shards.__type-2.totalShardsFromSystemCollections\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ClusterImbalanceInfo.__type.shards.__type\"},{\"kind\":1024,\"name\":\"imbalance\",\"url\":\"types/database.ClusterImbalanceInfo.html#__type.shards.__type-2.imbalance-1\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ClusterImbalanceInfo.__type.shards.__type\"},{\"kind\":4194304,\"name\":\"ClusterRebalanceState\",\"url\":\"types/database.ClusterRebalanceState.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"database\"},{\"kind\":4194304,\"name\":\"ClusterRebalanceOptions\",\"url\":\"types/database.ClusterRebalanceOptions.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"database\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/database.ClusterRebalanceOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"database.ClusterRebalanceOptions\"},{\"kind\":1024,\"name\":\"maximumNumberOfMoves\",\"url\":\"types/database.ClusterRebalanceOptions.html#__type.maximumNumberOfMoves\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ClusterRebalanceOptions.__type\"},{\"kind\":1024,\"name\":\"leaderChanges\",\"url\":\"types/database.ClusterRebalanceOptions.html#__type.leaderChanges\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ClusterRebalanceOptions.__type\"},{\"kind\":1024,\"name\":\"moveLeaders\",\"url\":\"types/database.ClusterRebalanceOptions.html#__type.moveLeaders\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ClusterRebalanceOptions.__type\"},{\"kind\":1024,\"name\":\"moveFollowers\",\"url\":\"types/database.ClusterRebalanceOptions.html#__type.moveFollowers\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ClusterRebalanceOptions.__type\"},{\"kind\":1024,\"name\":\"excludeSystemCollections\",\"url\":\"types/database.ClusterRebalanceOptions.html#__type.excludeSystemCollections\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ClusterRebalanceOptions.__type\"},{\"kind\":1024,\"name\":\"piFactor\",\"url\":\"types/database.ClusterRebalanceOptions.html#__type.piFactor\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ClusterRebalanceOptions.__type\"},{\"kind\":1024,\"name\":\"databasesExcluded\",\"url\":\"types/database.ClusterRebalanceOptions.html#__type.databasesExcluded\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ClusterRebalanceOptions.__type\"},{\"kind\":4194304,\"name\":\"ClusterRebalanceMove\",\"url\":\"types/database.ClusterRebalanceMove.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"database\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/database.ClusterRebalanceMove.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"database.ClusterRebalanceMove\"},{\"kind\":1024,\"name\":\"from\",\"url\":\"types/database.ClusterRebalanceMove.html#__type.from\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ClusterRebalanceMove.__type\"},{\"kind\":1024,\"name\":\"to\",\"url\":\"types/database.ClusterRebalanceMove.html#__type.to\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ClusterRebalanceMove.__type\"},{\"kind\":1024,\"name\":\"shard\",\"url\":\"types/database.ClusterRebalanceMove.html#__type.shard\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ClusterRebalanceMove.__type\"},{\"kind\":1024,\"name\":\"collection\",\"url\":\"types/database.ClusterRebalanceMove.html#__type.collection\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ClusterRebalanceMove.__type\"},{\"kind\":1024,\"name\":\"isLeader\",\"url\":\"types/database.ClusterRebalanceMove.html#__type.isLeader\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ClusterRebalanceMove.__type\"},{\"kind\":4194304,\"name\":\"ClusterRebalanceResult\",\"url\":\"types/database.ClusterRebalanceResult.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"database\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/database.ClusterRebalanceResult.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"database.ClusterRebalanceResult\"},{\"kind\":1024,\"name\":\"imbalanceBefore\",\"url\":\"types/database.ClusterRebalanceResult.html#__type.imbalanceBefore\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ClusterRebalanceResult.__type\"},{\"kind\":1024,\"name\":\"imbalanceAfter\",\"url\":\"types/database.ClusterRebalanceResult.html#__type.imbalanceAfter\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ClusterRebalanceResult.__type\"},{\"kind\":1024,\"name\":\"moves\",\"url\":\"types/database.ClusterRebalanceResult.html#__type.moves\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ClusterRebalanceResult.__type\"},{\"kind\":4194304,\"name\":\"CreateDatabaseUser\",\"url\":\"types/database.CreateDatabaseUser.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"database\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/database.CreateDatabaseUser.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"database.CreateDatabaseUser\"},{\"kind\":1024,\"name\":\"username\",\"url\":\"types/database.CreateDatabaseUser.html#__type.username\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.CreateDatabaseUser.__type\"},{\"kind\":1024,\"name\":\"passwd\",\"url\":\"types/database.CreateDatabaseUser.html#__type.passwd\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.CreateDatabaseUser.__type\"},{\"kind\":1024,\"name\":\"active\",\"url\":\"types/database.CreateDatabaseUser.html#__type.active\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.CreateDatabaseUser.__type\"},{\"kind\":1024,\"name\":\"extra\",\"url\":\"types/database.CreateDatabaseUser.html#__type.extra\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.CreateDatabaseUser.__type\"},{\"kind\":4194304,\"name\":\"CreateDatabaseOptions\",\"url\":\"types/database.CreateDatabaseOptions.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"database\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/database.CreateDatabaseOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"database.CreateDatabaseOptions\"},{\"kind\":1024,\"name\":\"users\",\"url\":\"types/database.CreateDatabaseOptions.html#__type.users\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.CreateDatabaseOptions.__type\"},{\"kind\":1024,\"name\":\"sharding\",\"url\":\"types/database.CreateDatabaseOptions.html#__type.sharding\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.CreateDatabaseOptions.__type\"},{\"kind\":1024,\"name\":\"replicationFactor\",\"url\":\"types/database.CreateDatabaseOptions.html#__type.replicationFactor\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.CreateDatabaseOptions.__type\"},{\"kind\":1024,\"name\":\"writeConcern\",\"url\":\"types/database.CreateDatabaseOptions.html#__type.writeConcern\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.CreateDatabaseOptions.__type\"},{\"kind\":4194304,\"name\":\"DatabaseInfo\",\"url\":\"types/database.DatabaseInfo.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"database\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/database.DatabaseInfo.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"database.DatabaseInfo\"},{\"kind\":1024,\"name\":\"name\",\"url\":\"types/database.DatabaseInfo.html#__type.name\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.DatabaseInfo.__type\"},{\"kind\":1024,\"name\":\"id\",\"url\":\"types/database.DatabaseInfo.html#__type.id\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.DatabaseInfo.__type\"},{\"kind\":1024,\"name\":\"path\",\"url\":\"types/database.DatabaseInfo.html#__type.path\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.DatabaseInfo.__type\"},{\"kind\":1024,\"name\":\"isSystem\",\"url\":\"types/database.DatabaseInfo.html#__type.isSystem\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.DatabaseInfo.__type\"},{\"kind\":1024,\"name\":\"sharding\",\"url\":\"types/database.DatabaseInfo.html#__type.sharding\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.DatabaseInfo.__type\"},{\"kind\":1024,\"name\":\"replicationFactor\",\"url\":\"types/database.DatabaseInfo.html#__type.replicationFactor\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.DatabaseInfo.__type\"},{\"kind\":1024,\"name\":\"writeConcern\",\"url\":\"types/database.DatabaseInfo.html#__type.writeConcern\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.DatabaseInfo.__type\"},{\"kind\":4194304,\"name\":\"VersionInfo\",\"url\":\"types/database.VersionInfo.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"database\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/database.VersionInfo.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"database.VersionInfo\"},{\"kind\":1024,\"name\":\"server\",\"url\":\"types/database.VersionInfo.html#__type.server\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.VersionInfo.__type\"},{\"kind\":1024,\"name\":\"license\",\"url\":\"types/database.VersionInfo.html#__type.license\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.VersionInfo.__type\"},{\"kind\":1024,\"name\":\"version\",\"url\":\"types/database.VersionInfo.html#__type.version\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.VersionInfo.__type\"},{\"kind\":1024,\"name\":\"details\",\"url\":\"types/database.VersionInfo.html#__type.details\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.VersionInfo.__type\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/database.VersionInfo.html#__type.details.__type-1\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-property\",\"parent\":\"database.VersionInfo.__type.details\"},{\"kind\":4194304,\"name\":\"AqlUserFunction\",\"url\":\"types/database.AqlUserFunction.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"database\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/database.AqlUserFunction.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"database.AqlUserFunction\"},{\"kind\":1024,\"name\":\"name\",\"url\":\"types/database.AqlUserFunction.html#__type.name\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.AqlUserFunction.__type\"},{\"kind\":1024,\"name\":\"code\",\"url\":\"types/database.AqlUserFunction.html#__type.code\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.AqlUserFunction.__type\"},{\"kind\":1024,\"name\":\"isDeterministic\",\"url\":\"types/database.AqlUserFunction.html#__type.isDeterministic\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.AqlUserFunction.__type\"},{\"kind\":4194304,\"name\":\"InstallServiceOptions\",\"url\":\"types/database.InstallServiceOptions.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"database\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/database.InstallServiceOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"database.InstallServiceOptions\"},{\"kind\":1024,\"name\":\"configuration\",\"url\":\"types/database.InstallServiceOptions.html#__type.configuration\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.InstallServiceOptions.__type\"},{\"kind\":1024,\"name\":\"dependencies\",\"url\":\"types/database.InstallServiceOptions.html#__type.dependencies\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.InstallServiceOptions.__type\"},{\"kind\":1024,\"name\":\"development\",\"url\":\"types/database.InstallServiceOptions.html#__type.development\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.InstallServiceOptions.__type\"},{\"kind\":1024,\"name\":\"legacy\",\"url\":\"types/database.InstallServiceOptions.html#__type.legacy\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.InstallServiceOptions.__type\"},{\"kind\":1024,\"name\":\"setup\",\"url\":\"types/database.InstallServiceOptions.html#__type.setup\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.InstallServiceOptions.__type\"},{\"kind\":4194304,\"name\":\"ReplaceServiceOptions\",\"url\":\"types/database.ReplaceServiceOptions.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"database\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/database.ReplaceServiceOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"database.ReplaceServiceOptions\"},{\"kind\":1024,\"name\":\"configuration\",\"url\":\"types/database.ReplaceServiceOptions.html#__type.configuration\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ReplaceServiceOptions.__type\"},{\"kind\":1024,\"name\":\"dependencies\",\"url\":\"types/database.ReplaceServiceOptions.html#__type.dependencies\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ReplaceServiceOptions.__type\"},{\"kind\":1024,\"name\":\"development\",\"url\":\"types/database.ReplaceServiceOptions.html#__type.development\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ReplaceServiceOptions.__type\"},{\"kind\":1024,\"name\":\"legacy\",\"url\":\"types/database.ReplaceServiceOptions.html#__type.legacy\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ReplaceServiceOptions.__type\"},{\"kind\":1024,\"name\":\"setup\",\"url\":\"types/database.ReplaceServiceOptions.html#__type.setup\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ReplaceServiceOptions.__type\"},{\"kind\":1024,\"name\":\"teardown\",\"url\":\"types/database.ReplaceServiceOptions.html#__type.teardown\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ReplaceServiceOptions.__type\"},{\"kind\":1024,\"name\":\"force\",\"url\":\"types/database.ReplaceServiceOptions.html#__type.force\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ReplaceServiceOptions.__type\"},{\"kind\":4194304,\"name\":\"UpgradeServiceOptions\",\"url\":\"types/database.UpgradeServiceOptions.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"database\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/database.UpgradeServiceOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"database.UpgradeServiceOptions\"},{\"kind\":1024,\"name\":\"configuration\",\"url\":\"types/database.UpgradeServiceOptions.html#__type.configuration\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.UpgradeServiceOptions.__type\"},{\"kind\":1024,\"name\":\"dependencies\",\"url\":\"types/database.UpgradeServiceOptions.html#__type.dependencies\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.UpgradeServiceOptions.__type\"},{\"kind\":1024,\"name\":\"development\",\"url\":\"types/database.UpgradeServiceOptions.html#__type.development\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.UpgradeServiceOptions.__type\"},{\"kind\":1024,\"name\":\"legacy\",\"url\":\"types/database.UpgradeServiceOptions.html#__type.legacy\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.UpgradeServiceOptions.__type\"},{\"kind\":1024,\"name\":\"setup\",\"url\":\"types/database.UpgradeServiceOptions.html#__type.setup\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.UpgradeServiceOptions.__type\"},{\"kind\":1024,\"name\":\"teardown\",\"url\":\"types/database.UpgradeServiceOptions.html#__type.teardown\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.UpgradeServiceOptions.__type\"},{\"kind\":1024,\"name\":\"force\",\"url\":\"types/database.UpgradeServiceOptions.html#__type.force\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.UpgradeServiceOptions.__type\"},{\"kind\":4194304,\"name\":\"UninstallServiceOptions\",\"url\":\"types/database.UninstallServiceOptions.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"database\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/database.UninstallServiceOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"database.UninstallServiceOptions\"},{\"kind\":1024,\"name\":\"teardown\",\"url\":\"types/database.UninstallServiceOptions.html#__type.teardown\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.UninstallServiceOptions.__type\"},{\"kind\":1024,\"name\":\"force\",\"url\":\"types/database.UninstallServiceOptions.html#__type.force\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.UninstallServiceOptions.__type\"},{\"kind\":4194304,\"name\":\"ServiceSummary\",\"url\":\"types/database.ServiceSummary.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"database\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/database.ServiceSummary.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"database.ServiceSummary\"},{\"kind\":1024,\"name\":\"mount\",\"url\":\"types/database.ServiceSummary.html#__type.mount\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ServiceSummary.__type\"},{\"kind\":1024,\"name\":\"name\",\"url\":\"types/database.ServiceSummary.html#__type.name\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ServiceSummary.__type\"},{\"kind\":1024,\"name\":\"version\",\"url\":\"types/database.ServiceSummary.html#__type.version\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ServiceSummary.__type\"},{\"kind\":1024,\"name\":\"provides\",\"url\":\"types/database.ServiceSummary.html#__type.provides\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ServiceSummary.__type\"},{\"kind\":1024,\"name\":\"development\",\"url\":\"types/database.ServiceSummary.html#__type.development\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ServiceSummary.__type\"},{\"kind\":1024,\"name\":\"legacy\",\"url\":\"types/database.ServiceSummary.html#__type.legacy\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ServiceSummary.__type\"},{\"kind\":4194304,\"name\":\"ServiceInfo\",\"url\":\"types/database.ServiceInfo.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"database\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/database.ServiceInfo.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"database.ServiceInfo\"},{\"kind\":1024,\"name\":\"mount\",\"url\":\"types/database.ServiceInfo.html#__type.mount\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ServiceInfo.__type\"},{\"kind\":1024,\"name\":\"path\",\"url\":\"types/database.ServiceInfo.html#__type.path\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ServiceInfo.__type\"},{\"kind\":1024,\"name\":\"name\",\"url\":\"types/database.ServiceInfo.html#__type.name\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ServiceInfo.__type\"},{\"kind\":1024,\"name\":\"version\",\"url\":\"types/database.ServiceInfo.html#__type.version\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ServiceInfo.__type\"},{\"kind\":1024,\"name\":\"development\",\"url\":\"types/database.ServiceInfo.html#__type.development\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ServiceInfo.__type\"},{\"kind\":1024,\"name\":\"legacy\",\"url\":\"types/database.ServiceInfo.html#__type.legacy\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ServiceInfo.__type\"},{\"kind\":1024,\"name\":\"manifest\",\"url\":\"types/database.ServiceInfo.html#__type.manifest\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ServiceInfo.__type\"},{\"kind\":1024,\"name\":\"checksum\",\"url\":\"types/database.ServiceInfo.html#__type.checksum\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ServiceInfo.__type\"},{\"kind\":1024,\"name\":\"options\",\"url\":\"types/database.ServiceInfo.html#__type.options\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ServiceInfo.__type\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/database.ServiceInfo.html#__type.options.__type-1\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-property\",\"parent\":\"database.ServiceInfo.__type.options\"},{\"kind\":1024,\"name\":\"configuration\",\"url\":\"types/database.ServiceInfo.html#__type.options.__type-1.configuration\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ServiceInfo.__type.options.__type\"},{\"kind\":1024,\"name\":\"dependencies\",\"url\":\"types/database.ServiceInfo.html#__type.options.__type-1.dependencies\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ServiceInfo.__type.options.__type\"},{\"kind\":4194304,\"name\":\"ServiceConfiguration\",\"url\":\"types/database.ServiceConfiguration.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"database\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/database.ServiceConfiguration.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"database.ServiceConfiguration\"},{\"kind\":1024,\"name\":\"type\",\"url\":\"types/database.ServiceConfiguration.html#__type.type\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ServiceConfiguration.__type\"},{\"kind\":1024,\"name\":\"currentRaw\",\"url\":\"types/database.ServiceConfiguration.html#__type.currentRaw\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ServiceConfiguration.__type\"},{\"kind\":1024,\"name\":\"current\",\"url\":\"types/database.ServiceConfiguration.html#__type.current\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ServiceConfiguration.__type\"},{\"kind\":1024,\"name\":\"title\",\"url\":\"types/database.ServiceConfiguration.html#__type.title\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ServiceConfiguration.__type\"},{\"kind\":1024,\"name\":\"description\",\"url\":\"types/database.ServiceConfiguration.html#__type.description\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ServiceConfiguration.__type\"},{\"kind\":1024,\"name\":\"required\",\"url\":\"types/database.ServiceConfiguration.html#__type.required\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ServiceConfiguration.__type\"},{\"kind\":1024,\"name\":\"default\",\"url\":\"types/database.ServiceConfiguration.html#__type.default\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ServiceConfiguration.__type\"},{\"kind\":4194304,\"name\":\"SingleServiceDependency\",\"url\":\"types/database.SingleServiceDependency.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"database\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/database.SingleServiceDependency.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"database.SingleServiceDependency\"},{\"kind\":1024,\"name\":\"multiple\",\"url\":\"types/database.SingleServiceDependency.html#__type.multiple\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.SingleServiceDependency.__type\"},{\"kind\":1024,\"name\":\"current\",\"url\":\"types/database.SingleServiceDependency.html#__type.current\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.SingleServiceDependency.__type\"},{\"kind\":1024,\"name\":\"title\",\"url\":\"types/database.SingleServiceDependency.html#__type.title\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.SingleServiceDependency.__type\"},{\"kind\":1024,\"name\":\"name\",\"url\":\"types/database.SingleServiceDependency.html#__type.name\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.SingleServiceDependency.__type\"},{\"kind\":1024,\"name\":\"version\",\"url\":\"types/database.SingleServiceDependency.html#__type.version\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.SingleServiceDependency.__type\"},{\"kind\":1024,\"name\":\"description\",\"url\":\"types/database.SingleServiceDependency.html#__type.description\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.SingleServiceDependency.__type\"},{\"kind\":1024,\"name\":\"required\",\"url\":\"types/database.SingleServiceDependency.html#__type.required\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.SingleServiceDependency.__type\"},{\"kind\":4194304,\"name\":\"MultiServiceDependency\",\"url\":\"types/database.MultiServiceDependency.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"database\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/database.MultiServiceDependency.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"database.MultiServiceDependency\"},{\"kind\":1024,\"name\":\"multiple\",\"url\":\"types/database.MultiServiceDependency.html#__type.multiple\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.MultiServiceDependency.__type\"},{\"kind\":1024,\"name\":\"current\",\"url\":\"types/database.MultiServiceDependency.html#__type.current\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.MultiServiceDependency.__type\"},{\"kind\":1024,\"name\":\"title\",\"url\":\"types/database.MultiServiceDependency.html#__type.title\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.MultiServiceDependency.__type\"},{\"kind\":1024,\"name\":\"name\",\"url\":\"types/database.MultiServiceDependency.html#__type.name\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.MultiServiceDependency.__type\"},{\"kind\":1024,\"name\":\"version\",\"url\":\"types/database.MultiServiceDependency.html#__type.version\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.MultiServiceDependency.__type\"},{\"kind\":1024,\"name\":\"description\",\"url\":\"types/database.MultiServiceDependency.html#__type.description\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.MultiServiceDependency.__type\"},{\"kind\":1024,\"name\":\"required\",\"url\":\"types/database.MultiServiceDependency.html#__type.required\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.MultiServiceDependency.__type\"},{\"kind\":4194304,\"name\":\"ServiceTestStats\",\"url\":\"types/database.ServiceTestStats.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"database\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/database.ServiceTestStats.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"database.ServiceTestStats\"},{\"kind\":1024,\"name\":\"tests\",\"url\":\"types/database.ServiceTestStats.html#__type.tests\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ServiceTestStats.__type\"},{\"kind\":1024,\"name\":\"passes\",\"url\":\"types/database.ServiceTestStats.html#__type.passes\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ServiceTestStats.__type\"},{\"kind\":1024,\"name\":\"failures\",\"url\":\"types/database.ServiceTestStats.html#__type.failures\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ServiceTestStats.__type\"},{\"kind\":1024,\"name\":\"pending\",\"url\":\"types/database.ServiceTestStats.html#__type.pending\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ServiceTestStats.__type\"},{\"kind\":1024,\"name\":\"duration\",\"url\":\"types/database.ServiceTestStats.html#__type.duration\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ServiceTestStats.__type\"},{\"kind\":4194304,\"name\":\"ServiceTestStreamTest\",\"url\":\"types/database.ServiceTestStreamTest.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"database\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/database.ServiceTestStreamTest.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"database.ServiceTestStreamTest\"},{\"kind\":1024,\"name\":\"title\",\"url\":\"types/database.ServiceTestStreamTest.html#__type.title\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ServiceTestStreamTest.__type\"},{\"kind\":1024,\"name\":\"fullTitle\",\"url\":\"types/database.ServiceTestStreamTest.html#__type.fullTitle\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ServiceTestStreamTest.__type\"},{\"kind\":1024,\"name\":\"duration\",\"url\":\"types/database.ServiceTestStreamTest.html#__type.duration\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ServiceTestStreamTest.__type\"},{\"kind\":1024,\"name\":\"err\",\"url\":\"types/database.ServiceTestStreamTest.html#__type.err\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ServiceTestStreamTest.__type\"},{\"kind\":4194304,\"name\":\"ServiceTestStreamReport\",\"url\":\"types/database.ServiceTestStreamReport.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"database\"},{\"kind\":4194304,\"name\":\"ServiceTestSuiteTest\",\"url\":\"types/database.ServiceTestSuiteTest.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"database\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/database.ServiceTestSuiteTest.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"database.ServiceTestSuiteTest\"},{\"kind\":1024,\"name\":\"result\",\"url\":\"types/database.ServiceTestSuiteTest.html#__type.result\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ServiceTestSuiteTest.__type\"},{\"kind\":1024,\"name\":\"title\",\"url\":\"types/database.ServiceTestSuiteTest.html#__type.title\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ServiceTestSuiteTest.__type\"},{\"kind\":1024,\"name\":\"duration\",\"url\":\"types/database.ServiceTestSuiteTest.html#__type.duration\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ServiceTestSuiteTest.__type\"},{\"kind\":1024,\"name\":\"err\",\"url\":\"types/database.ServiceTestSuiteTest.html#__type.err\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ServiceTestSuiteTest.__type\"},{\"kind\":4194304,\"name\":\"ServiceTestSuite\",\"url\":\"types/database.ServiceTestSuite.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"database\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/database.ServiceTestSuite.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"database.ServiceTestSuite\"},{\"kind\":1024,\"name\":\"title\",\"url\":\"types/database.ServiceTestSuite.html#__type.title\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ServiceTestSuite.__type\"},{\"kind\":1024,\"name\":\"suites\",\"url\":\"types/database.ServiceTestSuite.html#__type.suites\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ServiceTestSuite.__type\"},{\"kind\":1024,\"name\":\"tests\",\"url\":\"types/database.ServiceTestSuite.html#__type.tests\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ServiceTestSuite.__type\"},{\"kind\":4194304,\"name\":\"ServiceTestSuiteReport\",\"url\":\"types/database.ServiceTestSuiteReport.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"database\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/database.ServiceTestSuiteReport.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"database.ServiceTestSuiteReport\"},{\"kind\":1024,\"name\":\"stats\",\"url\":\"types/database.ServiceTestSuiteReport.html#__type.stats\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ServiceTestSuiteReport.__type\"},{\"kind\":1024,\"name\":\"suites\",\"url\":\"types/database.ServiceTestSuiteReport.html#__type.suites\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ServiceTestSuiteReport.__type\"},{\"kind\":1024,\"name\":\"tests\",\"url\":\"types/database.ServiceTestSuiteReport.html#__type.tests\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ServiceTestSuiteReport.__type\"},{\"kind\":4194304,\"name\":\"ServiceTestXunitTest\",\"url\":\"types/database.ServiceTestXunitTest.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"database\"},{\"kind\":4194304,\"name\":\"ServiceTestXunitReport\",\"url\":\"types/database.ServiceTestXunitReport.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"database\"},{\"kind\":4194304,\"name\":\"ServiceTestTapReport\",\"url\":\"types/database.ServiceTestTapReport.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"database\"},{\"kind\":4194304,\"name\":\"ServiceTestDefaultTest\",\"url\":\"types/database.ServiceTestDefaultTest.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"database\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/database.ServiceTestDefaultTest.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"database.ServiceTestDefaultTest\"},{\"kind\":1024,\"name\":\"title\",\"url\":\"types/database.ServiceTestDefaultTest.html#__type.title\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ServiceTestDefaultTest.__type\"},{\"kind\":1024,\"name\":\"fullTitle\",\"url\":\"types/database.ServiceTestDefaultTest.html#__type.fullTitle\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ServiceTestDefaultTest.__type\"},{\"kind\":1024,\"name\":\"duration\",\"url\":\"types/database.ServiceTestDefaultTest.html#__type.duration\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ServiceTestDefaultTest.__type\"},{\"kind\":1024,\"name\":\"err\",\"url\":\"types/database.ServiceTestDefaultTest.html#__type.err\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ServiceTestDefaultTest.__type\"},{\"kind\":4194304,\"name\":\"ServiceTestDefaultReport\",\"url\":\"types/database.ServiceTestDefaultReport.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"database\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/database.ServiceTestDefaultReport.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"database.ServiceTestDefaultReport\"},{\"kind\":1024,\"name\":\"stats\",\"url\":\"types/database.ServiceTestDefaultReport.html#__type.stats\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ServiceTestDefaultReport.__type\"},{\"kind\":1024,\"name\":\"tests\",\"url\":\"types/database.ServiceTestDefaultReport.html#__type.tests\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ServiceTestDefaultReport.__type\"},{\"kind\":1024,\"name\":\"pending\",\"url\":\"types/database.ServiceTestDefaultReport.html#__type.pending\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ServiceTestDefaultReport.__type\"},{\"kind\":1024,\"name\":\"failures\",\"url\":\"types/database.ServiceTestDefaultReport.html#__type.failures\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ServiceTestDefaultReport.__type\"},{\"kind\":1024,\"name\":\"passes\",\"url\":\"types/database.ServiceTestDefaultReport.html#__type.passes\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ServiceTestDefaultReport.__type\"},{\"kind\":4194304,\"name\":\"SwaggerJson\",\"url\":\"types/database.SwaggerJson.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"database\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/database.SwaggerJson.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"database.SwaggerJson\"},{\"kind\":1024,\"name\":\"info\",\"url\":\"types/database.SwaggerJson.html#__type.info\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.SwaggerJson.__type\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/database.SwaggerJson.html#__type.info.__type-1\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-property\",\"parent\":\"database.SwaggerJson.__type.info\"},{\"kind\":1024,\"name\":\"title\",\"url\":\"types/database.SwaggerJson.html#__type.info.__type-1.title\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.SwaggerJson.__type.info.__type\"},{\"kind\":1024,\"name\":\"description\",\"url\":\"types/database.SwaggerJson.html#__type.info.__type-1.description\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.SwaggerJson.__type.info.__type\"},{\"kind\":1024,\"name\":\"version\",\"url\":\"types/database.SwaggerJson.html#__type.info.__type-1.version\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.SwaggerJson.__type.info.__type\"},{\"kind\":1024,\"name\":\"license\",\"url\":\"types/database.SwaggerJson.html#__type.info.__type-1.license\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.SwaggerJson.__type.info.__type\"},{\"kind\":1024,\"name\":\"path\",\"url\":\"types/database.SwaggerJson.html#__type.path\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.SwaggerJson.__type\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/database.SwaggerJson.html#__type.path.__type-2\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-property\",\"parent\":\"database.SwaggerJson.__type.path\"},{\"kind\":4194304,\"name\":\"AccessLevel\",\"url\":\"types/database.AccessLevel.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"database\"},{\"kind\":4194304,\"name\":\"ArangoUser\",\"url\":\"types/database.ArangoUser.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"database\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/database.ArangoUser.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"database.ArangoUser\"},{\"kind\":1024,\"name\":\"user\",\"url\":\"types/database.ArangoUser.html#__type.user\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ArangoUser.__type\"},{\"kind\":1024,\"name\":\"active\",\"url\":\"types/database.ArangoUser.html#__type.active\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ArangoUser.__type\"},{\"kind\":1024,\"name\":\"extra\",\"url\":\"types/database.ArangoUser.html#__type.extra\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.ArangoUser.__type\"},{\"kind\":4194304,\"name\":\"CreateUserOptions\",\"url\":\"types/database.CreateUserOptions.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"database\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/database.CreateUserOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"database.CreateUserOptions\"},{\"kind\":1024,\"name\":\"user\",\"url\":\"types/database.CreateUserOptions.html#__type.user\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.CreateUserOptions.__type\"},{\"kind\":1024,\"name\":\"passwd\",\"url\":\"types/database.CreateUserOptions.html#__type.passwd\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.CreateUserOptions.__type\"},{\"kind\":1024,\"name\":\"active\",\"url\":\"types/database.CreateUserOptions.html#__type.active\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.CreateUserOptions.__type\"},{\"kind\":1024,\"name\":\"extra\",\"url\":\"types/database.CreateUserOptions.html#__type.extra\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.CreateUserOptions.__type\"},{\"kind\":4194304,\"name\":\"UserOptions\",\"url\":\"types/database.UserOptions.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"database\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/database.UserOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"database.UserOptions\"},{\"kind\":1024,\"name\":\"passwd\",\"url\":\"types/database.UserOptions.html#__type.passwd\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.UserOptions.__type\"},{\"kind\":1024,\"name\":\"active\",\"url\":\"types/database.UserOptions.html#__type.active\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.UserOptions.__type\"},{\"kind\":1024,\"name\":\"extra\",\"url\":\"types/database.UserOptions.html#__type.extra\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.UserOptions.__type\"},{\"kind\":4194304,\"name\":\"UserAccessLevelOptions\",\"url\":\"types/database.UserAccessLevelOptions.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"database\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/database.UserAccessLevelOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"database.UserAccessLevelOptions\"},{\"kind\":1024,\"name\":\"database\",\"url\":\"types/database.UserAccessLevelOptions.html#__type.database\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.UserAccessLevelOptions.__type\"},{\"kind\":1024,\"name\":\"collection\",\"url\":\"types/database.UserAccessLevelOptions.html#__type.collection\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.UserAccessLevelOptions.__type\"},{\"kind\":4194304,\"name\":\"QueueTimeMetrics\",\"url\":\"types/database.QueueTimeMetrics.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"database\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/database.QueueTimeMetrics.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"database.QueueTimeMetrics\"},{\"kind\":1024,\"name\":\"getLatest\",\"url\":\"types/database.QueueTimeMetrics.html#__type.getLatest\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.QueueTimeMetrics.__type\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/database.QueueTimeMetrics.html#__type.getLatest.__type-3\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-property\",\"parent\":\"database.QueueTimeMetrics.__type.getLatest\"},{\"kind\":1024,\"name\":\"getValues\",\"url\":\"types/database.QueueTimeMetrics.html#__type.getValues\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.QueueTimeMetrics.__type\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/database.QueueTimeMetrics.html#__type.getValues.__type-5\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-property\",\"parent\":\"database.QueueTimeMetrics.__type.getValues\"},{\"kind\":1024,\"name\":\"getAvg\",\"url\":\"types/database.QueueTimeMetrics.html#__type.getAvg\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.QueueTimeMetrics.__type\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/database.QueueTimeMetrics.html#__type.getAvg.__type-1\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-property\",\"parent\":\"database.QueueTimeMetrics.__type.getAvg\"},{\"kind\":4194304,\"name\":\"HotBackupOptions\",\"url\":\"types/database.HotBackupOptions.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"database\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/database.HotBackupOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"database.HotBackupOptions\"},{\"kind\":1024,\"name\":\"allowInconsistent\",\"url\":\"types/database.HotBackupOptions.html#__type.allowInconsistent\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.HotBackupOptions.__type\"},{\"kind\":1024,\"name\":\"force\",\"url\":\"types/database.HotBackupOptions.html#__type.force\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.HotBackupOptions.__type\"},{\"kind\":1024,\"name\":\"label\",\"url\":\"types/database.HotBackupOptions.html#__type.label\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.HotBackupOptions.__type\"},{\"kind\":1024,\"name\":\"timeout\",\"url\":\"types/database.HotBackupOptions.html#__type.timeout\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.HotBackupOptions.__type\"},{\"kind\":4194304,\"name\":\"HotBackupResult\",\"url\":\"types/database.HotBackupResult.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"database\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/database.HotBackupResult.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"database.HotBackupResult\"},{\"kind\":1024,\"name\":\"id\",\"url\":\"types/database.HotBackupResult.html#__type.id\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.HotBackupResult.__type\"},{\"kind\":1024,\"name\":\"potentiallyInconsistent\",\"url\":\"types/database.HotBackupResult.html#__type.potentiallyInconsistent\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.HotBackupResult.__type\"},{\"kind\":1024,\"name\":\"sizeInBytes\",\"url\":\"types/database.HotBackupResult.html#__type.sizeInBytes\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.HotBackupResult.__type\"},{\"kind\":1024,\"name\":\"datetime\",\"url\":\"types/database.HotBackupResult.html#__type.datetime\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.HotBackupResult.__type\"},{\"kind\":1024,\"name\":\"nrDBServers\",\"url\":\"types/database.HotBackupResult.html#__type.nrDBServers\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.HotBackupResult.__type\"},{\"kind\":1024,\"name\":\"nrFiles\",\"url\":\"types/database.HotBackupResult.html#__type.nrFiles\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.HotBackupResult.__type\"},{\"kind\":4194304,\"name\":\"HotBackupList\",\"url\":\"types/database.HotBackupList.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"database\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/database.HotBackupList.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"database.HotBackupList\"},{\"kind\":1024,\"name\":\"server\",\"url\":\"types/database.HotBackupList.html#__type.server\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.HotBackupList.__type\"},{\"kind\":1024,\"name\":\"list\",\"url\":\"types/database.HotBackupList.html#__type.list\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.HotBackupList.__type\"},{\"kind\":8,\"name\":\"LogLevel\",\"url\":\"enums/database.LogLevel.html\",\"classes\":\"tsd-kind-enum tsd-parent-kind-module\",\"parent\":\"database\"},{\"kind\":16,\"name\":\"FATAL\",\"url\":\"enums/database.LogLevel.html#FATAL\",\"classes\":\"tsd-kind-enum-member tsd-parent-kind-enum\",\"parent\":\"database.LogLevel\"},{\"kind\":16,\"name\":\"ERROR\",\"url\":\"enums/database.LogLevel.html#ERROR\",\"classes\":\"tsd-kind-enum-member tsd-parent-kind-enum\",\"parent\":\"database.LogLevel\"},{\"kind\":16,\"name\":\"WARNING\",\"url\":\"enums/database.LogLevel.html#WARNING\",\"classes\":\"tsd-kind-enum-member tsd-parent-kind-enum\",\"parent\":\"database.LogLevel\"},{\"kind\":16,\"name\":\"INFO\",\"url\":\"enums/database.LogLevel.html#INFO\",\"classes\":\"tsd-kind-enum-member tsd-parent-kind-enum\",\"parent\":\"database.LogLevel\"},{\"kind\":16,\"name\":\"DEBUG\",\"url\":\"enums/database.LogLevel.html#DEBUG\",\"classes\":\"tsd-kind-enum-member tsd-parent-kind-enum\",\"parent\":\"database.LogLevel\"},{\"kind\":4194304,\"name\":\"LogLevelLabel\",\"url\":\"types/database.LogLevelLabel.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"database\"},{\"kind\":4194304,\"name\":\"LogLevelSetting\",\"url\":\"types/database.LogLevelSetting.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"database\"},{\"kind\":4194304,\"name\":\"LogSortDirection\",\"url\":\"types/database.LogSortDirection.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"database\"},{\"kind\":4194304,\"name\":\"LogEntriesOptions\",\"url\":\"types/database.LogEntriesOptions.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"database\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/database.LogEntriesOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"database.LogEntriesOptions\"},{\"kind\":1024,\"name\":\"upto\",\"url\":\"types/database.LogEntriesOptions.html#__type.upto\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.LogEntriesOptions.__type\"},{\"kind\":1024,\"name\":\"level\",\"url\":\"types/database.LogEntriesOptions.html#__type.level\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.LogEntriesOptions.__type\"},{\"kind\":1024,\"name\":\"start\",\"url\":\"types/database.LogEntriesOptions.html#__type.start\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.LogEntriesOptions.__type\"},{\"kind\":1024,\"name\":\"size\",\"url\":\"types/database.LogEntriesOptions.html#__type.size\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.LogEntriesOptions.__type\"},{\"kind\":1024,\"name\":\"offset\",\"url\":\"types/database.LogEntriesOptions.html#__type.offset\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.LogEntriesOptions.__type\"},{\"kind\":1024,\"name\":\"search\",\"url\":\"types/database.LogEntriesOptions.html#__type.search\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.LogEntriesOptions.__type\"},{\"kind\":1024,\"name\":\"sort\",\"url\":\"types/database.LogEntriesOptions.html#__type.sort\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.LogEntriesOptions.__type\"},{\"kind\":4194304,\"name\":\"LogMessage\",\"url\":\"types/database.LogMessage.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"database\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/database.LogMessage.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"database.LogMessage\"},{\"kind\":1024,\"name\":\"id\",\"url\":\"types/database.LogMessage.html#__type.id\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.LogMessage.__type\"},{\"kind\":1024,\"name\":\"topic\",\"url\":\"types/database.LogMessage.html#__type.topic\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.LogMessage.__type\"},{\"kind\":1024,\"name\":\"level\",\"url\":\"types/database.LogMessage.html#__type.level\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.LogMessage.__type\"},{\"kind\":1024,\"name\":\"date\",\"url\":\"types/database.LogMessage.html#__type.date\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.LogMessage.__type\"},{\"kind\":1024,\"name\":\"message\",\"url\":\"types/database.LogMessage.html#__type.message\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.LogMessage.__type\"},{\"kind\":4194304,\"name\":\"LogEntries\",\"url\":\"types/database.LogEntries.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"database\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/database.LogEntries.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"database.LogEntries\"},{\"kind\":1024,\"name\":\"totalAmount\",\"url\":\"types/database.LogEntries.html#__type.totalAmount\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.LogEntries.__type\"},{\"kind\":1024,\"name\":\"lid\",\"url\":\"types/database.LogEntries.html#__type.lid\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.LogEntries.__type\"},{\"kind\":1024,\"name\":\"topic\",\"url\":\"types/database.LogEntries.html#__type.topic\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.LogEntries.__type\"},{\"kind\":1024,\"name\":\"level\",\"url\":\"types/database.LogEntries.html#__type.level\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.LogEntries.__type\"},{\"kind\":1024,\"name\":\"timestamp\",\"url\":\"types/database.LogEntries.html#__type.timestamp\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.LogEntries.__type\"},{\"kind\":1024,\"name\":\"text\",\"url\":\"types/database.LogEntries.html#__type.text\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"database.LogEntries.__type\"},{\"kind\":128,\"name\":\"Database\",\"url\":\"classes/database.Database.html\",\"classes\":\"tsd-kind-class tsd-parent-kind-module\",\"parent\":\"database\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/database.Database.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":262144,\"name\":\"name\",\"url\":\"classes/database.Database.html#name\",\"classes\":\"tsd-kind-accessor tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"version\",\"url\":\"classes/database.Database.html#version\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"time\",\"url\":\"classes/database.Database.html#time\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"route\",\"url\":\"classes/database.Database.html#route\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"createJob\",\"url\":\"classes/database.Database.html#createJob\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"acquireHostList\",\"url\":\"classes/database.Database.html#acquireHostList\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"close\",\"url\":\"classes/database.Database.html#close\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"shutdown\",\"url\":\"classes/database.Database.html#shutdown\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"waitForPropagation\",\"url\":\"classes/database.Database.html#waitForPropagation\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":262144,\"name\":\"queueTime\",\"url\":\"classes/database.Database.html#queueTime\",\"classes\":\"tsd-kind-accessor tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"setResponseQueueTimeSamples\",\"url\":\"classes/database.Database.html#setResponseQueueTimeSamples\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"useBasicAuth\",\"url\":\"classes/database.Database.html#useBasicAuth\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"useBearerAuth\",\"url\":\"classes/database.Database.html#useBearerAuth\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"login\",\"url\":\"classes/database.Database.html#login\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"renewAuthToken\",\"url\":\"classes/database.Database.html#renewAuthToken\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"getClusterImbalance\",\"url\":\"classes/database.Database.html#getClusterImbalance\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"computeClusterRebalance\",\"url\":\"classes/database.Database.html#computeClusterRebalance\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"executeClusterRebalance\",\"url\":\"classes/database.Database.html#executeClusterRebalance\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"rebalanceCluster\",\"url\":\"classes/database.Database.html#rebalanceCluster\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"database\",\"url\":\"classes/database.Database.html#database\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"get\",\"url\":\"classes/database.Database.html#get\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"exists\",\"url\":\"classes/database.Database.html#exists\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"createDatabase\",\"url\":\"classes/database.Database.html#createDatabase\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"listDatabases\",\"url\":\"classes/database.Database.html#listDatabases\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"listUserDatabases\",\"url\":\"classes/database.Database.html#listUserDatabases\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"databases\",\"url\":\"classes/database.Database.html#databases\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"userDatabases\",\"url\":\"classes/database.Database.html#userDatabases\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"dropDatabase\",\"url\":\"classes/database.Database.html#dropDatabase\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"collection\",\"url\":\"classes/database.Database.html#collection\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"createCollection\",\"url\":\"classes/database.Database.html#createCollection\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"createEdgeCollection\",\"url\":\"classes/database.Database.html#createEdgeCollection\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"renameCollection\",\"url\":\"classes/database.Database.html#renameCollection\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"listCollections\",\"url\":\"classes/database.Database.html#listCollections\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"collections\",\"url\":\"classes/database.Database.html#collections\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"graph\",\"url\":\"classes/database.Database.html#graph\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"createGraph\",\"url\":\"classes/database.Database.html#createGraph\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"listGraphs\",\"url\":\"classes/database.Database.html#listGraphs\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"graphs\",\"url\":\"classes/database.Database.html#graphs\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"view\",\"url\":\"classes/database.Database.html#view\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"createView\",\"url\":\"classes/database.Database.html#createView\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"renameView\",\"url\":\"classes/database.Database.html#renameView\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"listViews\",\"url\":\"classes/database.Database.html#listViews\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"views\",\"url\":\"classes/database.Database.html#views\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"analyzer\",\"url\":\"classes/database.Database.html#analyzer\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"createAnalyzer\",\"url\":\"classes/database.Database.html#createAnalyzer\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"listAnalyzers\",\"url\":\"classes/database.Database.html#listAnalyzers\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"analyzers\",\"url\":\"classes/database.Database.html#analyzers\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"listUsers\",\"url\":\"classes/database.Database.html#listUsers\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"getUser\",\"url\":\"classes/database.Database.html#getUser\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"createUser\",\"url\":\"classes/database.Database.html#createUser\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"updateUser\",\"url\":\"classes/database.Database.html#updateUser\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"replaceUser\",\"url\":\"classes/database.Database.html#replaceUser\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"removeUser\",\"url\":\"classes/database.Database.html#removeUser\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"getUserAccessLevel\",\"url\":\"classes/database.Database.html#getUserAccessLevel\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"setUserAccessLevel\",\"url\":\"classes/database.Database.html#setUserAccessLevel\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"clearUserAccessLevel\",\"url\":\"classes/database.Database.html#clearUserAccessLevel\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"getUserDatabases\",\"url\":\"classes/database.Database.html#getUserDatabases\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"executeTransaction\",\"url\":\"classes/database.Database.html#executeTransaction\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"transaction\",\"url\":\"classes/database.Database.html#transaction\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"beginTransaction\",\"url\":\"classes/database.Database.html#beginTransaction\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"withTransaction\",\"url\":\"classes/database.Database.html#withTransaction\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"listTransactions\",\"url\":\"classes/database.Database.html#listTransactions\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"transactions\",\"url\":\"classes/database.Database.html#transactions\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"query\",\"url\":\"classes/database.Database.html#query\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"explain\",\"url\":\"classes/database.Database.html#explain\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"parse\",\"url\":\"classes/database.Database.html#parse\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"queryRules\",\"url\":\"classes/database.Database.html#queryRules\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"queryTracking\",\"url\":\"classes/database.Database.html#queryTracking\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"listRunningQueries\",\"url\":\"classes/database.Database.html#listRunningQueries\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"listSlowQueries\",\"url\":\"classes/database.Database.html#listSlowQueries\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"clearSlowQueries\",\"url\":\"classes/database.Database.html#clearSlowQueries\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"killQuery\",\"url\":\"classes/database.Database.html#killQuery\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"listFunctions\",\"url\":\"classes/database.Database.html#listFunctions\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"createFunction\",\"url\":\"classes/database.Database.html#createFunction\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"dropFunction\",\"url\":\"classes/database.Database.html#dropFunction\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"listServices\",\"url\":\"classes/database.Database.html#listServices\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"installService\",\"url\":\"classes/database.Database.html#installService\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"replaceService\",\"url\":\"classes/database.Database.html#replaceService\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"upgradeService\",\"url\":\"classes/database.Database.html#upgradeService\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"uninstallService\",\"url\":\"classes/database.Database.html#uninstallService\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"getService\",\"url\":\"classes/database.Database.html#getService\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"getServiceConfiguration\",\"url\":\"classes/database.Database.html#getServiceConfiguration\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"replaceServiceConfiguration\",\"url\":\"classes/database.Database.html#replaceServiceConfiguration\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"updateServiceConfiguration\",\"url\":\"classes/database.Database.html#updateServiceConfiguration\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"getServiceDependencies\",\"url\":\"classes/database.Database.html#getServiceDependencies\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"replaceServiceDependencies\",\"url\":\"classes/database.Database.html#replaceServiceDependencies\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"updateServiceDependencies\",\"url\":\"classes/database.Database.html#updateServiceDependencies\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"setServiceDevelopmentMode\",\"url\":\"classes/database.Database.html#setServiceDevelopmentMode\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"listServiceScripts\",\"url\":\"classes/database.Database.html#listServiceScripts\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"runServiceScript\",\"url\":\"classes/database.Database.html#runServiceScript\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"runServiceTests\",\"url\":\"classes/database.Database.html#runServiceTests\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"getServiceReadme\",\"url\":\"classes/database.Database.html#getServiceReadme\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"getServiceDocumentation\",\"url\":\"classes/database.Database.html#getServiceDocumentation\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"downloadService\",\"url\":\"classes/database.Database.html#downloadService\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"commitLocalServiceState\",\"url\":\"classes/database.Database.html#commitLocalServiceState\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"createHotBackup\",\"url\":\"classes/database.Database.html#createHotBackup\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"listHotBackups\",\"url\":\"classes/database.Database.html#listHotBackups\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"restoreHotBackup\",\"url\":\"classes/database.Database.html#restoreHotBackup\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"deleteHotBackup\",\"url\":\"classes/database.Database.html#deleteHotBackup\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"getLogEntries\",\"url\":\"classes/database.Database.html#getLogEntries\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"getLogMessages\",\"url\":\"classes/database.Database.html#getLogMessages\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"getLogLevel\",\"url\":\"classes/database.Database.html#getLogLevel\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"setLogLevel\",\"url\":\"classes/database.Database.html#setLogLevel\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"job\",\"url\":\"classes/database.Database.html#job\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"listPendingJobs\",\"url\":\"classes/database.Database.html#listPendingJobs\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"listCompletedJobs\",\"url\":\"classes/database.Database.html#listCompletedJobs\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"deleteExpiredJobResults\",\"url\":\"classes/database.Database.html#deleteExpiredJobResults\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2048,\"name\":\"deleteAllJobResults\",\"url\":\"classes/database.Database.html#deleteAllJobResults\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"database.Database\"},{\"kind\":2,\"name\":\"documents\",\"url\":\"modules/documents.html\",\"classes\":\"tsd-kind-module\"},{\"kind\":4194304,\"name\":\"DocumentMetadata\",\"url\":\"types/documents.DocumentMetadata.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"documents\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/documents.DocumentMetadata.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"documents.DocumentMetadata\"},{\"kind\":1024,\"name\":\"_key\",\"url\":\"types/documents.DocumentMetadata.html#__type._key\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"documents.DocumentMetadata.__type\"},{\"kind\":1024,\"name\":\"_id\",\"url\":\"types/documents.DocumentMetadata.html#__type._id\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"documents.DocumentMetadata.__type\"},{\"kind\":1024,\"name\":\"_rev\",\"url\":\"types/documents.DocumentMetadata.html#__type._rev\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"documents.DocumentMetadata.__type\"},{\"kind\":4194304,\"name\":\"EdgeMetadata\",\"url\":\"types/documents.EdgeMetadata.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"documents\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/documents.EdgeMetadata.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"documents.EdgeMetadata\"},{\"kind\":1024,\"name\":\"_from\",\"url\":\"types/documents.EdgeMetadata.html#__type._from\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"documents.EdgeMetadata.__type\"},{\"kind\":1024,\"name\":\"_to\",\"url\":\"types/documents.EdgeMetadata.html#__type._to\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"documents.EdgeMetadata.__type\"},{\"kind\":4194304,\"name\":\"DocumentData\",\"url\":\"types/documents.DocumentData.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"documents\"},{\"kind\":4194304,\"name\":\"EdgeData\",\"url\":\"types/documents.EdgeData.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"documents\"},{\"kind\":4194304,\"name\":\"Document\",\"url\":\"types/documents.Document.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"documents\"},{\"kind\":4194304,\"name\":\"Edge\",\"url\":\"types/documents.Edge.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"documents\"},{\"kind\":4194304,\"name\":\"Patch\",\"url\":\"types/documents.Patch.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"documents\"},{\"kind\":4194304,\"name\":\"ObjectWithId\",\"url\":\"types/documents.ObjectWithId.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"documents\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/documents.ObjectWithId.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"documents.ObjectWithId\"},{\"kind\":1024,\"name\":\"_id\",\"url\":\"types/documents.ObjectWithId.html#__type._id\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"documents.ObjectWithId.__type\"},{\"kind\":4194304,\"name\":\"ObjectWithKey\",\"url\":\"types/documents.ObjectWithKey.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"documents\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/documents.ObjectWithKey.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"documents.ObjectWithKey\"},{\"kind\":1024,\"name\":\"_key\",\"url\":\"types/documents.ObjectWithKey.html#__type._key\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"documents.ObjectWithKey.__type\"},{\"kind\":4194304,\"name\":\"DocumentSelector\",\"url\":\"types/documents.DocumentSelector.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"documents\"},{\"kind\":2,\"name\":\"error\",\"url\":\"modules/error.html\",\"classes\":\"tsd-kind-module\"},{\"kind\":64,\"name\":\"isArangoError\",\"url\":\"functions/error.isArangoError.html\",\"classes\":\"tsd-kind-function tsd-parent-kind-module\",\"parent\":\"error\"},{\"kind\":64,\"name\":\"isSystemError\",\"url\":\"functions/error.isSystemError.html\",\"classes\":\"tsd-kind-function tsd-parent-kind-module\",\"parent\":\"error\"},{\"kind\":256,\"name\":\"SystemError\",\"url\":\"interfaces/error.SystemError.html\",\"classes\":\"tsd-kind-interface tsd-parent-kind-module\",\"parent\":\"error\"},{\"kind\":1024,\"name\":\"code\",\"url\":\"interfaces/error.SystemError.html#code\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"error.SystemError\"},{\"kind\":1024,\"name\":\"errno\",\"url\":\"interfaces/error.SystemError.html#errno\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"error.SystemError\"},{\"kind\":1024,\"name\":\"syscall\",\"url\":\"interfaces/error.SystemError.html#syscall\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"error.SystemError\"},{\"kind\":128,\"name\":\"ArangoError\",\"url\":\"classes/error.ArangoError.html\",\"classes\":\"tsd-kind-class tsd-parent-kind-module\",\"parent\":\"error\"},{\"kind\":1024,\"name\":\"name\",\"url\":\"classes/error.ArangoError.html#name\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"error.ArangoError\"},{\"kind\":1024,\"name\":\"errorNum\",\"url\":\"classes/error.ArangoError.html#errorNum\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"error.ArangoError\"},{\"kind\":1024,\"name\":\"code\",\"url\":\"classes/error.ArangoError.html#code\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"error.ArangoError\"},{\"kind\":1024,\"name\":\"response\",\"url\":\"classes/error.ArangoError.html#response\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"error.ArangoError\"},{\"kind\":2048,\"name\":\"toJSON\",\"url\":\"classes/error.ArangoError.html#toJSON\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"error.ArangoError\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"classes/error.ArangoError.html#toJSON.toJSON-1.__type-2\",\"classes\":\"tsd-kind-type-literal\",\"parent\":\"error.ArangoError.toJSON.toJSON\"},{\"kind\":1024,\"name\":\"error\",\"url\":\"classes/error.ArangoError.html#toJSON.toJSON-1.__type-2.error\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"error.ArangoError.toJSON.toJSON.__type\"},{\"kind\":1024,\"name\":\"errorMessage\",\"url\":\"classes/error.ArangoError.html#toJSON.toJSON-1.__type-2.errorMessage\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"error.ArangoError.toJSON.toJSON.__type\"},{\"kind\":1024,\"name\":\"errorNum\",\"url\":\"classes/error.ArangoError.html#toJSON.toJSON-1.__type-2.errorNum-1\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"error.ArangoError.toJSON.toJSON.__type\"},{\"kind\":1024,\"name\":\"code\",\"url\":\"classes/error.ArangoError.html#toJSON.toJSON-1.__type-2.code-1\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"error.ArangoError.toJSON.toJSON.__type\"},{\"kind\":128,\"name\":\"HttpError\",\"url\":\"classes/error.HttpError.html\",\"classes\":\"tsd-kind-class tsd-parent-kind-module\",\"parent\":\"error\"},{\"kind\":1024,\"name\":\"name\",\"url\":\"classes/error.HttpError.html#name\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"error.HttpError\"},{\"kind\":1024,\"name\":\"response\",\"url\":\"classes/error.HttpError.html#response\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"error.HttpError\"},{\"kind\":1024,\"name\":\"code\",\"url\":\"classes/error.HttpError.html#code\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"error.HttpError\"},{\"kind\":2048,\"name\":\"toJSON\",\"url\":\"classes/error.HttpError.html#toJSON\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"error.HttpError\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"classes/error.HttpError.html#toJSON.toJSON-1.__type-2\",\"classes\":\"tsd-kind-type-literal\",\"parent\":\"error.HttpError.toJSON.toJSON\"},{\"kind\":1024,\"name\":\"error\",\"url\":\"classes/error.HttpError.html#toJSON.toJSON-1.__type-2.error\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"error.HttpError.toJSON.toJSON.__type\"},{\"kind\":1024,\"name\":\"code\",\"url\":\"classes/error.HttpError.html#toJSON.toJSON-1.__type-2.code-1\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"error.HttpError.toJSON.toJSON.__type\"},{\"kind\":2,\"name\":\"foxx-manifest\",\"url\":\"modules/foxx_manifest.html\",\"classes\":\"tsd-kind-module\"},{\"kind\":4194304,\"name\":\"FoxxManifest\",\"url\":\"types/foxx_manifest.FoxxManifest.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"foxx-manifest\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/foxx_manifest.FoxxManifest.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"foxx-manifest.FoxxManifest\"},{\"kind\":1024,\"name\":\"configuration\",\"url\":\"types/foxx_manifest.FoxxManifest.html#__type.configuration\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"foxx-manifest.FoxxManifest.__type\"},{\"kind\":1024,\"name\":\"defaultDocument\",\"url\":\"types/foxx_manifest.FoxxManifest.html#__type.defaultDocument\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"foxx-manifest.FoxxManifest.__type\"},{\"kind\":1024,\"name\":\"dependencies\",\"url\":\"types/foxx_manifest.FoxxManifest.html#__type.dependencies\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"foxx-manifest.FoxxManifest.__type\"},{\"kind\":1024,\"name\":\"provides\",\"url\":\"types/foxx_manifest.FoxxManifest.html#__type.provides\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"foxx-manifest.FoxxManifest.__type\"},{\"kind\":1024,\"name\":\"engines\",\"url\":\"types/foxx_manifest.FoxxManifest.html#__type.engines\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"foxx-manifest.FoxxManifest.__type\"},{\"kind\":1024,\"name\":\"files\",\"url\":\"types/foxx_manifest.FoxxManifest.html#__type.files\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"foxx-manifest.FoxxManifest.__type\"},{\"kind\":1024,\"name\":\"lib\",\"url\":\"types/foxx_manifest.FoxxManifest.html#__type.lib\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"foxx-manifest.FoxxManifest.__type\"},{\"kind\":1024,\"name\":\"main\",\"url\":\"types/foxx_manifest.FoxxManifest.html#__type.main\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"foxx-manifest.FoxxManifest.__type\"},{\"kind\":1024,\"name\":\"scripts\",\"url\":\"types/foxx_manifest.FoxxManifest.html#__type.scripts\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"foxx-manifest.FoxxManifest.__type\"},{\"kind\":1024,\"name\":\"tests\",\"url\":\"types/foxx_manifest.FoxxManifest.html#__type.tests\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"foxx-manifest.FoxxManifest.__type\"},{\"kind\":1024,\"name\":\"author\",\"url\":\"types/foxx_manifest.FoxxManifest.html#__type.author\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"foxx-manifest.FoxxManifest.__type\"},{\"kind\":1024,\"name\":\"contributors\",\"url\":\"types/foxx_manifest.FoxxManifest.html#__type.contributors\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"foxx-manifest.FoxxManifest.__type\"},{\"kind\":1024,\"name\":\"description\",\"url\":\"types/foxx_manifest.FoxxManifest.html#__type.description\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"foxx-manifest.FoxxManifest.__type\"},{\"kind\":1024,\"name\":\"keywords\",\"url\":\"types/foxx_manifest.FoxxManifest.html#__type.keywords\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"foxx-manifest.FoxxManifest.__type\"},{\"kind\":1024,\"name\":\"license\",\"url\":\"types/foxx_manifest.FoxxManifest.html#__type.license\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"foxx-manifest.FoxxManifest.__type\"},{\"kind\":1024,\"name\":\"name\",\"url\":\"types/foxx_manifest.FoxxManifest.html#__type.name\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"foxx-manifest.FoxxManifest.__type\"},{\"kind\":1024,\"name\":\"thumbnail\",\"url\":\"types/foxx_manifest.FoxxManifest.html#__type.thumbnail\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"foxx-manifest.FoxxManifest.__type\"},{\"kind\":1024,\"name\":\"version\",\"url\":\"types/foxx_manifest.FoxxManifest.html#__type.version\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"foxx-manifest.FoxxManifest.__type\"},{\"kind\":4194304,\"name\":\"Configuration\",\"url\":\"types/foxx_manifest.Configuration.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"foxx-manifest\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/foxx_manifest.Configuration.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"foxx-manifest.Configuration\"},{\"kind\":1024,\"name\":\"description\",\"url\":\"types/foxx_manifest.Configuration.html#__type.description\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"foxx-manifest.Configuration.__type\"},{\"kind\":1024,\"name\":\"type\",\"url\":\"types/foxx_manifest.Configuration.html#__type.type\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"foxx-manifest.Configuration.__type\"},{\"kind\":1024,\"name\":\"default\",\"url\":\"types/foxx_manifest.Configuration.html#__type.default\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"foxx-manifest.Configuration.__type\"},{\"kind\":1024,\"name\":\"required\",\"url\":\"types/foxx_manifest.Configuration.html#__type.required\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"foxx-manifest.Configuration.__type\"},{\"kind\":4194304,\"name\":\"Dependency\",\"url\":\"types/foxx_manifest.Dependency.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"foxx-manifest\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/foxx_manifest.Dependency.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"foxx-manifest.Dependency\"},{\"kind\":1024,\"name\":\"name\",\"url\":\"types/foxx_manifest.Dependency.html#__type.name\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"foxx-manifest.Dependency.__type\"},{\"kind\":1024,\"name\":\"version\",\"url\":\"types/foxx_manifest.Dependency.html#__type.version\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"foxx-manifest.Dependency.__type\"},{\"kind\":1024,\"name\":\"description\",\"url\":\"types/foxx_manifest.Dependency.html#__type.description\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"foxx-manifest.Dependency.__type\"},{\"kind\":1024,\"name\":\"required\",\"url\":\"types/foxx_manifest.Dependency.html#__type.required\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"foxx-manifest.Dependency.__type\"},{\"kind\":1024,\"name\":\"multiple\",\"url\":\"types/foxx_manifest.Dependency.html#__type.multiple\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"foxx-manifest.Dependency.__type\"},{\"kind\":4194304,\"name\":\"File\",\"url\":\"types/foxx_manifest.File.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"foxx-manifest\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/foxx_manifest.File.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"foxx-manifest.File\"},{\"kind\":1024,\"name\":\"path\",\"url\":\"types/foxx_manifest.File.html#__type.path\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"foxx-manifest.File.__type\"},{\"kind\":1024,\"name\":\"gzip\",\"url\":\"types/foxx_manifest.File.html#__type.gzip\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"foxx-manifest.File.__type\"},{\"kind\":1024,\"name\":\"type\",\"url\":\"types/foxx_manifest.File.html#__type.type\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"foxx-manifest.File.__type\"},{\"kind\":2,\"name\":\"graph\",\"url\":\"modules/graph.html\",\"classes\":\"tsd-kind-module\"},{\"kind\":64,\"name\":\"isArangoGraph\",\"url\":\"functions/graph.isArangoGraph.html\",\"classes\":\"tsd-kind-function tsd-parent-kind-module\",\"parent\":\"graph\"},{\"kind\":4194304,\"name\":\"GraphCollectionReadOptions\",\"url\":\"types/graph.GraphCollectionReadOptions.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"graph\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/graph.GraphCollectionReadOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"graph.GraphCollectionReadOptions\"},{\"kind\":1024,\"name\":\"rev\",\"url\":\"types/graph.GraphCollectionReadOptions.html#__type.rev\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"graph.GraphCollectionReadOptions.__type\"},{\"kind\":1024,\"name\":\"graceful\",\"url\":\"types/graph.GraphCollectionReadOptions.html#__type.graceful\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"graph.GraphCollectionReadOptions.__type\"},{\"kind\":1024,\"name\":\"allowDirtyRead\",\"url\":\"types/graph.GraphCollectionReadOptions.html#__type.allowDirtyRead\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"graph.GraphCollectionReadOptions.__type\"},{\"kind\":4194304,\"name\":\"GraphCollectionInsertOptions\",\"url\":\"types/graph.GraphCollectionInsertOptions.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"graph\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/graph.GraphCollectionInsertOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"graph.GraphCollectionInsertOptions\"},{\"kind\":1024,\"name\":\"waitForSync\",\"url\":\"types/graph.GraphCollectionInsertOptions.html#__type.waitForSync\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"graph.GraphCollectionInsertOptions.__type\"},{\"kind\":1024,\"name\":\"returnNew\",\"url\":\"types/graph.GraphCollectionInsertOptions.html#__type.returnNew\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"graph.GraphCollectionInsertOptions.__type\"},{\"kind\":4194304,\"name\":\"GraphCollectionReplaceOptions\",\"url\":\"types/graph.GraphCollectionReplaceOptions.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"graph\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/graph.GraphCollectionReplaceOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"graph.GraphCollectionReplaceOptions\"},{\"kind\":1024,\"name\":\"rev\",\"url\":\"types/graph.GraphCollectionReplaceOptions.html#__type.rev\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"graph.GraphCollectionReplaceOptions.__type\"},{\"kind\":1024,\"name\":\"waitForSync\",\"url\":\"types/graph.GraphCollectionReplaceOptions.html#__type.waitForSync\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"graph.GraphCollectionReplaceOptions.__type\"},{\"kind\":1024,\"name\":\"keepNull\",\"url\":\"types/graph.GraphCollectionReplaceOptions.html#__type.keepNull\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"graph.GraphCollectionReplaceOptions.__type\"},{\"kind\":1024,\"name\":\"returnOld\",\"url\":\"types/graph.GraphCollectionReplaceOptions.html#__type.returnOld\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"graph.GraphCollectionReplaceOptions.__type\"},{\"kind\":1024,\"name\":\"returnNew\",\"url\":\"types/graph.GraphCollectionReplaceOptions.html#__type.returnNew\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"graph.GraphCollectionReplaceOptions.__type\"},{\"kind\":4194304,\"name\":\"GraphCollectionRemoveOptions\",\"url\":\"types/graph.GraphCollectionRemoveOptions.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"graph\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/graph.GraphCollectionRemoveOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"graph.GraphCollectionRemoveOptions\"},{\"kind\":1024,\"name\":\"rev\",\"url\":\"types/graph.GraphCollectionRemoveOptions.html#__type.rev\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"graph.GraphCollectionRemoveOptions.__type\"},{\"kind\":1024,\"name\":\"waitForSync\",\"url\":\"types/graph.GraphCollectionRemoveOptions.html#__type.waitForSync\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"graph.GraphCollectionRemoveOptions.__type\"},{\"kind\":1024,\"name\":\"returnOld\",\"url\":\"types/graph.GraphCollectionRemoveOptions.html#__type.returnOld\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"graph.GraphCollectionRemoveOptions.__type\"},{\"kind\":4194304,\"name\":\"EdgeDefinition\",\"url\":\"types/graph.EdgeDefinition.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"graph\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/graph.EdgeDefinition.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"graph.EdgeDefinition\"},{\"kind\":1024,\"name\":\"collection\",\"url\":\"types/graph.EdgeDefinition.html#__type.collection\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"graph.EdgeDefinition.__type\"},{\"kind\":1024,\"name\":\"from\",\"url\":\"types/graph.EdgeDefinition.html#__type.from\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"graph.EdgeDefinition.__type\"},{\"kind\":1024,\"name\":\"to\",\"url\":\"types/graph.EdgeDefinition.html#__type.to\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"graph.EdgeDefinition.__type\"},{\"kind\":4194304,\"name\":\"EdgeDefinitionOptions\",\"url\":\"types/graph.EdgeDefinitionOptions.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"graph\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/graph.EdgeDefinitionOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"graph.EdgeDefinitionOptions\"},{\"kind\":1024,\"name\":\"collection\",\"url\":\"types/graph.EdgeDefinitionOptions.html#__type.collection\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"graph.EdgeDefinitionOptions.__type\"},{\"kind\":1024,\"name\":\"from\",\"url\":\"types/graph.EdgeDefinitionOptions.html#__type.from\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"graph.EdgeDefinitionOptions.__type\"},{\"kind\":1024,\"name\":\"to\",\"url\":\"types/graph.EdgeDefinitionOptions.html#__type.to\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"graph.EdgeDefinitionOptions.__type\"},{\"kind\":4194304,\"name\":\"GraphInfo\",\"url\":\"types/graph.GraphInfo.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"graph\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/graph.GraphInfo.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"graph.GraphInfo\"},{\"kind\":1024,\"name\":\"name\",\"url\":\"types/graph.GraphInfo.html#__type.name\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"graph.GraphInfo.__type\"},{\"kind\":1024,\"name\":\"edgeDefinitions\",\"url\":\"types/graph.GraphInfo.html#__type.edgeDefinitions\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"graph.GraphInfo.__type\"},{\"kind\":1024,\"name\":\"orphanCollections\",\"url\":\"types/graph.GraphInfo.html#__type.orphanCollections\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"graph.GraphInfo.__type\"},{\"kind\":1024,\"name\":\"numberOfShards\",\"url\":\"types/graph.GraphInfo.html#__type.numberOfShards\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"graph.GraphInfo.__type\"},{\"kind\":1024,\"name\":\"replicationFactor\",\"url\":\"types/graph.GraphInfo.html#__type.replicationFactor\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"graph.GraphInfo.__type\"},{\"kind\":1024,\"name\":\"writeConcern\",\"url\":\"types/graph.GraphInfo.html#__type.writeConcern\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"graph.GraphInfo.__type\"},{\"kind\":1024,\"name\":\"isSatellite\",\"url\":\"types/graph.GraphInfo.html#__type.isSatellite\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"graph.GraphInfo.__type\"},{\"kind\":1024,\"name\":\"isSmart\",\"url\":\"types/graph.GraphInfo.html#__type.isSmart\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"graph.GraphInfo.__type\"},{\"kind\":1024,\"name\":\"smartGraphAttribute\",\"url\":\"types/graph.GraphInfo.html#__type.smartGraphAttribute\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"graph.GraphInfo.__type\"},{\"kind\":1024,\"name\":\"isDisjoint\",\"url\":\"types/graph.GraphInfo.html#__type.isDisjoint\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"graph.GraphInfo.__type\"},{\"kind\":4194304,\"name\":\"CreateGraphOptions\",\"url\":\"types/graph.CreateGraphOptions.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"graph\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/graph.CreateGraphOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"graph.CreateGraphOptions\"},{\"kind\":1024,\"name\":\"waitForSync\",\"url\":\"types/graph.CreateGraphOptions.html#__type.waitForSync\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"graph.CreateGraphOptions.__type\"},{\"kind\":1024,\"name\":\"orphanCollections\",\"url\":\"types/graph.CreateGraphOptions.html#__type.orphanCollections\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"graph.CreateGraphOptions.__type\"},{\"kind\":1024,\"name\":\"numberOfShards\",\"url\":\"types/graph.CreateGraphOptions.html#__type.numberOfShards\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"graph.CreateGraphOptions.__type\"},{\"kind\":1024,\"name\":\"replicationFactor\",\"url\":\"types/graph.CreateGraphOptions.html#__type.replicationFactor\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"graph.CreateGraphOptions.__type\"},{\"kind\":1024,\"name\":\"writeConcern\",\"url\":\"types/graph.CreateGraphOptions.html#__type.writeConcern\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"graph.CreateGraphOptions.__type\"},{\"kind\":1024,\"name\":\"isSmart\",\"url\":\"types/graph.CreateGraphOptions.html#__type.isSmart\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"graph.CreateGraphOptions.__type\"},{\"kind\":1024,\"name\":\"smartGraphAttribute\",\"url\":\"types/graph.CreateGraphOptions.html#__type.smartGraphAttribute\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"graph.CreateGraphOptions.__type\"},{\"kind\":1024,\"name\":\"isDisjoint\",\"url\":\"types/graph.CreateGraphOptions.html#__type.isDisjoint\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"graph.CreateGraphOptions.__type\"},{\"kind\":1024,\"name\":\"satellites\",\"url\":\"types/graph.CreateGraphOptions.html#__type.satellites\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"graph.CreateGraphOptions.__type\"},{\"kind\":4194304,\"name\":\"AddVertexCollectionOptions\",\"url\":\"types/graph.AddVertexCollectionOptions.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"graph\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/graph.AddVertexCollectionOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"graph.AddVertexCollectionOptions\"},{\"kind\":1024,\"name\":\"satellites\",\"url\":\"types/graph.AddVertexCollectionOptions.html#__type.satellites\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"graph.AddVertexCollectionOptions.__type\"},{\"kind\":4194304,\"name\":\"AddEdgeDefinitionOptions\",\"url\":\"types/graph.AddEdgeDefinitionOptions.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"graph\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/graph.AddEdgeDefinitionOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"graph.AddEdgeDefinitionOptions\"},{\"kind\":1024,\"name\":\"satellites\",\"url\":\"types/graph.AddEdgeDefinitionOptions.html#__type.satellites\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"graph.AddEdgeDefinitionOptions.__type\"},{\"kind\":4194304,\"name\":\"ReplaceEdgeDefinitionOptions\",\"url\":\"types/graph.ReplaceEdgeDefinitionOptions.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"graph\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/graph.ReplaceEdgeDefinitionOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"graph.ReplaceEdgeDefinitionOptions\"},{\"kind\":1024,\"name\":\"satellites\",\"url\":\"types/graph.ReplaceEdgeDefinitionOptions.html#__type.satellites\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"graph.ReplaceEdgeDefinitionOptions.__type\"},{\"kind\":128,\"name\":\"GraphVertexCollection\",\"url\":\"classes/graph.GraphVertexCollection.html\",\"classes\":\"tsd-kind-class tsd-parent-kind-module\",\"parent\":\"graph\"},{\"kind\":262144,\"name\":\"name\",\"url\":\"classes/graph.GraphVertexCollection.html#name\",\"classes\":\"tsd-kind-accessor tsd-parent-kind-class\",\"parent\":\"graph.GraphVertexCollection\"},{\"kind\":262144,\"name\":\"collection\",\"url\":\"classes/graph.GraphVertexCollection.html#collection\",\"classes\":\"tsd-kind-accessor tsd-parent-kind-class\",\"parent\":\"graph.GraphVertexCollection\"},{\"kind\":262144,\"name\":\"graph\",\"url\":\"classes/graph.GraphVertexCollection.html#graph\",\"classes\":\"tsd-kind-accessor tsd-parent-kind-class\",\"parent\":\"graph.GraphVertexCollection\"},{\"kind\":2048,\"name\":\"vertexExists\",\"url\":\"classes/graph.GraphVertexCollection.html#vertexExists\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"graph.GraphVertexCollection\"},{\"kind\":2048,\"name\":\"vertex\",\"url\":\"classes/graph.GraphVertexCollection.html#vertex\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"graph.GraphVertexCollection\"},{\"kind\":2048,\"name\":\"save\",\"url\":\"classes/graph.GraphVertexCollection.html#save\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"graph.GraphVertexCollection\"},{\"kind\":2048,\"name\":\"replace\",\"url\":\"classes/graph.GraphVertexCollection.html#replace\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"graph.GraphVertexCollection\"},{\"kind\":2048,\"name\":\"update\",\"url\":\"classes/graph.GraphVertexCollection.html#update\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"graph.GraphVertexCollection\"},{\"kind\":2048,\"name\":\"remove\",\"url\":\"classes/graph.GraphVertexCollection.html#remove\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"graph.GraphVertexCollection\"},{\"kind\":128,\"name\":\"GraphEdgeCollection\",\"url\":\"classes/graph.GraphEdgeCollection.html\",\"classes\":\"tsd-kind-class tsd-parent-kind-module\",\"parent\":\"graph\"},{\"kind\":262144,\"name\":\"name\",\"url\":\"classes/graph.GraphEdgeCollection.html#name\",\"classes\":\"tsd-kind-accessor tsd-parent-kind-class\",\"parent\":\"graph.GraphEdgeCollection\"},{\"kind\":262144,\"name\":\"collection\",\"url\":\"classes/graph.GraphEdgeCollection.html#collection\",\"classes\":\"tsd-kind-accessor tsd-parent-kind-class\",\"parent\":\"graph.GraphEdgeCollection\"},{\"kind\":262144,\"name\":\"graph\",\"url\":\"classes/graph.GraphEdgeCollection.html#graph\",\"classes\":\"tsd-kind-accessor tsd-parent-kind-class\",\"parent\":\"graph.GraphEdgeCollection\"},{\"kind\":2048,\"name\":\"edgeExists\",\"url\":\"classes/graph.GraphEdgeCollection.html#edgeExists\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"graph.GraphEdgeCollection\"},{\"kind\":2048,\"name\":\"edge\",\"url\":\"classes/graph.GraphEdgeCollection.html#edge\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"graph.GraphEdgeCollection\"},{\"kind\":2048,\"name\":\"save\",\"url\":\"classes/graph.GraphEdgeCollection.html#save\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"graph.GraphEdgeCollection\"},{\"kind\":2048,\"name\":\"replace\",\"url\":\"classes/graph.GraphEdgeCollection.html#replace\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"graph.GraphEdgeCollection\"},{\"kind\":2048,\"name\":\"update\",\"url\":\"classes/graph.GraphEdgeCollection.html#update\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"graph.GraphEdgeCollection\"},{\"kind\":2048,\"name\":\"remove\",\"url\":\"classes/graph.GraphEdgeCollection.html#remove\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"graph.GraphEdgeCollection\"},{\"kind\":128,\"name\":\"Graph\",\"url\":\"classes/graph.Graph.html\",\"classes\":\"tsd-kind-class tsd-parent-kind-module\",\"parent\":\"graph\"},{\"kind\":262144,\"name\":\"name\",\"url\":\"classes/graph.Graph.html#name\",\"classes\":\"tsd-kind-accessor tsd-parent-kind-class\",\"parent\":\"graph.Graph\"},{\"kind\":2048,\"name\":\"exists\",\"url\":\"classes/graph.Graph.html#exists\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"graph.Graph\"},{\"kind\":2048,\"name\":\"get\",\"url\":\"classes/graph.Graph.html#get\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"graph.Graph\"},{\"kind\":2048,\"name\":\"create\",\"url\":\"classes/graph.Graph.html#create\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"graph.Graph\"},{\"kind\":2048,\"name\":\"drop\",\"url\":\"classes/graph.Graph.html#drop\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"graph.Graph\"},{\"kind\":2048,\"name\":\"vertexCollection\",\"url\":\"classes/graph.Graph.html#vertexCollection\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"graph.Graph\"},{\"kind\":2048,\"name\":\"listVertexCollections\",\"url\":\"classes/graph.Graph.html#listVertexCollections\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"graph.Graph\"},{\"kind\":2048,\"name\":\"vertexCollections\",\"url\":\"classes/graph.Graph.html#vertexCollections\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"graph.Graph\"},{\"kind\":2048,\"name\":\"addVertexCollection\",\"url\":\"classes/graph.Graph.html#addVertexCollection\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"graph.Graph\"},{\"kind\":2048,\"name\":\"removeVertexCollection\",\"url\":\"classes/graph.Graph.html#removeVertexCollection\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"graph.Graph\"},{\"kind\":2048,\"name\":\"edgeCollection\",\"url\":\"classes/graph.Graph.html#edgeCollection\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"graph.Graph\"},{\"kind\":2048,\"name\":\"listEdgeCollections\",\"url\":\"classes/graph.Graph.html#listEdgeCollections\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"graph.Graph\"},{\"kind\":2048,\"name\":\"edgeCollections\",\"url\":\"classes/graph.Graph.html#edgeCollections\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"graph.Graph\"},{\"kind\":2048,\"name\":\"addEdgeDefinition\",\"url\":\"classes/graph.Graph.html#addEdgeDefinition\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"graph.Graph\"},{\"kind\":2048,\"name\":\"replaceEdgeDefinition\",\"url\":\"classes/graph.Graph.html#replaceEdgeDefinition\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"graph.Graph\"},{\"kind\":2048,\"name\":\"removeEdgeDefinition\",\"url\":\"classes/graph.Graph.html#removeEdgeDefinition\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"graph.Graph\"},{\"kind\":2048,\"name\":\"traversal\",\"url\":\"classes/graph.Graph.html#traversal\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"graph.Graph\"},{\"kind\":2,\"name\":\"index\",\"url\":\"modules/index.html\",\"classes\":\"tsd-kind-module\"},{\"kind\":64,\"name\":\"arangojs\",\"url\":\"functions/index.arangojs.html\",\"classes\":\"tsd-kind-function tsd-parent-kind-module\",\"parent\":\"index\"},{\"kind\":8388608,\"name\":\"default\",\"url\":\"modules/index.html#default\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"index\"},{\"kind\":2,\"name\":\"indexes\",\"url\":\"modules/indexes.html\",\"classes\":\"tsd-kind-module\"},{\"kind\":4194304,\"name\":\"EnsurePersistentIndexOptions\",\"url\":\"types/indexes.EnsurePersistentIndexOptions.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"indexes\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/indexes.EnsurePersistentIndexOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"indexes.EnsurePersistentIndexOptions\"},{\"kind\":1024,\"name\":\"type\",\"url\":\"types/indexes.EnsurePersistentIndexOptions.html#__type.type\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"indexes.EnsurePersistentIndexOptions.__type\"},{\"kind\":1024,\"name\":\"fields\",\"url\":\"types/indexes.EnsurePersistentIndexOptions.html#__type.fields\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"indexes.EnsurePersistentIndexOptions.__type\"},{\"kind\":1024,\"name\":\"name\",\"url\":\"types/indexes.EnsurePersistentIndexOptions.html#__type.name\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"indexes.EnsurePersistentIndexOptions.__type\"},{\"kind\":1024,\"name\":\"unique\",\"url\":\"types/indexes.EnsurePersistentIndexOptions.html#__type.unique\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"indexes.EnsurePersistentIndexOptions.__type\"},{\"kind\":1024,\"name\":\"sparse\",\"url\":\"types/indexes.EnsurePersistentIndexOptions.html#__type.sparse\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"indexes.EnsurePersistentIndexOptions.__type\"},{\"kind\":1024,\"name\":\"deduplicate\",\"url\":\"types/indexes.EnsurePersistentIndexOptions.html#__type.deduplicate\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"indexes.EnsurePersistentIndexOptions.__type\"},{\"kind\":1024,\"name\":\"estimates\",\"url\":\"types/indexes.EnsurePersistentIndexOptions.html#__type.estimates\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"indexes.EnsurePersistentIndexOptions.__type\"},{\"kind\":1024,\"name\":\"inBackground\",\"url\":\"types/indexes.EnsurePersistentIndexOptions.html#__type.inBackground\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"indexes.EnsurePersistentIndexOptions.__type\"},{\"kind\":1024,\"name\":\"cacheEnabled\",\"url\":\"types/indexes.EnsurePersistentIndexOptions.html#__type.cacheEnabled\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"indexes.EnsurePersistentIndexOptions.__type\"},{\"kind\":1024,\"name\":\"storedValues\",\"url\":\"types/indexes.EnsurePersistentIndexOptions.html#__type.storedValues\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"indexes.EnsurePersistentIndexOptions.__type\"},{\"kind\":4194304,\"name\":\"EnsureGeoIndexOptions\",\"url\":\"types/indexes.EnsureGeoIndexOptions.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"indexes\"},{\"kind\":4194304,\"name\":\"EnsureFulltextIndexOptions\",\"url\":\"types/indexes.EnsureFulltextIndexOptions.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"indexes\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/indexes.EnsureFulltextIndexOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"indexes.EnsureFulltextIndexOptions\"},{\"kind\":1024,\"name\":\"type\",\"url\":\"types/indexes.EnsureFulltextIndexOptions.html#__type.type\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"indexes.EnsureFulltextIndexOptions.__type\"},{\"kind\":1024,\"name\":\"fields\",\"url\":\"types/indexes.EnsureFulltextIndexOptions.html#__type.fields\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"indexes.EnsureFulltextIndexOptions.__type\"},{\"kind\":1024,\"name\":\"name\",\"url\":\"types/indexes.EnsureFulltextIndexOptions.html#__type.name\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"indexes.EnsureFulltextIndexOptions.__type\"},{\"kind\":1024,\"name\":\"minLength\",\"url\":\"types/indexes.EnsureFulltextIndexOptions.html#__type.minLength\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"indexes.EnsureFulltextIndexOptions.__type\"},{\"kind\":1024,\"name\":\"inBackground\",\"url\":\"types/indexes.EnsureFulltextIndexOptions.html#__type.inBackground\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"indexes.EnsureFulltextIndexOptions.__type\"},{\"kind\":4194304,\"name\":\"EnsureTtlIndexOptions\",\"url\":\"types/indexes.EnsureTtlIndexOptions.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"indexes\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/indexes.EnsureTtlIndexOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"indexes.EnsureTtlIndexOptions\"},{\"kind\":1024,\"name\":\"type\",\"url\":\"types/indexes.EnsureTtlIndexOptions.html#__type.type\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"indexes.EnsureTtlIndexOptions.__type\"},{\"kind\":1024,\"name\":\"fields\",\"url\":\"types/indexes.EnsureTtlIndexOptions.html#__type.fields\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"indexes.EnsureTtlIndexOptions.__type\"},{\"kind\":1024,\"name\":\"name\",\"url\":\"types/indexes.EnsureTtlIndexOptions.html#__type.name\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"indexes.EnsureTtlIndexOptions.__type\"},{\"kind\":1024,\"name\":\"expireAfter\",\"url\":\"types/indexes.EnsureTtlIndexOptions.html#__type.expireAfter\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"indexes.EnsureTtlIndexOptions.__type\"},{\"kind\":1024,\"name\":\"inBackground\",\"url\":\"types/indexes.EnsureTtlIndexOptions.html#__type.inBackground\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"indexes.EnsureTtlIndexOptions.__type\"},{\"kind\":4194304,\"name\":\"EnsureMdiIndexOptions\",\"url\":\"types/indexes.EnsureMdiIndexOptions.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"indexes\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/indexes.EnsureMdiIndexOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"indexes.EnsureMdiIndexOptions\"},{\"kind\":1024,\"name\":\"type\",\"url\":\"types/indexes.EnsureMdiIndexOptions.html#__type.type\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"indexes.EnsureMdiIndexOptions.__type\"},{\"kind\":1024,\"name\":\"fields\",\"url\":\"types/indexes.EnsureMdiIndexOptions.html#__type.fields\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"indexes.EnsureMdiIndexOptions.__type\"},{\"kind\":1024,\"name\":\"fieldValueTypes\",\"url\":\"types/indexes.EnsureMdiIndexOptions.html#__type.fieldValueTypes\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"indexes.EnsureMdiIndexOptions.__type\"},{\"kind\":1024,\"name\":\"name\",\"url\":\"types/indexes.EnsureMdiIndexOptions.html#__type.name\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"indexes.EnsureMdiIndexOptions.__type\"},{\"kind\":1024,\"name\":\"unique\",\"url\":\"types/indexes.EnsureMdiIndexOptions.html#__type.unique\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"indexes.EnsureMdiIndexOptions.__type\"},{\"kind\":1024,\"name\":\"inBackground\",\"url\":\"types/indexes.EnsureMdiIndexOptions.html#__type.inBackground\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"indexes.EnsureMdiIndexOptions.__type\"},{\"kind\":4194304,\"name\":\"InvertedIndexNestedFieldOptions\",\"url\":\"types/indexes.InvertedIndexNestedFieldOptions.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"indexes\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/indexes.InvertedIndexNestedFieldOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"indexes.InvertedIndexNestedFieldOptions\"},{\"kind\":1024,\"name\":\"name\",\"url\":\"types/indexes.InvertedIndexNestedFieldOptions.html#__type.name\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"indexes.InvertedIndexNestedFieldOptions.__type\"},{\"kind\":1024,\"name\":\"analyzer\",\"url\":\"types/indexes.InvertedIndexNestedFieldOptions.html#__type.analyzer\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"indexes.InvertedIndexNestedFieldOptions.__type\"},{\"kind\":1024,\"name\":\"features\",\"url\":\"types/indexes.InvertedIndexNestedFieldOptions.html#__type.features\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"indexes.InvertedIndexNestedFieldOptions.__type\"},{\"kind\":1024,\"name\":\"searchField\",\"url\":\"types/indexes.InvertedIndexNestedFieldOptions.html#__type.searchField\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"indexes.InvertedIndexNestedFieldOptions.__type\"},{\"kind\":1024,\"name\":\"nested\",\"url\":\"types/indexes.InvertedIndexNestedFieldOptions.html#__type.nested\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"indexes.InvertedIndexNestedFieldOptions.__type\"},{\"kind\":4194304,\"name\":\"InvertedIndexFieldOptions\",\"url\":\"types/indexes.InvertedIndexFieldOptions.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"indexes\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/indexes.InvertedIndexFieldOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"indexes.InvertedIndexFieldOptions\"},{\"kind\":1024,\"name\":\"name\",\"url\":\"types/indexes.InvertedIndexFieldOptions.html#__type.name\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"indexes.InvertedIndexFieldOptions.__type\"},{\"kind\":1024,\"name\":\"analyzer\",\"url\":\"types/indexes.InvertedIndexFieldOptions.html#__type.analyzer\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"indexes.InvertedIndexFieldOptions.__type\"},{\"kind\":1024,\"name\":\"features\",\"url\":\"types/indexes.InvertedIndexFieldOptions.html#__type.features\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"indexes.InvertedIndexFieldOptions.__type\"},{\"kind\":1024,\"name\":\"includeAllFields\",\"url\":\"types/indexes.InvertedIndexFieldOptions.html#__type.includeAllFields\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"indexes.InvertedIndexFieldOptions.__type\"},{\"kind\":1024,\"name\":\"searchField\",\"url\":\"types/indexes.InvertedIndexFieldOptions.html#__type.searchField\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"indexes.InvertedIndexFieldOptions.__type\"},{\"kind\":1024,\"name\":\"trackListPositions\",\"url\":\"types/indexes.InvertedIndexFieldOptions.html#__type.trackListPositions\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"indexes.InvertedIndexFieldOptions.__type\"},{\"kind\":1024,\"name\":\"nested\",\"url\":\"types/indexes.InvertedIndexFieldOptions.html#__type.nested\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"indexes.InvertedIndexFieldOptions.__type\"},{\"kind\":1024,\"name\":\"cache\",\"url\":\"types/indexes.InvertedIndexFieldOptions.html#__type.cache\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"indexes.InvertedIndexFieldOptions.__type\"},{\"kind\":4194304,\"name\":\"InvertedIndexStoredValueOptions\",\"url\":\"types/indexes.InvertedIndexStoredValueOptions.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"indexes\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/indexes.InvertedIndexStoredValueOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"indexes.InvertedIndexStoredValueOptions\"},{\"kind\":1024,\"name\":\"fields\",\"url\":\"types/indexes.InvertedIndexStoredValueOptions.html#__type.fields\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"indexes.InvertedIndexStoredValueOptions.__type\"},{\"kind\":1024,\"name\":\"compression\",\"url\":\"types/indexes.InvertedIndexStoredValueOptions.html#__type.compression\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"indexes.InvertedIndexStoredValueOptions.__type\"},{\"kind\":1024,\"name\":\"cache\",\"url\":\"types/indexes.InvertedIndexStoredValueOptions.html#__type.cache\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"indexes.InvertedIndexStoredValueOptions.__type\"},{\"kind\":4194304,\"name\":\"InvertedIndexPrimarySortFieldOptions\",\"url\":\"types/indexes.InvertedIndexPrimarySortFieldOptions.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"indexes\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/indexes.InvertedIndexPrimarySortFieldOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"indexes.InvertedIndexPrimarySortFieldOptions\"},{\"kind\":1024,\"name\":\"field\",\"url\":\"types/indexes.InvertedIndexPrimarySortFieldOptions.html#__type.field\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"indexes.InvertedIndexPrimarySortFieldOptions.__type\"},{\"kind\":1024,\"name\":\"direction\",\"url\":\"types/indexes.InvertedIndexPrimarySortFieldOptions.html#__type.direction\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"indexes.InvertedIndexPrimarySortFieldOptions.__type\"},{\"kind\":4194304,\"name\":\"EnsureInvertedIndexOptions\",\"url\":\"types/indexes.EnsureInvertedIndexOptions.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"indexes\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/indexes.EnsureInvertedIndexOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"indexes.EnsureInvertedIndexOptions\"},{\"kind\":1024,\"name\":\"type\",\"url\":\"types/indexes.EnsureInvertedIndexOptions.html#__type.type\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"indexes.EnsureInvertedIndexOptions.__type\"},{\"kind\":1024,\"name\":\"fields\",\"url\":\"types/indexes.EnsureInvertedIndexOptions.html#__type.fields\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"indexes.EnsureInvertedIndexOptions.__type\"},{\"kind\":1024,\"name\":\"name\",\"url\":\"types/indexes.EnsureInvertedIndexOptions.html#__type.name\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"indexes.EnsureInvertedIndexOptions.__type\"},{\"kind\":1024,\"name\":\"searchField\",\"url\":\"types/indexes.EnsureInvertedIndexOptions.html#__type.searchField\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"indexes.EnsureInvertedIndexOptions.__type\"},{\"kind\":1024,\"name\":\"storedValues\",\"url\":\"types/indexes.EnsureInvertedIndexOptions.html#__type.storedValues\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"indexes.EnsureInvertedIndexOptions.__type\"},{\"kind\":1024,\"name\":\"primarySort\",\"url\":\"types/indexes.EnsureInvertedIndexOptions.html#__type.primarySort\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"indexes.EnsureInvertedIndexOptions.__type\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/indexes.EnsureInvertedIndexOptions.html#__type.primarySort.__type-1\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-property\",\"parent\":\"indexes.EnsureInvertedIndexOptions.__type.primarySort\"},{\"kind\":1024,\"name\":\"fields\",\"url\":\"types/indexes.EnsureInvertedIndexOptions.html#__type.primarySort.__type-1.fields-1\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"indexes.EnsureInvertedIndexOptions.__type.primarySort.__type\"},{\"kind\":1024,\"name\":\"compression\",\"url\":\"types/indexes.EnsureInvertedIndexOptions.html#__type.primarySort.__type-1.compression\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"indexes.EnsureInvertedIndexOptions.__type.primarySort.__type\"},{\"kind\":1024,\"name\":\"cache\",\"url\":\"types/indexes.EnsureInvertedIndexOptions.html#__type.primarySort.__type-1.cache-1\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"indexes.EnsureInvertedIndexOptions.__type.primarySort.__type\"},{\"kind\":1024,\"name\":\"primaryKeyCache\",\"url\":\"types/indexes.EnsureInvertedIndexOptions.html#__type.primaryKeyCache\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"indexes.EnsureInvertedIndexOptions.__type\"},{\"kind\":1024,\"name\":\"analyzer\",\"url\":\"types/indexes.EnsureInvertedIndexOptions.html#__type.analyzer\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"indexes.EnsureInvertedIndexOptions.__type\"},{\"kind\":1024,\"name\":\"features\",\"url\":\"types/indexes.EnsureInvertedIndexOptions.html#__type.features\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"indexes.EnsureInvertedIndexOptions.__type\"},{\"kind\":1024,\"name\":\"includeAllFields\",\"url\":\"types/indexes.EnsureInvertedIndexOptions.html#__type.includeAllFields\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"indexes.EnsureInvertedIndexOptions.__type\"},{\"kind\":1024,\"name\":\"trackListPositions\",\"url\":\"types/indexes.EnsureInvertedIndexOptions.html#__type.trackListPositions\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"indexes.EnsureInvertedIndexOptions.__type\"},{\"kind\":1024,\"name\":\"parallelism\",\"url\":\"types/indexes.EnsureInvertedIndexOptions.html#__type.parallelism\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"indexes.EnsureInvertedIndexOptions.__type\"},{\"kind\":1024,\"name\":\"cleanupIntervalStep\",\"url\":\"types/indexes.EnsureInvertedIndexOptions.html#__type.cleanupIntervalStep\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"indexes.EnsureInvertedIndexOptions.__type\"},{\"kind\":1024,\"name\":\"commitIntervalMsec\",\"url\":\"types/indexes.EnsureInvertedIndexOptions.html#__type.commitIntervalMsec\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"indexes.EnsureInvertedIndexOptions.__type\"},{\"kind\":1024,\"name\":\"consolidationIntervalMsec\",\"url\":\"types/indexes.EnsureInvertedIndexOptions.html#__type.consolidationIntervalMsec\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"indexes.EnsureInvertedIndexOptions.__type\"},{\"kind\":1024,\"name\":\"consolidationPolicy\",\"url\":\"types/indexes.EnsureInvertedIndexOptions.html#__type.consolidationPolicy\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"indexes.EnsureInvertedIndexOptions.__type\"},{\"kind\":1024,\"name\":\"writeBufferIdle\",\"url\":\"types/indexes.EnsureInvertedIndexOptions.html#__type.writeBufferIdle\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"indexes.EnsureInvertedIndexOptions.__type\"},{\"kind\":1024,\"name\":\"writeBufferActive\",\"url\":\"types/indexes.EnsureInvertedIndexOptions.html#__type.writeBufferActive\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"indexes.EnsureInvertedIndexOptions.__type\"},{\"kind\":1024,\"name\":\"writeBufferSizeMax\",\"url\":\"types/indexes.EnsureInvertedIndexOptions.html#__type.writeBufferSizeMax\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"indexes.EnsureInvertedIndexOptions.__type\"},{\"kind\":1024,\"name\":\"inBackground\",\"url\":\"types/indexes.EnsureInvertedIndexOptions.html#__type.inBackground\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"indexes.EnsureInvertedIndexOptions.__type\"},{\"kind\":1024,\"name\":\"cache\",\"url\":\"types/indexes.EnsureInvertedIndexOptions.html#__type.cache\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"indexes.EnsureInvertedIndexOptions.__type\"},{\"kind\":1024,\"name\":\"optimizeTopK\",\"url\":\"types/indexes.EnsureInvertedIndexOptions.html#__type.optimizeTopK\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"indexes.EnsureInvertedIndexOptions.__type\"},{\"kind\":4194304,\"name\":\"GenericIndex\",\"url\":\"types/indexes.GenericIndex.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"indexes\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/indexes.GenericIndex.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"indexes.GenericIndex\"},{\"kind\":1024,\"name\":\"name\",\"url\":\"types/indexes.GenericIndex.html#__type.name\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"indexes.GenericIndex.__type\"},{\"kind\":1024,\"name\":\"id\",\"url\":\"types/indexes.GenericIndex.html#__type.id\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"indexes.GenericIndex.__type\"},{\"kind\":1024,\"name\":\"sparse\",\"url\":\"types/indexes.GenericIndex.html#__type.sparse\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"indexes.GenericIndex.__type\"},{\"kind\":1024,\"name\":\"unique\",\"url\":\"types/indexes.GenericIndex.html#__type.unique\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"indexes.GenericIndex.__type\"},{\"kind\":4194304,\"name\":\"PersistentIndex\",\"url\":\"types/indexes.PersistentIndex.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"indexes\"},{\"kind\":4194304,\"name\":\"PrimaryIndex\",\"url\":\"types/indexes.PrimaryIndex.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"indexes\"},{\"kind\":4194304,\"name\":\"FulltextIndex\",\"url\":\"types/indexes.FulltextIndex.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"indexes\"},{\"kind\":4194304,\"name\":\"GeoIndex\",\"url\":\"types/indexes.GeoIndex.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"indexes\"},{\"kind\":4194304,\"name\":\"TtlIndex\",\"url\":\"types/indexes.TtlIndex.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"indexes\"},{\"kind\":4194304,\"name\":\"MdiIndex\",\"url\":\"types/indexes.MdiIndex.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"indexes\"},{\"kind\":4194304,\"name\":\"InvertedIndexNestedField\",\"url\":\"types/indexes.InvertedIndexNestedField.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"indexes\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/indexes.InvertedIndexNestedField.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"indexes.InvertedIndexNestedField\"},{\"kind\":1024,\"name\":\"name\",\"url\":\"types/indexes.InvertedIndexNestedField.html#__type.name\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"indexes.InvertedIndexNestedField.__type\"},{\"kind\":1024,\"name\":\"analyzer\",\"url\":\"types/indexes.InvertedIndexNestedField.html#__type.analyzer\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"indexes.InvertedIndexNestedField.__type\"},{\"kind\":1024,\"name\":\"features\",\"url\":\"types/indexes.InvertedIndexNestedField.html#__type.features\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"indexes.InvertedIndexNestedField.__type\"},{\"kind\":1024,\"name\":\"searchField\",\"url\":\"types/indexes.InvertedIndexNestedField.html#__type.searchField\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"indexes.InvertedIndexNestedField.__type\"},{\"kind\":1024,\"name\":\"nested\",\"url\":\"types/indexes.InvertedIndexNestedField.html#__type.nested\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"indexes.InvertedIndexNestedField.__type\"},{\"kind\":4194304,\"name\":\"InvertedIndex\",\"url\":\"types/indexes.InvertedIndex.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"indexes\"},{\"kind\":4194304,\"name\":\"Index\",\"url\":\"types/indexes.Index.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"indexes\"},{\"kind\":4194304,\"name\":\"ObjectWithId\",\"url\":\"types/indexes.ObjectWithId.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"indexes\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/indexes.ObjectWithId.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"indexes.ObjectWithId\"},{\"kind\":1024,\"name\":\"id\",\"url\":\"types/indexes.ObjectWithId.html#__type.id\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"indexes.ObjectWithId.__type\"},{\"kind\":4194304,\"name\":\"ObjectWithName\",\"url\":\"types/indexes.ObjectWithName.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"indexes\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/indexes.ObjectWithName.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"indexes.ObjectWithName\"},{\"kind\":1024,\"name\":\"name\",\"url\":\"types/indexes.ObjectWithName.html#__type.name\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"indexes.ObjectWithName.__type\"},{\"kind\":4194304,\"name\":\"IndexSelector\",\"url\":\"types/indexes.IndexSelector.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"indexes\"},{\"kind\":2,\"name\":\"job\",\"url\":\"modules/job.html\",\"classes\":\"tsd-kind-module\"},{\"kind\":128,\"name\":\"Job\",\"url\":\"classes/job.Job.html\",\"classes\":\"tsd-kind-class tsd-parent-kind-module\",\"parent\":\"job\"},{\"kind\":262144,\"name\":\"isLoaded\",\"url\":\"classes/job.Job.html#isLoaded\",\"classes\":\"tsd-kind-accessor tsd-parent-kind-class\",\"parent\":\"job.Job\"},{\"kind\":262144,\"name\":\"result\",\"url\":\"classes/job.Job.html#result\",\"classes\":\"tsd-kind-accessor tsd-parent-kind-class\",\"parent\":\"job.Job\"},{\"kind\":2048,\"name\":\"load\",\"url\":\"classes/job.Job.html#load\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"job.Job\"},{\"kind\":2048,\"name\":\"cancel\",\"url\":\"classes/job.Job.html#cancel\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"job.Job\"},{\"kind\":2048,\"name\":\"deleteResult\",\"url\":\"classes/job.Job.html#deleteResult\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"job.Job\"},{\"kind\":2048,\"name\":\"getCompleted\",\"url\":\"classes/job.Job.html#getCompleted\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"job.Job\"},{\"kind\":2,\"name\":\"route\",\"url\":\"modules/route.html\",\"classes\":\"tsd-kind-module\"},{\"kind\":128,\"name\":\"Route\",\"url\":\"classes/route.Route.html\",\"classes\":\"tsd-kind-class tsd-parent-kind-module\",\"parent\":\"route\"},{\"kind\":2048,\"name\":\"route\",\"url\":\"classes/route.Route.html#route\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"route.Route\"},{\"kind\":2048,\"name\":\"request\",\"url\":\"classes/route.Route.html#request\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"route.Route\"},{\"kind\":2048,\"name\":\"delete\",\"url\":\"classes/route.Route.html#delete\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"route.Route\"},{\"kind\":2048,\"name\":\"get\",\"url\":\"classes/route.Route.html#get\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"route.Route\"},{\"kind\":2048,\"name\":\"head\",\"url\":\"classes/route.Route.html#head\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"route.Route\"},{\"kind\":2048,\"name\":\"patch\",\"url\":\"classes/route.Route.html#patch\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"route.Route\"},{\"kind\":2048,\"name\":\"post\",\"url\":\"classes/route.Route.html#post\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"route.Route\"},{\"kind\":2048,\"name\":\"put\",\"url\":\"classes/route.Route.html#put\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"route.Route\"},{\"kind\":2,\"name\":\"transaction\",\"url\":\"modules/transaction.html\",\"classes\":\"tsd-kind-module\"},{\"kind\":64,\"name\":\"isArangoTransaction\",\"url\":\"functions/transaction.isArangoTransaction.html\",\"classes\":\"tsd-kind-function tsd-parent-kind-module\",\"parent\":\"transaction\"},{\"kind\":4194304,\"name\":\"TransactionCommitOptions\",\"url\":\"types/transaction.TransactionCommitOptions.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"transaction\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/transaction.TransactionCommitOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"transaction.TransactionCommitOptions\"},{\"kind\":1024,\"name\":\"allowDirtyRead\",\"url\":\"types/transaction.TransactionCommitOptions.html#__type.allowDirtyRead\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"transaction.TransactionCommitOptions.__type\"},{\"kind\":4194304,\"name\":\"TransactionAbortOptions\",\"url\":\"types/transaction.TransactionAbortOptions.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"transaction\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/transaction.TransactionAbortOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"transaction.TransactionAbortOptions\"},{\"kind\":1024,\"name\":\"allowDirtyRead\",\"url\":\"types/transaction.TransactionAbortOptions.html#__type.allowDirtyRead\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"transaction.TransactionAbortOptions.__type\"},{\"kind\":4194304,\"name\":\"TransactionStatus\",\"url\":\"types/transaction.TransactionStatus.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"transaction\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/transaction.TransactionStatus.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"transaction.TransactionStatus\"},{\"kind\":1024,\"name\":\"id\",\"url\":\"types/transaction.TransactionStatus.html#__type.id\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"transaction.TransactionStatus.__type\"},{\"kind\":1024,\"name\":\"status\",\"url\":\"types/transaction.TransactionStatus.html#__type.status\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"transaction.TransactionStatus.__type\"},{\"kind\":128,\"name\":\"Transaction\",\"url\":\"classes/transaction.Transaction.html\",\"classes\":\"tsd-kind-class tsd-parent-kind-module\",\"parent\":\"transaction\"},{\"kind\":262144,\"name\":\"id\",\"url\":\"classes/transaction.Transaction.html#id\",\"classes\":\"tsd-kind-accessor tsd-parent-kind-class\",\"parent\":\"transaction.Transaction\"},{\"kind\":2048,\"name\":\"exists\",\"url\":\"classes/transaction.Transaction.html#exists\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"transaction.Transaction\"},{\"kind\":2048,\"name\":\"get\",\"url\":\"classes/transaction.Transaction.html#get\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"transaction.Transaction\"},{\"kind\":2048,\"name\":\"commit\",\"url\":\"classes/transaction.Transaction.html#commit\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"transaction.Transaction\"},{\"kind\":2048,\"name\":\"abort\",\"url\":\"classes/transaction.Transaction.html#abort\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"transaction.Transaction\"},{\"kind\":2048,\"name\":\"step\",\"url\":\"classes/transaction.Transaction.html#step\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"transaction.Transaction\"},{\"kind\":2,\"name\":\"view\",\"url\":\"modules/view.html\",\"classes\":\"tsd-kind-module\"},{\"kind\":64,\"name\":\"isArangoView\",\"url\":\"functions/view.isArangoView.html\",\"classes\":\"tsd-kind-function tsd-parent-kind-module\",\"parent\":\"view\"},{\"kind\":4194304,\"name\":\"Direction\",\"url\":\"types/view.Direction.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"view\"},{\"kind\":4194304,\"name\":\"BytesAccumConsolidationPolicy\",\"url\":\"types/view.BytesAccumConsolidationPolicy.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"view\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/view.BytesAccumConsolidationPolicy.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"view.BytesAccumConsolidationPolicy\"},{\"kind\":1024,\"name\":\"type\",\"url\":\"types/view.BytesAccumConsolidationPolicy.html#__type.type\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"view.BytesAccumConsolidationPolicy.__type\"},{\"kind\":1024,\"name\":\"threshold\",\"url\":\"types/view.BytesAccumConsolidationPolicy.html#__type.threshold\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"view.BytesAccumConsolidationPolicy.__type\"},{\"kind\":4194304,\"name\":\"TierConsolidationPolicy\",\"url\":\"types/view.TierConsolidationPolicy.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"view\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/view.TierConsolidationPolicy.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"view.TierConsolidationPolicy\"},{\"kind\":1024,\"name\":\"type\",\"url\":\"types/view.TierConsolidationPolicy.html#__type.type\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"view.TierConsolidationPolicy.__type\"},{\"kind\":1024,\"name\":\"segmentsBytesFloor\",\"url\":\"types/view.TierConsolidationPolicy.html#__type.segmentsBytesFloor\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"view.TierConsolidationPolicy.__type\"},{\"kind\":1024,\"name\":\"segmentsBytesMax\",\"url\":\"types/view.TierConsolidationPolicy.html#__type.segmentsBytesMax\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"view.TierConsolidationPolicy.__type\"},{\"kind\":1024,\"name\":\"segmentsMax\",\"url\":\"types/view.TierConsolidationPolicy.html#__type.segmentsMax\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"view.TierConsolidationPolicy.__type\"},{\"kind\":1024,\"name\":\"segmentsMin\",\"url\":\"types/view.TierConsolidationPolicy.html#__type.segmentsMin\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"view.TierConsolidationPolicy.__type\"},{\"kind\":1024,\"name\":\"minScore\",\"url\":\"types/view.TierConsolidationPolicy.html#__type.minScore\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"view.TierConsolidationPolicy.__type\"},{\"kind\":4194304,\"name\":\"Compression\",\"url\":\"types/view.Compression.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"view\"},{\"kind\":4194304,\"name\":\"CreateViewOptions\",\"url\":\"types/view.CreateViewOptions.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"view\"},{\"kind\":4194304,\"name\":\"ViewPropertiesOptions\",\"url\":\"types/view.ViewPropertiesOptions.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"view\"},{\"kind\":4194304,\"name\":\"ViewPatchPropertiesOptions\",\"url\":\"types/view.ViewPatchPropertiesOptions.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"view\"},{\"kind\":4194304,\"name\":\"ArangoSearchViewLinkOptions\",\"url\":\"types/view.ArangoSearchViewLinkOptions.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"view\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/view.ArangoSearchViewLinkOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"view.ArangoSearchViewLinkOptions\"},{\"kind\":1024,\"name\":\"analyzers\",\"url\":\"types/view.ArangoSearchViewLinkOptions.html#__type.analyzers\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"view.ArangoSearchViewLinkOptions.__type\"},{\"kind\":1024,\"name\":\"fields\",\"url\":\"types/view.ArangoSearchViewLinkOptions.html#__type.fields\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"view.ArangoSearchViewLinkOptions.__type\"},{\"kind\":1024,\"name\":\"includeAllFields\",\"url\":\"types/view.ArangoSearchViewLinkOptions.html#__type.includeAllFields\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"view.ArangoSearchViewLinkOptions.__type\"},{\"kind\":1024,\"name\":\"nested\",\"url\":\"types/view.ArangoSearchViewLinkOptions.html#__type.nested\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"view.ArangoSearchViewLinkOptions.__type\"},{\"kind\":1024,\"name\":\"trackListPositions\",\"url\":\"types/view.ArangoSearchViewLinkOptions.html#__type.trackListPositions\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"view.ArangoSearchViewLinkOptions.__type\"},{\"kind\":1024,\"name\":\"storeValues\",\"url\":\"types/view.ArangoSearchViewLinkOptions.html#__type.storeValues\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"view.ArangoSearchViewLinkOptions.__type\"},{\"kind\":1024,\"name\":\"inBackground\",\"url\":\"types/view.ArangoSearchViewLinkOptions.html#__type.inBackground\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"view.ArangoSearchViewLinkOptions.__type\"},{\"kind\":1024,\"name\":\"cache\",\"url\":\"types/view.ArangoSearchViewLinkOptions.html#__type.cache\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"view.ArangoSearchViewLinkOptions.__type\"},{\"kind\":4194304,\"name\":\"ArangoSearchViewPropertiesOptions\",\"url\":\"types/view.ArangoSearchViewPropertiesOptions.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"view\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/view.ArangoSearchViewPropertiesOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"view.ArangoSearchViewPropertiesOptions\"},{\"kind\":1024,\"name\":\"cleanupIntervalStep\",\"url\":\"types/view.ArangoSearchViewPropertiesOptions.html#__type.cleanupIntervalStep\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"view.ArangoSearchViewPropertiesOptions.__type\"},{\"kind\":1024,\"name\":\"consolidationIntervalMsec\",\"url\":\"types/view.ArangoSearchViewPropertiesOptions.html#__type.consolidationIntervalMsec\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"view.ArangoSearchViewPropertiesOptions.__type\"},{\"kind\":1024,\"name\":\"commitIntervalMsec\",\"url\":\"types/view.ArangoSearchViewPropertiesOptions.html#__type.commitIntervalMsec\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"view.ArangoSearchViewPropertiesOptions.__type\"},{\"kind\":1024,\"name\":\"consolidationPolicy\",\"url\":\"types/view.ArangoSearchViewPropertiesOptions.html#__type.consolidationPolicy\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"view.ArangoSearchViewPropertiesOptions.__type\"},{\"kind\":1024,\"name\":\"links\",\"url\":\"types/view.ArangoSearchViewPropertiesOptions.html#__type.links\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"view.ArangoSearchViewPropertiesOptions.__type\"},{\"kind\":4194304,\"name\":\"ArangoSearchViewPatchPropertiesOptions\",\"url\":\"types/view.ArangoSearchViewPatchPropertiesOptions.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"view\"},{\"kind\":256,\"name\":\"ArangoSearchViewStoredValueOptions\",\"url\":\"interfaces/view.ArangoSearchViewStoredValueOptions.html\",\"classes\":\"tsd-kind-interface tsd-parent-kind-module\",\"parent\":\"view\"},{\"kind\":1024,\"name\":\"fields\",\"url\":\"interfaces/view.ArangoSearchViewStoredValueOptions.html#fields\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"view.ArangoSearchViewStoredValueOptions\"},{\"kind\":1024,\"name\":\"compression\",\"url\":\"interfaces/view.ArangoSearchViewStoredValueOptions.html#compression\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"view.ArangoSearchViewStoredValueOptions\"},{\"kind\":1024,\"name\":\"cache\",\"url\":\"interfaces/view.ArangoSearchViewStoredValueOptions.html#cache\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"view.ArangoSearchViewStoredValueOptions\"},{\"kind\":4194304,\"name\":\"CreateArangoSearchViewOptions\",\"url\":\"types/view.CreateArangoSearchViewOptions.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"view\"},{\"kind\":4194304,\"name\":\"SearchAliasViewIndexOptions\",\"url\":\"types/view.SearchAliasViewIndexOptions.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"view\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/view.SearchAliasViewIndexOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"view.SearchAliasViewIndexOptions\"},{\"kind\":1024,\"name\":\"collection\",\"url\":\"types/view.SearchAliasViewIndexOptions.html#__type.collection\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"view.SearchAliasViewIndexOptions.__type\"},{\"kind\":1024,\"name\":\"index\",\"url\":\"types/view.SearchAliasViewIndexOptions.html#__type.index\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"view.SearchAliasViewIndexOptions.__type\"},{\"kind\":4194304,\"name\":\"SearchAliasViewPropertiesOptions\",\"url\":\"types/view.SearchAliasViewPropertiesOptions.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"view\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/view.SearchAliasViewPropertiesOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"view.SearchAliasViewPropertiesOptions\"},{\"kind\":1024,\"name\":\"indexes\",\"url\":\"types/view.SearchAliasViewPropertiesOptions.html#__type.indexes\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"view.SearchAliasViewPropertiesOptions.__type\"},{\"kind\":4194304,\"name\":\"SearchAliasViewPatchIndexOptions\",\"url\":\"types/view.SearchAliasViewPatchIndexOptions.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"view\"},{\"kind\":4194304,\"name\":\"SearchAliasViewPatchPropertiesOptions\",\"url\":\"types/view.SearchAliasViewPatchPropertiesOptions.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"view\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/view.SearchAliasViewPatchPropertiesOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"view.SearchAliasViewPatchPropertiesOptions\"},{\"kind\":1024,\"name\":\"indexes\",\"url\":\"types/view.SearchAliasViewPatchPropertiesOptions.html#__type.indexes\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"view.SearchAliasViewPatchPropertiesOptions.__type\"},{\"kind\":4194304,\"name\":\"CreateSearchAliasViewOptions\",\"url\":\"types/view.CreateSearchAliasViewOptions.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"view\"},{\"kind\":4194304,\"name\":\"GenericViewDescription\",\"url\":\"types/view.GenericViewDescription.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"view\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/view.GenericViewDescription.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"view.GenericViewDescription\"},{\"kind\":1024,\"name\":\"globallyUniqueId\",\"url\":\"types/view.GenericViewDescription.html#__type.globallyUniqueId\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"view.GenericViewDescription.__type\"},{\"kind\":1024,\"name\":\"id\",\"url\":\"types/view.GenericViewDescription.html#__type.id\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"view.GenericViewDescription.__type\"},{\"kind\":1024,\"name\":\"name\",\"url\":\"types/view.GenericViewDescription.html#__type.name\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"view.GenericViewDescription.__type\"},{\"kind\":4194304,\"name\":\"ViewDescription\",\"url\":\"types/view.ViewDescription.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"view\"},{\"kind\":4194304,\"name\":\"ArangoSearchViewDescription\",\"url\":\"types/view.ArangoSearchViewDescription.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"view\"},{\"kind\":4194304,\"name\":\"SearchAliasViewDescription\",\"url\":\"types/view.SearchAliasViewDescription.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"view\"},{\"kind\":4194304,\"name\":\"ViewProperties\",\"url\":\"types/view.ViewProperties.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"view\"},{\"kind\":4194304,\"name\":\"ArangoSearchViewLink\",\"url\":\"types/view.ArangoSearchViewLink.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"view\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/view.ArangoSearchViewLink.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"view.ArangoSearchViewLink\"},{\"kind\":1024,\"name\":\"analyzers\",\"url\":\"types/view.ArangoSearchViewLink.html#__type.analyzers\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"view.ArangoSearchViewLink.__type\"},{\"kind\":1024,\"name\":\"fields\",\"url\":\"types/view.ArangoSearchViewLink.html#__type.fields\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"view.ArangoSearchViewLink.__type\"},{\"kind\":1024,\"name\":\"includeAllFields\",\"url\":\"types/view.ArangoSearchViewLink.html#__type.includeAllFields\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"view.ArangoSearchViewLink.__type\"},{\"kind\":1024,\"name\":\"nested\",\"url\":\"types/view.ArangoSearchViewLink.html#__type.nested\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"view.ArangoSearchViewLink.__type\"},{\"kind\":1024,\"name\":\"trackListPositions\",\"url\":\"types/view.ArangoSearchViewLink.html#__type.trackListPositions\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"view.ArangoSearchViewLink.__type\"},{\"kind\":1024,\"name\":\"storeValues\",\"url\":\"types/view.ArangoSearchViewLink.html#__type.storeValues\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"view.ArangoSearchViewLink.__type\"},{\"kind\":1024,\"name\":\"cache\",\"url\":\"types/view.ArangoSearchViewLink.html#__type.cache\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"view.ArangoSearchViewLink.__type\"},{\"kind\":4194304,\"name\":\"ArangoSearchViewProperties\",\"url\":\"types/view.ArangoSearchViewProperties.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"view\"},{\"kind\":4194304,\"name\":\"SearchAliasViewProperties\",\"url\":\"types/view.SearchAliasViewProperties.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"view\"},{\"kind\":128,\"name\":\"View\",\"url\":\"classes/view.View.html\",\"classes\":\"tsd-kind-class tsd-parent-kind-module\",\"parent\":\"view\"},{\"kind\":262144,\"name\":\"name\",\"url\":\"classes/view.View.html#name\",\"classes\":\"tsd-kind-accessor tsd-parent-kind-class\",\"parent\":\"view.View\"},{\"kind\":2048,\"name\":\"get\",\"url\":\"classes/view.View.html#get\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"view.View\"},{\"kind\":2048,\"name\":\"exists\",\"url\":\"classes/view.View.html#exists\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"view.View\"},{\"kind\":2048,\"name\":\"create\",\"url\":\"classes/view.View.html#create\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"view.View\"},{\"kind\":2048,\"name\":\"rename\",\"url\":\"classes/view.View.html#rename\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"view.View\"},{\"kind\":2048,\"name\":\"properties\",\"url\":\"classes/view.View.html#properties\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"view.View\"},{\"kind\":2048,\"name\":\"updateProperties\",\"url\":\"classes/view.View.html#updateProperties\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"view.View\"},{\"kind\":2048,\"name\":\"replaceProperties\",\"url\":\"classes/view.View.html#replaceProperties\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"view.View\"},{\"kind\":2048,\"name\":\"drop\",\"url\":\"classes/view.View.html#drop\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"view.View\"},{\"kind\":8388608,\"name\":\"aql\",\"url\":\"modules/index.html#aql\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"index\"},{\"kind\":8388608,\"name\":\"Database\",\"url\":\"modules/index.html#Database\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"index\"}],\"index\":{\"version\":\"2.3.9\",\"fields\":[\"name\",\"comment\"],\"fieldVectors\":[[\"name/0\",[0,51.585]],[\"comment/0\",[]],[\"name/1\",[1,70.048]],[\"comment/1\",[]],[\"name/2\",[2,70.048]],[\"comment/2\",[]],[\"name/3\",[3,70.048]],[\"comment/3\",[]],[\"name/4\",[4,70.048]],[\"comment/4\",[]],[\"name/5\",[5,21.132]],[\"comment/5\",[]],[\"name/6\",[6,37.851]],[\"comment/6\",[]],[\"name/7\",[7,42.109]],[\"comment/7\",[]],[\"name/8\",[8,42.961]],[\"comment/8\",[]],[\"name/9\",[9,70.048]],[\"comment/9\",[]],[\"name/10\",[5,21.132]],[\"comment/10\",[]],[\"name/11\",[6,37.851]],[\"comment/11\",[]],[\"name/12\",[7,42.109]],[\"comment/12\",[]],[\"name/13\",[8,42.961]],[\"comment/13\",[]],[\"name/14\",[10,70.048]],[\"comment/14\",[]],[\"name/15\",[5,21.132]],[\"comment/15\",[]],[\"name/16\",[6,37.851]],[\"comment/16\",[]],[\"name/17\",[7,42.109]],[\"comment/17\",[]],[\"name/18\",[8,42.961]],[\"comment/18\",[]],[\"name/19\",[5,21.132]],[\"comment/19\",[]],[\"name/20\",[11,70.048]],[\"comment/20\",[]],[\"name/21\",[12,70.048]],[\"comment/21\",[]],[\"name/22\",[5,21.132]],[\"comment/22\",[]],[\"name/23\",[6,37.851]],[\"comment/23\",[]],[\"name/24\",[7,42.109]],[\"comment/24\",[]],[\"name/25\",[8,42.961]],[\"comment/25\",[]],[\"name/26\",[5,21.132]],[\"comment/26\",[]],[\"name/27\",[13,59.059]],[\"comment/27\",[]],[\"name/28\",[14,70.048]],[\"comment/28\",[]],[\"name/29\",[5,21.132]],[\"comment/29\",[]],[\"name/30\",[6,37.851]],[\"comment/30\",[]],[\"name/31\",[7,42.109]],[\"comment/31\",[]],[\"name/32\",[8,42.961]],[\"comment/32\",[]],[\"name/33\",[5,21.132]],[\"comment/33\",[]],[\"name/34\",[13,59.059]],[\"comment/34\",[]],[\"name/35\",[15,61.573]],[\"comment/35\",[]],[\"name/36\",[16,64.938]],[\"comment/36\",[]],[\"name/37\",[17,70.048]],[\"comment/37\",[]],[\"name/38\",[5,21.132]],[\"comment/38\",[]],[\"name/39\",[6,37.851]],[\"comment/39\",[]],[\"name/40\",[7,42.109]],[\"comment/40\",[]],[\"name/41\",[8,42.961]],[\"comment/41\",[]],[\"name/42\",[5,21.132]],[\"comment/42\",[]],[\"name/43\",[18,64.938]],[\"comment/43\",[]],[\"name/44\",[19,64.938]],[\"comment/44\",[]],[\"name/45\",[20,64.938]],[\"comment/45\",[]],[\"name/46\",[21,70.048]],[\"comment/46\",[]],[\"name/47\",[5,21.132]],[\"comment/47\",[]],[\"name/48\",[6,37.851]],[\"comment/48\",[]],[\"name/49\",[7,42.109]],[\"comment/49\",[]],[\"name/50\",[8,42.961]],[\"comment/50\",[]],[\"name/51\",[5,21.132]],[\"comment/51\",[]],[\"name/52\",[13,59.059]],[\"comment/52\",[]],[\"name/53\",[15,61.573]],[\"comment/53\",[]],[\"name/54\",[22,64.938]],[\"comment/54\",[]],[\"name/55\",[23,70.048]],[\"comment/55\",[]],[\"name/56\",[16,64.938]],[\"comment/56\",[]],[\"name/57\",[24,70.048]],[\"comment/57\",[]],[\"name/58\",[25,70.048]],[\"comment/58\",[]],[\"name/59\",[5,21.132]],[\"comment/59\",[]],[\"name/60\",[19,64.938]],[\"comment/60\",[]],[\"name/61\",[18,64.938]],[\"comment/61\",[]],[\"name/62\",[20,64.938]],[\"comment/62\",[]],[\"name/63\",[26,70.048]],[\"comment/63\",[]],[\"name/64\",[5,21.132]],[\"comment/64\",[]],[\"name/65\",[6,37.851]],[\"comment/65\",[]],[\"name/66\",[7,42.109]],[\"comment/66\",[]],[\"name/67\",[8,42.961]],[\"comment/67\",[]],[\"name/68\",[5,21.132]],[\"comment/68\",[]],[\"name/69\",[27,70.048]],[\"comment/69\",[]],[\"name/70\",[15,61.573]],[\"comment/70\",[]],[\"name/71\",[28,70.048]],[\"comment/71\",[]],[\"name/72\",[5,21.132]],[\"comment/72\",[]],[\"name/73\",[6,37.851]],[\"comment/73\",[]],[\"name/74\",[7,42.109]],[\"comment/74\",[]],[\"name/75\",[8,42.961]],[\"comment/75\",[]],[\"name/76\",[5,21.132]],[\"comment/76\",[]],[\"name/77\",[29,70.048]],[\"comment/77\",[]],[\"name/78\",[30,70.048]],[\"comment/78\",[]],[\"name/79\",[31,55.381]],[\"comment/79\",[]],[\"name/80\",[32,59.059]],[\"comment/80\",[]],[\"name/81\",[33,64.938]],[\"comment/81\",[]],[\"name/82\",[34,70.048]],[\"comment/82\",[]],[\"name/83\",[35,70.048]],[\"comment/83\",[]],[\"name/84\",[5,21.132]],[\"comment/84\",[]],[\"name/85\",[6,37.851]],[\"comment/85\",[]],[\"name/86\",[7,42.109]],[\"comment/86\",[]],[\"name/87\",[8,42.961]],[\"comment/87\",[]],[\"name/88\",[5,21.132]],[\"comment/88\",[]],[\"name/89\",[36,70.048]],[\"comment/89\",[]],[\"name/90\",[37,70.048]],[\"comment/90\",[]],[\"name/91\",[5,21.132]],[\"comment/91\",[]],[\"name/92\",[6,37.851]],[\"comment/92\",[]],[\"name/93\",[7,42.109]],[\"comment/93\",[]],[\"name/94\",[8,42.961]],[\"comment/94\",[]],[\"name/95\",[5,21.132]],[\"comment/95\",[]],[\"name/96\",[22,64.938]],[\"comment/96\",[]],[\"name/97\",[38,70.048]],[\"comment/97\",[]],[\"name/98\",[39,70.048]],[\"comment/98\",[]],[\"name/99\",[5,21.132]],[\"comment/99\",[]],[\"name/100\",[6,37.851]],[\"comment/100\",[]],[\"name/101\",[7,42.109]],[\"comment/101\",[]],[\"name/102\",[8,42.961]],[\"comment/102\",[]],[\"name/103\",[5,21.132]],[\"comment/103\",[]],[\"name/104\",[13,59.059]],[\"comment/104\",[]],[\"name/105\",[40,70.048]],[\"comment/105\",[]],[\"name/106\",[5,21.132]],[\"comment/106\",[]],[\"name/107\",[6,37.851]],[\"comment/107\",[]],[\"name/108\",[7,42.109]],[\"comment/108\",[]],[\"name/109\",[8,42.961]],[\"comment/109\",[]],[\"name/110\",[5,21.132]],[\"comment/110\",[]],[\"name/111\",[0,51.585]],[\"comment/111\",[]],[\"name/112\",[41,70.048]],[\"comment/112\",[]],[\"name/113\",[42,70.048]],[\"comment/113\",[]],[\"name/114\",[5,21.132]],[\"comment/114\",[]],[\"name/115\",[6,37.851]],[\"comment/115\",[]],[\"name/116\",[7,42.109]],[\"comment/116\",[]],[\"name/117\",[8,42.961]],[\"comment/117\",[]],[\"name/118\",[5,21.132]],[\"comment/118\",[]],[\"name/119\",[43,64.938]],[\"comment/119\",[]],[\"name/120\",[44,64.938]],[\"comment/120\",[]],[\"name/121\",[45,64.938]],[\"comment/121\",[]],[\"name/122\",[46,70.048]],[\"comment/122\",[]],[\"name/123\",[5,21.132]],[\"comment/123\",[]],[\"name/124\",[6,37.851]],[\"comment/124\",[]],[\"name/125\",[7,42.109]],[\"comment/125\",[]],[\"name/126\",[8,42.961]],[\"comment/126\",[]],[\"name/127\",[5,21.132]],[\"comment/127\",[]],[\"name/128\",[43,64.938]],[\"comment/128\",[]],[\"name/129\",[44,64.938]],[\"comment/129\",[]],[\"name/130\",[47,70.048]],[\"comment/130\",[]],[\"name/131\",[5,21.132]],[\"comment/131\",[]],[\"name/132\",[6,37.851]],[\"comment/132\",[]],[\"name/133\",[7,42.109]],[\"comment/133\",[]],[\"name/134\",[8,42.961]],[\"comment/134\",[]],[\"name/135\",[5,21.132]],[\"comment/135\",[]],[\"name/136\",[48,70.048]],[\"comment/136\",[]],[\"name/137\",[0,51.585]],[\"comment/137\",[]],[\"name/138\",[49,70.048]],[\"comment/138\",[]],[\"name/139\",[5,21.132]],[\"comment/139\",[]],[\"name/140\",[6,37.851]],[\"comment/140\",[]],[\"name/141\",[7,42.109]],[\"comment/141\",[]],[\"name/142\",[8,42.961]],[\"comment/142\",[]],[\"name/143\",[5,21.132]],[\"comment/143\",[]],[\"name/144\",[6,37.851]],[\"comment/144\",[]],[\"name/145\",[50,59.059]],[\"comment/145\",[]],[\"name/146\",[5,21.132]],[\"comment/146\",[]],[\"name/147\",[51,64.938]],[\"comment/147\",[]],[\"name/148\",[52,61.573]],[\"comment/148\",[]],[\"name/149\",[53,61.573]],[\"comment/149\",[]],[\"name/150\",[54,70.048]],[\"comment/150\",[]],[\"name/151\",[5,21.132]],[\"comment/151\",[]],[\"name/152\",[6,37.851]],[\"comment/152\",[]],[\"name/153\",[7,42.109]],[\"comment/153\",[]],[\"name/154\",[8,42.961]],[\"comment/154\",[]],[\"name/155\",[5,21.132]],[\"comment/155\",[]],[\"name/156\",[55,70.048]],[\"comment/156\",[]],[\"name/157\",[56,70.048]],[\"comment/157\",[]],[\"name/158\",[50,59.059]],[\"comment/158\",[]],[\"name/159\",[5,21.132]],[\"comment/159\",[]],[\"name/160\",[57,70.048]],[\"comment/160\",[]],[\"name/161\",[52,61.573]],[\"comment/161\",[]],[\"name/162\",[53,61.573]],[\"comment/162\",[]],[\"name/163\",[58,70.048]],[\"comment/163\",[]],[\"name/164\",[5,21.132]],[\"comment/164\",[]],[\"name/165\",[6,37.851]],[\"comment/165\",[]],[\"name/166\",[7,42.109]],[\"comment/166\",[]],[\"name/167\",[8,42.961]],[\"comment/167\",[]],[\"name/168\",[5,21.132]],[\"comment/168\",[]],[\"name/169\",[6,37.851]],[\"comment/169\",[]],[\"name/170\",[50,59.059]],[\"comment/170\",[]],[\"name/171\",[5,21.132]],[\"comment/171\",[]],[\"name/172\",[51,64.938]],[\"comment/172\",[]],[\"name/173\",[52,61.573]],[\"comment/173\",[]],[\"name/174\",[53,61.573]],[\"comment/174\",[]],[\"name/175\",[59,70.048]],[\"comment/175\",[]],[\"name/176\",[60,70.048]],[\"comment/176\",[]],[\"name/177\",[5,21.132]],[\"comment/177\",[]],[\"name/178\",[61,38.122]],[\"comment/178\",[]],[\"name/179\",[7,42.109]],[\"comment/179\",[]],[\"name/180\",[62,70.048]],[\"comment/180\",[]],[\"name/181\",[63,70.048]],[\"comment/181\",[]],[\"name/182\",[64,70.048]],[\"comment/182\",[]],[\"name/183\",[65,70.048]],[\"comment/183\",[]],[\"name/184\",[66,70.048]],[\"comment/184\",[]],[\"name/185\",[67,70.048]],[\"comment/185\",[]],[\"name/186\",[68,70.048]],[\"comment/186\",[]],[\"name/187\",[69,70.048]],[\"comment/187\",[]],[\"name/188\",[70,70.048]],[\"comment/188\",[]],[\"name/189\",[71,70.048]],[\"comment/189\",[]],[\"name/190\",[72,70.048]],[\"comment/190\",[]],[\"name/191\",[73,70.048]],[\"comment/191\",[]],[\"name/192\",[74,70.048]],[\"comment/192\",[]],[\"name/193\",[75,70.048]],[\"comment/193\",[]],[\"name/194\",[76,70.048]],[\"comment/194\",[]],[\"name/195\",[77,70.048]],[\"comment/195\",[]],[\"name/196\",[78,70.048]],[\"comment/196\",[]],[\"name/197\",[79,70.048]],[\"comment/197\",[]],[\"name/198\",[80,70.048]],[\"comment/198\",[]],[\"name/199\",[81,70.048]],[\"comment/199\",[]],[\"name/200\",[0,51.585]],[\"comment/200\",[]],[\"name/201\",[61,38.122]],[\"comment/201\",[]],[\"name/202\",[82,53.95]],[\"comment/202\",[]],[\"name/203\",[83,52.698]],[\"comment/203\",[]],[\"name/204\",[84,57.052]],[\"comment/204\",[]],[\"name/205\",[85,57.052]],[\"comment/205\",[]],[\"name/206\",[86,61.573]],[\"comment/206\",[]],[\"name/207\",[87,70.048]],[\"comment/207\",[]],[\"name/208\",[88,70.048]],[\"comment/208\",[]],[\"name/209\",[86,61.573]],[\"comment/209\",[]],[\"name/210\",[89,70.048]],[\"comment/210\",[]],[\"name/211\",[90,70.048]],[\"comment/211\",[]],[\"name/212\",[91,70.048]],[\"comment/212\",[]],[\"name/213\",[92,61.573]],[\"comment/213\",[]],[\"name/214\",[93,61.573]],[\"comment/214\",[]],[\"name/215\",[6,37.851]],[\"comment/215\",[]],[\"name/216\",[94,70.048]],[\"comment/216\",[]],[\"name/217\",[95,70.048]],[\"comment/217\",[]],[\"name/218\",[96,51.585]],[\"comment/218\",[]],[\"name/219\",[97,70.048]],[\"comment/219\",[]],[\"name/220\",[98,70.048]],[\"comment/220\",[]],[\"name/221\",[99,70.048]],[\"comment/221\",[]],[\"name/222\",[61,38.122]],[\"comment/222\",[]],[\"name/223\",[100,70.048]],[\"comment/223\",[]],[\"name/224\",[101,70.048]],[\"comment/224\",[]],[\"name/225\",[102,70.048]],[\"comment/225\",[]],[\"name/226\",[103,70.048]],[\"comment/226\",[]],[\"name/227\",[104,70.048]],[\"comment/227\",[]],[\"name/228\",[105,70.048]],[\"comment/228\",[]],[\"name/229\",[106,70.048]],[\"comment/229\",[]],[\"name/230\",[107,70.048]],[\"comment/230\",[]],[\"name/231\",[108,64.938]],[\"comment/231\",[]],[\"name/232\",[109,70.048]],[\"comment/232\",[]],[\"name/233\",[110,70.048]],[\"comment/233\",[]],[\"name/234\",[111,61.573]],[\"comment/234\",[]],[\"name/235\",[112,70.048]],[\"comment/235\",[]],[\"name/236\",[113,70.048]],[\"comment/236\",[]],[\"name/237\",[114,70.048]],[\"comment/237\",[]],[\"name/238\",[115,70.048]],[\"comment/238\",[]],[\"name/239\",[5,21.132]],[\"comment/239\",[]],[\"name/240\",[116,53.95]],[\"comment/240\",[]],[\"name/241\",[117,64.938]],[\"comment/241\",[]],[\"name/242\",[118,61.573]],[\"comment/242\",[]],[\"name/243\",[119,70.048]],[\"comment/243\",[]],[\"name/244\",[120,70.048]],[\"comment/244\",[]],[\"name/245\",[5,21.132]],[\"comment/245\",[]],[\"name/246\",[61,38.122]],[\"comment/246\",[]],[\"name/247\",[121,64.938]],[\"comment/247\",[]],[\"name/248\",[122,61.573]],[\"comment/248\",[]],[\"name/249\",[123,64.938]],[\"comment/249\",[]],[\"name/250\",[31,55.381]],[\"comment/250\",[]],[\"name/251\",[124,61.573]],[\"comment/251\",[]],[\"name/252\",[125,70.048]],[\"comment/252\",[]],[\"name/253\",[5,21.132]],[\"comment/253\",[]],[\"name/254\",[61,38.122]],[\"comment/254\",[]],[\"name/255\",[126,64.938]],[\"comment/255\",[]],[\"name/256\",[127,64.938]],[\"comment/256\",[]],[\"name/257\",[6,37.851]],[\"comment/257\",[]],[\"name/258\",[128,70.048]],[\"comment/258\",[]],[\"name/259\",[5,21.132]],[\"comment/259\",[]],[\"name/260\",[6,37.851]],[\"comment/260\",[]],[\"name/261\",[129,64.938]],[\"comment/261\",[]],[\"name/262\",[130,64.938]],[\"comment/262\",[]],[\"name/263\",[131,61.573]],[\"comment/263\",[]],[\"name/264\",[132,70.048]],[\"comment/264\",[]],[\"name/265\",[133,70.048]],[\"comment/265\",[]],[\"name/266\",[5,21.132]],[\"comment/266\",[]],[\"name/267\",[6,37.851]],[\"comment/267\",[]],[\"name/268\",[134,64.938]],[\"comment/268\",[]],[\"name/269\",[135,57.052]],[\"comment/269\",[]],[\"name/270\",[136,61.573]],[\"comment/270\",[]],[\"name/271\",[137,70.048]],[\"comment/271\",[]],[\"name/272\",[5,21.132]],[\"comment/272\",[]],[\"name/273\",[138,70.048]],[\"comment/273\",[]],[\"name/274\",[139,46.063]],[\"comment/274\",[]],[\"name/275\",[140,64.938]],[\"comment/275\",[]],[\"name/276\",[141,61.573]],[\"comment/276\",[]],[\"name/277\",[142,53.95]],[\"comment/277\",[]],[\"name/278\",[143,59.059]],[\"comment/278\",[]],[\"name/279\",[144,64.938]],[\"comment/279\",[]],[\"name/280\",[145,53.95]],[\"comment/280\",[]],[\"name/281\",[111,61.573]],[\"comment/281\",[]],[\"name/282\",[146,64.938]],[\"comment/282\",[]],[\"name/283\",[147,64.938]],[\"comment/283\",[]],[\"name/284\",[148,59.059]],[\"comment/284\",[]],[\"name/285\",[149,61.573]],[\"comment/285\",[]],[\"name/286\",[150,59.059]],[\"comment/286\",[]],[\"name/287\",[151,70.048]],[\"comment/287\",[]],[\"name/288\",[152,61.573]],[\"comment/288\",[]],[\"name/289\",[153,61.573]],[\"comment/289\",[]],[\"name/290\",[154,70.048]],[\"comment/290\",[]],[\"name/291\",[5,21.132]],[\"comment/291\",[]],[\"name/292\",[61,38.122]],[\"comment/292\",[]],[\"name/293\",[121,64.938]],[\"comment/293\",[]],[\"name/294\",[122,61.573]],[\"comment/294\",[]],[\"name/295\",[123,64.938]],[\"comment/295\",[]],[\"name/296\",[31,55.381]],[\"comment/296\",[]],[\"name/297\",[124,61.573]],[\"comment/297\",[]],[\"name/298\",[155,70.048]],[\"comment/298\",[]],[\"name/299\",[5,21.132]],[\"comment/299\",[]],[\"name/300\",[134,64.938]],[\"comment/300\",[]],[\"name/301\",[135,57.052]],[\"comment/301\",[]],[\"name/302\",[136,61.573]],[\"comment/302\",[]],[\"name/303\",[156,70.048]],[\"comment/303\",[]],[\"name/304\",[5,21.132]],[\"comment/304\",[]],[\"name/305\",[139,46.063]],[\"comment/305\",[]],[\"name/306\",[145,53.95]],[\"comment/306\",[]],[\"name/307\",[142,53.95]],[\"comment/307\",[]],[\"name/308\",[141,61.573]],[\"comment/308\",[]],[\"name/309\",[149,61.573]],[\"comment/309\",[]],[\"name/310\",[150,59.059]],[\"comment/310\",[]],[\"name/311\",[157,70.048]],[\"comment/311\",[]],[\"name/312\",[5,21.132]],[\"comment/312\",[]],[\"name/313\",[158,70.048]],[\"comment/313\",[]],[\"name/314\",[159,70.048]],[\"comment/314\",[]],[\"name/315\",[160,70.048]],[\"comment/315\",[]],[\"name/316\",[5,21.132]],[\"comment/316\",[]],[\"name/317\",[161,64.938]],[\"comment/317\",[]],[\"name/318\",[162,70.048]],[\"comment/318\",[]],[\"name/319\",[5,21.132]],[\"comment/319\",[]],[\"name/320\",[6,37.851]],[\"comment/320\",[]],[\"name/321\",[129,64.938]],[\"comment/321\",[]],[\"name/322\",[130,64.938]],[\"comment/322\",[]],[\"name/323\",[131,61.573]],[\"comment/323\",[]],[\"name/324\",[163,70.048]],[\"comment/324\",[]],[\"name/325\",[5,21.132]],[\"comment/325\",[]],[\"name/326\",[139,46.063]],[\"comment/326\",[]],[\"name/327\",[140,64.938]],[\"comment/327\",[]],[\"name/328\",[141,61.573]],[\"comment/328\",[]],[\"name/329\",[164,70.048]],[\"comment/329\",[]],[\"name/330\",[165,70.048]],[\"comment/330\",[]],[\"name/331\",[143,59.059]],[\"comment/331\",[]],[\"name/332\",[144,64.938]],[\"comment/332\",[]],[\"name/333\",[145,53.95]],[\"comment/333\",[]],[\"name/334\",[142,53.95]],[\"comment/334\",[]],[\"name/335\",[111,61.573]],[\"comment/335\",[]],[\"name/336\",[146,64.938]],[\"comment/336\",[]],[\"name/337\",[147,64.938]],[\"comment/337\",[]],[\"name/338\",[148,59.059]],[\"comment/338\",[]],[\"name/339\",[149,61.573]],[\"comment/339\",[]],[\"name/340\",[150,59.059]],[\"comment/340\",[]],[\"name/341\",[166,70.048]],[\"comment/341\",[]],[\"name/342\",[5,21.132]],[\"comment/342\",[]],[\"name/343\",[167,57.052]],[\"comment/343\",[]],[\"name/344\",[168,64.938]],[\"comment/344\",[]],[\"name/345\",[169,70.048]],[\"comment/345\",[]],[\"name/346\",[5,21.132]],[\"comment/346\",[]],[\"name/347\",[170,64.938]],[\"comment/347\",[]],[\"name/348\",[171,51.585]],[\"comment/348\",[]],[\"name/349\",[167,57.052]],[\"comment/349\",[]],[\"name/350\",[168,64.938]],[\"comment/350\",[]],[\"name/351\",[172,70.048]],[\"comment/351\",[]],[\"name/352\",[5,21.132]],[\"comment/352\",[]],[\"name/353\",[171,51.585]],[\"comment/353\",[]],[\"name/354\",[173,70.048]],[\"comment/354\",[]],[\"name/355\",[5,21.132]],[\"comment/355\",[]],[\"name/356\",[139,46.063]],[\"comment/356\",[]],[\"name/357\",[174,57.052]],[\"comment/357\",[]],[\"name/358\",[175,57.052]],[\"comment/358\",[]],[\"name/359\",[176,53.95]],[\"comment/359\",[]],[\"name/360\",[177,70.048]],[\"comment/360\",[]],[\"name/361\",[178,61.573]],[\"comment/361\",[]],[\"name/362\",[179,59.059]],[\"comment/362\",[]],[\"name/363\",[180,70.048]],[\"comment/363\",[]],[\"name/364\",[5,21.132]],[\"comment/364\",[]],[\"name/365\",[139,46.063]],[\"comment/365\",[]],[\"name/366\",[174,57.052]],[\"comment/366\",[]],[\"name/367\",[175,57.052]],[\"comment/367\",[]],[\"name/368\",[181,64.938]],[\"comment/368\",[]],[\"name/369\",[176,53.95]],[\"comment/369\",[]],[\"name/370\",[167,57.052]],[\"comment/370\",[]],[\"name/371\",[179,59.059]],[\"comment/371\",[]],[\"name/372\",[182,70.048]],[\"comment/372\",[]],[\"name/373\",[5,21.132]],[\"comment/373\",[]],[\"name/374\",[139,46.063]],[\"comment/374\",[]],[\"name/375\",[174,57.052]],[\"comment/375\",[]],[\"name/376\",[175,57.052]],[\"comment/376\",[]],[\"name/377\",[181,64.938]],[\"comment/377\",[]],[\"name/378\",[176,53.95]],[\"comment/378\",[]],[\"name/379\",[31,55.381]],[\"comment/379\",[]],[\"name/380\",[178,61.573]],[\"comment/380\",[]],[\"name/381\",[167,57.052]],[\"comment/381\",[]],[\"name/382\",[179,59.059]],[\"comment/382\",[]],[\"name/383\",[183,70.048]],[\"comment/383\",[]],[\"name/384\",[5,21.132]],[\"comment/384\",[]],[\"name/385\",[139,46.063]],[\"comment/385\",[]],[\"name/386\",[176,53.95]],[\"comment/386\",[]],[\"name/387\",[174,57.052]],[\"comment/387\",[]],[\"name/388\",[167,57.052]],[\"comment/388\",[]],[\"name/389\",[179,59.059]],[\"comment/389\",[]],[\"name/390\",[184,70.048]],[\"comment/390\",[]],[\"name/391\",[5,21.132]],[\"comment/391\",[]],[\"name/392\",[185,70.048]],[\"comment/392\",[]],[\"name/393\",[186,70.048]],[\"comment/393\",[]],[\"name/394\",[122,61.573]],[\"comment/394\",[]],[\"name/395\",[139,46.063]],[\"comment/395\",[]],[\"name/396\",[187,70.048]],[\"comment/396\",[]],[\"name/397\",[188,70.048]],[\"comment/397\",[]],[\"name/398\",[189,61.573]],[\"comment/398\",[]],[\"name/399\",[190,70.048]],[\"comment/399\",[]],[\"name/400\",[5,21.132]],[\"comment/400\",[]],[\"name/401\",[171,51.585]],[\"comment/401\",[]],[\"name/402\",[191,70.048]],[\"comment/402\",[]],[\"name/403\",[5,21.132]],[\"comment/403\",[]],[\"name/404\",[192,61.573]],[\"comment/404\",[]],[\"name/405\",[193,57.052]],[\"comment/405\",[]],[\"name/406\",[32,59.059]],[\"comment/406\",[]],[\"name/407\",[194,61.573]],[\"comment/407\",[]],[\"name/408\",[195,70.048]],[\"comment/408\",[]],[\"name/409\",[5,21.132]],[\"comment/409\",[]],[\"name/410\",[192,61.573]],[\"comment/410\",[]],[\"name/411\",[193,57.052]],[\"comment/411\",[]],[\"name/412\",[32,59.059]],[\"comment/412\",[]],[\"name/413\",[194,61.573]],[\"comment/413\",[]],[\"name/414\",[196,61.573]],[\"comment/414\",[]],[\"name/415\",[197,70.048]],[\"comment/415\",[]],[\"name/416\",[5,21.132]],[\"comment/416\",[]],[\"name/417\",[31,55.381]],[\"comment/417\",[]],[\"name/418\",[139,46.063]],[\"comment/418\",[]],[\"name/419\",[193,57.052]],[\"comment/419\",[]],[\"name/420\",[178,61.573]],[\"comment/420\",[]],[\"name/421\",[198,70.048]],[\"comment/421\",[]],[\"name/422\",[5,21.132]],[\"comment/422\",[]],[\"name/423\",[139,46.063]],[\"comment/423\",[]],[\"name/424\",[193,57.052]],[\"comment/424\",[]],[\"name/425\",[199,70.048]],[\"comment/425\",[]],[\"name/426\",[200,70.048]],[\"comment/426\",[]],[\"name/427\",[5,21.132]],[\"comment/427\",[]],[\"name/428\",[176,53.95]],[\"comment/428\",[]],[\"name/429\",[174,57.052]],[\"comment/429\",[]],[\"name/430\",[139,46.063]],[\"comment/430\",[]],[\"name/431\",[201,70.048]],[\"comment/431\",[]],[\"name/432\",[5,21.132]],[\"comment/432\",[]],[\"name/433\",[202,55.381]],[\"comment/433\",[]],[\"name/434\",[193,57.052]],[\"comment/434\",[]],[\"name/435\",[192,61.573]],[\"comment/435\",[]],[\"name/436\",[203,70.048]],[\"comment/436\",[]],[\"name/437\",[5,21.132]],[\"comment/437\",[]],[\"name/438\",[204,70.048]],[\"comment/438\",[]],[\"name/439\",[205,70.048]],[\"comment/439\",[]],[\"name/440\",[206,64.938]],[\"comment/440\",[]],[\"name/441\",[207,70.048]],[\"comment/441\",[]],[\"name/442\",[208,70.048]],[\"comment/442\",[]],[\"name/443\",[209,61.573]],[\"comment/443\",[]],[\"name/444\",[210,70.048]],[\"comment/444\",[]],[\"name/445\",[211,70.048]],[\"comment/445\",[]],[\"name/446\",[212,70.048]],[\"comment/446\",[]],[\"name/447\",[213,70.048]],[\"comment/447\",[]],[\"name/448\",[5,21.132]],[\"comment/448\",[]],[\"name/449\",[214,70.048]],[\"comment/449\",[]],[\"name/450\",[215,61.573]],[\"comment/450\",[]],[\"name/451\",[216,70.048]],[\"comment/451\",[]],[\"name/452\",[217,70.048]],[\"comment/452\",[]],[\"name/453\",[218,70.048]],[\"comment/453\",[]],[\"name/454\",[219,70.048]],[\"comment/454\",[]],[\"name/455\",[5,21.132]],[\"comment/455\",[]],[\"name/456\",[116,53.95]],[\"comment/456\",[]],[\"name/457\",[220,70.048]],[\"comment/457\",[]],[\"name/458\",[221,70.048]],[\"comment/458\",[]],[\"name/459\",[222,70.048]],[\"comment/459\",[]],[\"name/460\",[223,64.938]],[\"comment/460\",[]],[\"name/461\",[224,64.938]],[\"comment/461\",[]],[\"name/462\",[189,61.573]],[\"comment/462\",[]],[\"name/463\",[225,70.048]],[\"comment/463\",[]],[\"name/464\",[5,21.132]],[\"comment/464\",[]],[\"name/465\",[215,61.573]],[\"comment/465\",[]],[\"name/466\",[226,55.381]],[\"comment/466\",[]],[\"name/467\",[5,21.132]],[\"comment/467\",[]],[\"name/468\",[227,64.938]],[\"comment/468\",[]],[\"name/469\",[228,64.938]],[\"comment/469\",[]],[\"name/470\",[229,70.048]],[\"comment/470\",[]],[\"name/471\",[5,21.132]],[\"comment/471\",[]],[\"name/472\",[108,64.938]],[\"comment/472\",[]],[\"name/473\",[230,70.048]],[\"comment/473\",[]],[\"name/474\",[5,21.132]],[\"comment/474\",[]],[\"name/475\",[231,70.048]],[\"comment/475\",[]],[\"name/476\",[232,70.048]],[\"comment/476\",[]],[\"name/477\",[5,21.132]],[\"comment/477\",[]],[\"name/478\",[223,64.938]],[\"comment/478\",[]],[\"name/479\",[233,70.048]],[\"comment/479\",[]],[\"name/480\",[5,21.132]],[\"comment/480\",[]],[\"name/481\",[234,70.048]],[\"comment/481\",[]],[\"name/482\",[224,64.938]],[\"comment/482\",[]],[\"name/483\",[235,70.048]],[\"comment/483\",[]],[\"name/484\",[236,70.048]],[\"comment/484\",[]],[\"name/485\",[82,53.95]],[\"comment/485\",[]],[\"name/486\",[83,52.698]],[\"comment/486\",[]],[\"name/487\",[84,57.052]],[\"comment/487\",[]],[\"name/488\",[8,42.961]],[\"comment/488\",[]],[\"name/489\",[237,57.052]],[\"comment/489\",[]],[\"name/490\",[238,64.938]],[\"comment/490\",[]],[\"name/491\",[239,64.938]],[\"comment/491\",[]],[\"name/492\",[240,64.938]],[\"comment/492\",[]],[\"name/493\",[241,61.573]],[\"comment/493\",[]],[\"name/494\",[242,64.938]],[\"comment/494\",[]],[\"name/495\",[243,61.573]],[\"comment/495\",[]],[\"name/496\",[244,64.938]],[\"comment/496\",[]],[\"name/497\",[85,57.052]],[\"comment/497\",[]],[\"name/498\",[245,64.938]],[\"comment/498\",[]],[\"name/499\",[246,64.938]],[\"comment/499\",[]],[\"name/500\",[247,64.938]],[\"comment/500\",[]],[\"name/501\",[248,61.573]],[\"comment/501\",[]],[\"name/502\",[249,61.573]],[\"comment/502\",[]],[\"name/503\",[250,59.059]],[\"comment/503\",[]],[\"name/504\",[251,64.938]],[\"comment/504\",[]],[\"name/505\",[252,59.059]],[\"comment/505\",[]],[\"name/506\",[253,64.938]],[\"comment/506\",[]],[\"name/507\",[254,59.059]],[\"comment/507\",[]],[\"name/508\",[255,64.938]],[\"comment/508\",[]],[\"name/509\",[256,59.059]],[\"comment/509\",[]],[\"name/510\",[257,64.938]],[\"comment/510\",[]],[\"name/511\",[258,64.938]],[\"comment/511\",[]],[\"name/512\",[259,61.573]],[\"comment/512\",[]],[\"name/513\",[260,59.059]],[\"comment/513\",[]],[\"name/514\",[261,64.938]],[\"comment/514\",[]],[\"name/515\",[262,64.938]],[\"comment/515\",[]],[\"name/516\",[263,64.938]],[\"comment/516\",[]],[\"name/517\",[264,64.938]],[\"comment/517\",[]],[\"name/518\",[265,64.938]],[\"comment/518\",[]],[\"name/519\",[266,64.938]],[\"comment/519\",[]],[\"name/520\",[267,64.938]],[\"comment/520\",[]],[\"name/521\",[268,64.938]],[\"comment/521\",[]],[\"name/522\",[269,64.938]],[\"comment/522\",[]],[\"name/523\",[270,57.052]],[\"comment/523\",[]],[\"name/524\",[202,55.381]],[\"comment/524\",[]],[\"name/525\",[271,64.938]],[\"comment/525\",[]],[\"name/526\",[272,64.938]],[\"comment/526\",[]],[\"name/527\",[273,64.938]],[\"comment/527\",[]],[\"name/528\",[61,38.122]],[\"comment/528\",[]],[\"name/529\",[274,64.938]],[\"comment/529\",[]],[\"name/530\",[248,61.573]],[\"comment/530\",[]],[\"name/531\",[249,61.573]],[\"comment/531\",[]],[\"name/532\",[250,59.059]],[\"comment/532\",[]],[\"name/533\",[251,64.938]],[\"comment/533\",[]],[\"name/534\",[252,59.059]],[\"comment/534\",[]],[\"name/535\",[253,64.938]],[\"comment/535\",[]],[\"name/536\",[254,59.059]],[\"comment/536\",[]],[\"name/537\",[255,64.938]],[\"comment/537\",[]],[\"name/538\",[256,59.059]],[\"comment/538\",[]],[\"name/539\",[257,64.938]],[\"comment/539\",[]],[\"name/540\",[258,64.938]],[\"comment/540\",[]],[\"name/541\",[260,59.059]],[\"comment/541\",[]],[\"name/542\",[261,64.938]],[\"comment/542\",[]],[\"name/543\",[262,64.938]],[\"comment/543\",[]],[\"name/544\",[263,64.938]],[\"comment/544\",[]],[\"name/545\",[267,64.938]],[\"comment/545\",[]],[\"name/546\",[269,64.938]],[\"comment/546\",[]],[\"name/547\",[215,61.573]],[\"comment/547\",[]],[\"name/548\",[275,70.048]],[\"comment/548\",[]],[\"name/549\",[276,70.048]],[\"comment/549\",[]],[\"name/550\",[277,64.938]],[\"comment/550\",[]],[\"name/551\",[82,53.95]],[\"comment/551\",[]],[\"name/552\",[83,52.698]],[\"comment/552\",[]],[\"name/553\",[84,57.052]],[\"comment/553\",[]],[\"name/554\",[8,42.961]],[\"comment/554\",[]],[\"name/555\",[237,57.052]],[\"comment/555\",[]],[\"name/556\",[238,64.938]],[\"comment/556\",[]],[\"name/557\",[239,64.938]],[\"comment/557\",[]],[\"name/558\",[240,64.938]],[\"comment/558\",[]],[\"name/559\",[241,61.573]],[\"comment/559\",[]],[\"name/560\",[242,64.938]],[\"comment/560\",[]],[\"name/561\",[243,61.573]],[\"comment/561\",[]],[\"name/562\",[244,64.938]],[\"comment/562\",[]],[\"name/563\",[85,57.052]],[\"comment/563\",[]],[\"name/564\",[245,64.938]],[\"comment/564\",[]],[\"name/565\",[246,64.938]],[\"comment/565\",[]],[\"name/566\",[247,64.938]],[\"comment/566\",[]],[\"name/567\",[259,61.573]],[\"comment/567\",[]],[\"name/568\",[264,64.938]],[\"comment/568\",[]],[\"name/569\",[265,64.938]],[\"comment/569\",[]],[\"name/570\",[266,64.938]],[\"comment/570\",[]],[\"name/571\",[268,64.938]],[\"comment/571\",[]],[\"name/572\",[270,57.052]],[\"comment/572\",[]],[\"name/573\",[202,55.381]],[\"comment/573\",[]],[\"name/574\",[271,64.938]],[\"comment/574\",[]],[\"name/575\",[272,64.938]],[\"comment/575\",[]],[\"name/576\",[273,64.938]],[\"comment/576\",[]],[\"name/577\",[61,38.122]],[\"comment/577\",[]],[\"name/578\",[278,70.048]],[\"comment/578\",[]],[\"name/579\",[279,64.938]],[\"comment/579\",[]],[\"name/580\",[280,61.573]],[\"comment/580\",[]],[\"name/581\",[281,70.048]],[\"comment/581\",[]],[\"name/582\",[282,70.048]],[\"comment/582\",[]],[\"name/583\",[5,21.132]],[\"comment/583\",[]],[\"name/584\",[116,53.95]],[\"comment/584\",[]],[\"name/585\",[283,53.95]],[\"comment/585\",[]],[\"name/586\",[284,70.048]],[\"comment/586\",[]],[\"name/587\",[285,70.048]],[\"comment/587\",[]],[\"name/588\",[5,21.132]],[\"comment/588\",[]],[\"name/589\",[286,64.938]],[\"comment/589\",[]],[\"name/590\",[287,70.048]],[\"comment/590\",[]],[\"name/591\",[288,70.048]],[\"comment/591\",[]],[\"name/592\",[5,21.132]],[\"comment/592\",[]],[\"name/593\",[289,70.048]],[\"comment/593\",[]],[\"name/594\",[290,70.048]],[\"comment/594\",[]],[\"name/595\",[5,21.132]],[\"comment/595\",[]],[\"name/596\",[291,70.048]],[\"comment/596\",[]],[\"name/597\",[292,59.059]],[\"comment/597\",[]],[\"name/598\",[293,70.048]],[\"comment/598\",[]],[\"name/599\",[5,21.132]],[\"comment/599\",[]],[\"name/600\",[294,70.048]],[\"comment/600\",[]],[\"name/601\",[295,70.048]],[\"comment/601\",[]],[\"name/602\",[296,70.048]],[\"comment/602\",[]],[\"name/603\",[297,70.048]],[\"comment/603\",[]],[\"name/604\",[5,21.132]],[\"comment/604\",[]],[\"name/605\",[298,70.048]],[\"comment/605\",[]],[\"name/606\",[5,21.132]],[\"comment/606\",[]],[\"name/607\",[299,70.048]],[\"comment/607\",[]],[\"name/608\",[5,21.132]],[\"comment/608\",[]],[\"name/609\",[300,70.048]],[\"comment/609\",[]],[\"name/610\",[5,21.132]],[\"comment/610\",[]],[\"name/611\",[301,70.048]],[\"comment/611\",[]],[\"name/612\",[302,70.048]],[\"comment/612\",[]],[\"name/613\",[303,70.048]],[\"comment/613\",[]],[\"name/614\",[304,70.048]],[\"comment/614\",[]],[\"name/615\",[171,51.585]],[\"comment/615\",[]],[\"name/616\",[305,61.573]],[\"comment/616\",[]],[\"name/617\",[280,61.573]],[\"comment/617\",[]],[\"name/618\",[292,59.059]],[\"comment/618\",[]],[\"name/619\",[306,70.048]],[\"comment/619\",[]],[\"name/620\",[307,57.052]],[\"comment/620\",[]],[\"name/621\",[308,70.048]],[\"comment/621\",[]],[\"name/622\",[309,64.938]],[\"comment/622\",[]],[\"name/623\",[310,70.048]],[\"comment/623\",[]],[\"name/624\",[5,21.132]],[\"comment/624\",[]],[\"name/625\",[311,70.048]],[\"comment/625\",[]],[\"name/626\",[312,70.048]],[\"comment/626\",[]],[\"name/627\",[313,70.048]],[\"comment/627\",[]],[\"name/628\",[314,70.048]],[\"comment/628\",[]],[\"name/629\",[279,64.938]],[\"comment/629\",[]],[\"name/630\",[315,70.048]],[\"comment/630\",[]],[\"name/631\",[305,61.573]],[\"comment/631\",[]],[\"name/632\",[316,70.048]],[\"comment/632\",[]],[\"name/633\",[309,64.938]],[\"comment/633\",[]],[\"name/634\",[280,61.573]],[\"comment/634\",[]],[\"name/635\",[317,70.048]],[\"comment/635\",[]],[\"name/636\",[318,70.048]],[\"comment/636\",[]],[\"name/637\",[319,70.048]],[\"comment/637\",[]],[\"name/638\",[320,70.048]],[\"comment/638\",[]],[\"name/639\",[321,61.573]],[\"comment/639\",[]],[\"name/640\",[322,64.938]],[\"comment/640\",[]],[\"name/641\",[323,64.938]],[\"comment/641\",[]],[\"name/642\",[226,55.381]],[\"comment/642\",[]],[\"name/643\",[324,70.048]],[\"comment/643\",[]],[\"name/644\",[325,70.048]],[\"comment/644\",[]],[\"name/645\",[326,70.048]],[\"comment/645\",[]],[\"name/646\",[327,70.048]],[\"comment/646\",[]],[\"name/647\",[328,70.048]],[\"comment/647\",[]],[\"name/648\",[329,70.048]],[\"comment/648\",[]],[\"name/649\",[330,70.048]],[\"comment/649\",[]],[\"name/650\",[331,70.048]],[\"comment/650\",[]],[\"name/651\",[227,64.938]],[\"comment/651\",[]],[\"name/652\",[228,64.938]],[\"comment/652\",[]],[\"name/653\",[332,61.573]],[\"comment/653\",[]],[\"name/654\",[333,64.938]],[\"comment/654\",[]],[\"name/655\",[334,64.938]],[\"comment/655\",[]],[\"name/656\",[335,70.048]],[\"comment/656\",[]],[\"name/657\",[336,64.938]],[\"comment/657\",[]],[\"name/658\",[337,70.048]],[\"comment/658\",[]],[\"name/659\",[338,70.048]],[\"comment/659\",[]],[\"name/660\",[339,55.381]],[\"comment/660\",[]],[\"name/661\",[237,57.052]],[\"comment/661\",[]],[\"name/662\",[340,70.048]],[\"comment/662\",[]],[\"name/663\",[341,64.938]],[\"comment/663\",[]],[\"name/664\",[342,70.048]],[\"comment/664\",[]],[\"name/665\",[260,59.059]],[\"comment/665\",[]],[\"name/666\",[343,64.938]],[\"comment/666\",[]],[\"name/667\",[344,64.938]],[\"comment/667\",[]],[\"name/668\",[345,64.938]],[\"comment/668\",[]],[\"name/669\",[346,64.938]],[\"comment/669\",[]],[\"name/670\",[347,64.938]],[\"comment/670\",[]],[\"name/671\",[348,64.938]],[\"comment/671\",[]],[\"name/672\",[349,64.938]],[\"comment/672\",[]],[\"name/673\",[350,70.048]],[\"comment/673\",[]],[\"name/674\",[351,70.048]],[\"comment/674\",[]],[\"name/675\",[339,55.381]],[\"comment/675\",[]],[\"name/676\",[237,57.052]],[\"comment/676\",[]],[\"name/677\",[341,64.938]],[\"comment/677\",[]],[\"name/678\",[260,59.059]],[\"comment/678\",[]],[\"name/679\",[343,64.938]],[\"comment/679\",[]],[\"name/680\",[344,64.938]],[\"comment/680\",[]],[\"name/681\",[345,64.938]],[\"comment/681\",[]],[\"name/682\",[346,64.938]],[\"comment/682\",[]],[\"name/683\",[347,64.938]],[\"comment/683\",[]],[\"name/684\",[348,64.938]],[\"comment/684\",[]],[\"name/685\",[349,64.938]],[\"comment/685\",[]],[\"name/686\",[352,55.381]],[\"comment/686\",[]],[\"name/687\",[353,70.048]],[\"comment/687\",[]],[\"name/688\",[354,70.048]],[\"comment/688\",[]],[\"name/689\",[5,21.132]],[\"comment/689\",[]],[\"name/690\",[355,70.048]],[\"comment/690\",[]],[\"name/691\",[356,70.048]],[\"comment/691\",[]],[\"name/692\",[357,70.048]],[\"comment/692\",[]],[\"name/693\",[358,70.048]],[\"comment/693\",[]],[\"name/694\",[5,21.132]],[\"comment/694\",[]],[\"name/695\",[359,70.048]],[\"comment/695\",[]],[\"name/696\",[171,51.585]],[\"comment/696\",[]],[\"name/697\",[139,46.063]],[\"comment/697\",[]],[\"name/698\",[360,70.048]],[\"comment/698\",[]],[\"name/699\",[361,64.938]],[\"comment/699\",[]],[\"name/700\",[362,70.048]],[\"comment/700\",[]],[\"name/701\",[5,21.132]],[\"comment/701\",[]],[\"name/702\",[171,51.585]],[\"comment/702\",[]],[\"name/703\",[363,70.048]],[\"comment/703\",[]],[\"name/704\",[292,59.059]],[\"comment/704\",[]],[\"name/705\",[305,61.573]],[\"comment/705\",[]],[\"name/706\",[237,57.052]],[\"comment/706\",[]],[\"name/707\",[32,59.059]],[\"comment/707\",[]],[\"name/708\",[364,52.698]],[\"comment/708\",[]],[\"name/709\",[33,64.938]],[\"comment/709\",[]],[\"name/710\",[365,70.048]],[\"comment/710\",[]],[\"name/711\",[194,61.573]],[\"comment/711\",[]],[\"name/712\",[124,61.573]],[\"comment/712\",[]],[\"name/713\",[323,64.938]],[\"comment/713\",[]],[\"name/714\",[196,61.573]],[\"comment/714\",[]],[\"name/715\",[366,70.048]],[\"comment/715\",[]],[\"name/716\",[334,64.938]],[\"comment/716\",[]],[\"name/717\",[367,70.048]],[\"comment/717\",[]],[\"name/718\",[368,64.938]],[\"comment/718\",[]],[\"name/719\",[5,21.132]],[\"comment/719\",[]],[\"name/720\",[369,61.573]],[\"comment/720\",[]],[\"name/721\",[370,70.048]],[\"comment/721\",[]],[\"name/722\",[371,70.048]],[\"comment/722\",[]],[\"name/723\",[361,64.938]],[\"comment/723\",[]],[\"name/724\",[372,70.048]],[\"comment/724\",[]],[\"name/725\",[373,70.048]],[\"comment/725\",[]],[\"name/726\",[374,70.048]],[\"comment/726\",[]],[\"name/727\",[375,70.048]],[\"comment/727\",[]],[\"name/728\",[376,70.048]],[\"comment/728\",[]],[\"name/729\",[5,21.132]],[\"comment/729\",[]],[\"name/730\",[368,64.938]],[\"comment/730\",[]],[\"name/731\",[5,21.132]],[\"comment/731\",[]],[\"name/732\",[369,61.573]],[\"comment/732\",[]],[\"name/733\",[377,70.048]],[\"comment/733\",[]],[\"name/734\",[378,70.048]],[\"comment/734\",[]],[\"name/735\",[379,70.048]],[\"comment/735\",[]],[\"name/736\",[5,21.132]],[\"comment/736\",[]],[\"name/737\",[380,50.584]],[\"comment/737\",[]],[\"name/738\",[381,64.938]],[\"comment/738\",[]],[\"name/739\",[382,70.048]],[\"comment/739\",[]],[\"name/740\",[5,21.132]],[\"comment/740\",[]],[\"name/741\",[336,64.938]],[\"comment/741\",[]],[\"name/742\",[369,61.573]],[\"comment/742\",[]],[\"name/743\",[383,61.573]],[\"comment/743\",[]],[\"name/744\",[384,70.048]],[\"comment/744\",[]],[\"name/745\",[385,70.048]],[\"comment/745\",[]],[\"name/746\",[386,70.048]],[\"comment/746\",[]],[\"name/747\",[387,70.048]],[\"comment/747\",[]],[\"name/748\",[388,70.048]],[\"comment/748\",[]],[\"name/749\",[5,21.132]],[\"comment/749\",[]],[\"name/750\",[389,70.048]],[\"comment/750\",[]],[\"name/751\",[390,70.048]],[\"comment/751\",[]],[\"name/752\",[391,70.048]],[\"comment/752\",[]],[\"name/753\",[332,61.573]],[\"comment/753\",[]],[\"name/754\",[333,64.938]],[\"comment/754\",[]],[\"name/755\",[392,70.048]],[\"comment/755\",[]],[\"name/756\",[5,21.132]],[\"comment/756\",[]],[\"name/757\",[322,64.938]],[\"comment/757\",[]],[\"name/758\",[393,64.938]],[\"comment/758\",[]],[\"name/759\",[321,61.573]],[\"comment/759\",[]],[\"name/760\",[226,55.381]],[\"comment/760\",[]],[\"name/761\",[394,70.048]],[\"comment/761\",[]],[\"name/762\",[5,21.132]],[\"comment/762\",[]],[\"name/763\",[395,70.048]],[\"comment/763\",[]],[\"name/764\",[393,64.938]],[\"comment/764\",[]],[\"name/765\",[321,61.573]],[\"comment/765\",[]],[\"name/766\",[226,55.381]],[\"comment/766\",[]],[\"name/767\",[396,70.048]],[\"comment/767\",[]],[\"name/768\",[5,21.132]],[\"comment/768\",[]],[\"name/769\",[6,37.851]],[\"comment/769\",[]],[\"name/770\",[397,70.048]],[\"comment/770\",[]],[\"name/771\",[398,70.048]],[\"comment/771\",[]],[\"name/772\",[5,21.132]],[\"comment/772\",[]],[\"name/773\",[399,70.048]],[\"comment/773\",[]],[\"name/774\",[383,61.573]],[\"comment/774\",[]],[\"name/775\",[93,61.573]],[\"comment/775\",[]],[\"name/776\",[400,70.048]],[\"comment/776\",[]],[\"name/777\",[401,70.048]],[\"comment/777\",[]],[\"name/778\",[5,21.132]],[\"comment/778\",[]],[\"name/779\",[61,38.122]],[\"comment/779\",[]],[\"name/780\",[402,70.048]],[\"comment/780\",[]],[\"name/781\",[5,21.132]],[\"comment/781\",[]],[\"name/782\",[403,70.048]],[\"comment/782\",[]],[\"name/783\",[404,70.048]],[\"comment/783\",[]],[\"name/784\",[405,70.048]],[\"comment/784\",[]],[\"name/785\",[406,70.048]],[\"comment/785\",[]],[\"name/786\",[407,70.048]],[\"comment/786\",[]],[\"name/787\",[408,70.048]],[\"comment/787\",[]],[\"name/788\",[409,64.938]],[\"comment/788\",[]],[\"name/789\",[5,21.132]],[\"comment/789\",[]],[\"name/790\",[410,64.938]],[\"comment/790\",[]],[\"name/791\",[411,64.938]],[\"comment/791\",[]],[\"name/792\",[412,64.938]],[\"comment/792\",[]],[\"name/793\",[413,64.938]],[\"comment/793\",[]],[\"name/794\",[414,64.938]],[\"comment/794\",[]],[\"name/795\",[415,64.938]],[\"comment/795\",[]],[\"name/796\",[416,70.048]],[\"comment/796\",[]],[\"name/797\",[5,21.132]],[\"comment/797\",[]],[\"name/798\",[410,64.938]],[\"comment/798\",[]],[\"name/799\",[411,64.938]],[\"comment/799\",[]],[\"name/800\",[412,64.938]],[\"comment/800\",[]],[\"name/801\",[413,64.938]],[\"comment/801\",[]],[\"name/802\",[414,64.938]],[\"comment/802\",[]],[\"name/803\",[415,64.938]],[\"comment/803\",[]],[\"name/804\",[417,70.048]],[\"comment/804\",[]],[\"name/805\",[5,21.132]],[\"comment/805\",[]],[\"name/806\",[380,50.584]],[\"comment/806\",[]],[\"name/807\",[352,55.381]],[\"comment/807\",[]],[\"name/808\",[418,61.573]],[\"comment/808\",[]],[\"name/809\",[92,61.573]],[\"comment/809\",[]],[\"name/810\",[93,61.573]],[\"comment/810\",[]],[\"name/811\",[419,70.048]],[\"comment/811\",[]],[\"name/812\",[420,70.048]],[\"comment/812\",[]],[\"name/813\",[332,61.573]],[\"comment/813\",[]],[\"name/814\",[381,64.938]],[\"comment/814\",[]],[\"name/815\",[196,61.573]],[\"comment/815\",[]],[\"name/816\",[421,70.048]],[\"comment/816\",[]],[\"name/817\",[5,21.132]],[\"comment/817\",[]],[\"name/818\",[422,70.048]],[\"comment/818\",[]],[\"name/819\",[5,21.132]],[\"comment/819\",[]],[\"name/820\",[423,70.048]],[\"comment/820\",[]],[\"name/821\",[424,70.048]],[\"comment/821\",[]],[\"name/822\",[425,64.938]],[\"comment/822\",[]],[\"name/823\",[426,70.048]],[\"comment/823\",[]],[\"name/824\",[427,70.048]],[\"comment/824\",[]],[\"name/825\",[428,64.938]],[\"comment/825\",[]],[\"name/826\",[429,64.938]],[\"comment/826\",[]],[\"name/827\",[430,70.048]],[\"comment/827\",[]],[\"name/828\",[5,21.132]],[\"comment/828\",[]],[\"name/829\",[431,70.048]],[\"comment/829\",[]],[\"name/830\",[432,70.048]],[\"comment/830\",[]],[\"name/831\",[425,64.938]],[\"comment/831\",[]],[\"name/832\",[433,70.048]],[\"comment/832\",[]],[\"name/833\",[429,64.938]],[\"comment/833\",[]],[\"name/834\",[434,70.048]],[\"comment/834\",[]],[\"name/835\",[428,64.938]],[\"comment/835\",[]],[\"name/836\",[435,70.048]],[\"comment/836\",[]],[\"name/837\",[436,70.048]],[\"comment/837\",[]],[\"name/838\",[5,21.132]],[\"comment/838\",[]],[\"name/839\",[437,70.048]],[\"comment/839\",[]],[\"name/840\",[438,70.048]],[\"comment/840\",[]],[\"name/841\",[439,70.048]],[\"comment/841\",[]],[\"name/842\",[440,70.048]],[\"comment/842\",[]],[\"name/843\",[441,70.048]],[\"comment/843\",[]],[\"name/844\",[442,70.048]],[\"comment/844\",[]],[\"name/845\",[443,70.048]],[\"comment/845\",[]],[\"name/846\",[444,70.048]],[\"comment/846\",[]],[\"name/847\",[5,21.132]],[\"comment/847\",[]],[\"name/848\",[445,61.573]],[\"comment/848\",[]],[\"name/849\",[446,61.573]],[\"comment/849\",[]],[\"name/850\",[447,70.048]],[\"comment/850\",[]],[\"name/851\",[96,51.585]],[\"comment/851\",[]],[\"name/852\",[448,70.048]],[\"comment/852\",[]],[\"name/853\",[449,70.048]],[\"comment/853\",[]],[\"name/854\",[5,21.132]],[\"comment/854\",[]],[\"name/855\",[450,70.048]],[\"comment/855\",[]],[\"name/856\",[451,70.048]],[\"comment/856\",[]],[\"name/857\",[452,70.048]],[\"comment/857\",[]],[\"name/858\",[453,70.048]],[\"comment/858\",[]],[\"name/859\",[5,21.132]],[\"comment/859\",[]],[\"name/860\",[286,64.938]],[\"comment/860\",[]],[\"name/861\",[454,61.573]],[\"comment/861\",[]],[\"name/862\",[455,59.059]],[\"comment/862\",[]],[\"name/863\",[339,55.381]],[\"comment/863\",[]],[\"name/864\",[456,70.048]],[\"comment/864\",[]],[\"name/865\",[5,21.132]],[\"comment/865\",[]],[\"name/866\",[457,70.048]],[\"comment/866\",[]],[\"name/867\",[458,64.938]],[\"comment/867\",[]],[\"name/868\",[145,53.95]],[\"comment/868\",[]],[\"name/869\",[142,53.95]],[\"comment/869\",[]],[\"name/870\",[459,70.048]],[\"comment/870\",[]],[\"name/871\",[5,21.132]],[\"comment/871\",[]],[\"name/872\",[61,38.122]],[\"comment/872\",[]],[\"name/873\",[380,50.584]],[\"comment/873\",[]],[\"name/874\",[307,57.052]],[\"comment/874\",[]],[\"name/875\",[161,64.938]],[\"comment/875\",[]],[\"name/876\",[458,64.938]],[\"comment/876\",[]],[\"name/877\",[145,53.95]],[\"comment/877\",[]],[\"name/878\",[142,53.95]],[\"comment/878\",[]],[\"name/879\",[460,70.048]],[\"comment/879\",[]],[\"name/880\",[5,21.132]],[\"comment/880\",[]],[\"name/881\",[461,64.938]],[\"comment/881\",[]],[\"name/882\",[462,61.573]],[\"comment/882\",[]],[\"name/883\",[463,51.585]],[\"comment/883\",[]],[\"name/884\",[189,61.573]],[\"comment/884\",[]],[\"name/885\",[5,21.132]],[\"comment/885\",[]],[\"name/886\",[464,70.048]],[\"comment/886\",[]],[\"name/887\",[5,21.132]],[\"comment/887\",[]],[\"name/888\",[61,38.122]],[\"comment/888\",[]],[\"name/889\",[283,53.95]],[\"comment/889\",[]],[\"name/890\",[465,70.048]],[\"comment/890\",[]],[\"name/891\",[466,70.048]],[\"comment/891\",[]],[\"name/892\",[5,21.132]],[\"comment/892\",[]],[\"name/893\",[467,55.381]],[\"comment/893\",[]],[\"name/894\",[468,57.052]],[\"comment/894\",[]],[\"name/895\",[469,57.052]],[\"comment/895\",[]],[\"name/896\",[470,57.052]],[\"comment/896\",[]],[\"name/897\",[471,61.573]],[\"comment/897\",[]],[\"name/898\",[472,70.048]],[\"comment/898\",[]],[\"name/899\",[5,21.132]],[\"comment/899\",[]],[\"name/900\",[467,55.381]],[\"comment/900\",[]],[\"name/901\",[468,57.052]],[\"comment/901\",[]],[\"name/902\",[469,57.052]],[\"comment/902\",[]],[\"name/903\",[470,57.052]],[\"comment/903\",[]],[\"name/904\",[471,61.573]],[\"comment/904\",[]],[\"name/905\",[473,61.573]],[\"comment/905\",[]],[\"name/906\",[474,59.059]],[\"comment/906\",[]],[\"name/907\",[475,70.048]],[\"comment/907\",[]],[\"name/908\",[5,21.132]],[\"comment/908\",[]],[\"name/909\",[467,55.381]],[\"comment/909\",[]],[\"name/910\",[468,57.052]],[\"comment/910\",[]],[\"name/911\",[469,57.052]],[\"comment/911\",[]],[\"name/912\",[470,57.052]],[\"comment/912\",[]],[\"name/913\",[471,61.573]],[\"comment/913\",[]],[\"name/914\",[473,61.573]],[\"comment/914\",[]],[\"name/915\",[474,59.059]],[\"comment/915\",[]],[\"name/916\",[476,70.048]],[\"comment/916\",[]],[\"name/917\",[5,21.132]],[\"comment/917\",[]],[\"name/918\",[473,61.573]],[\"comment/918\",[]],[\"name/919\",[474,59.059]],[\"comment/919\",[]],[\"name/920\",[477,70.048]],[\"comment/920\",[]],[\"name/921\",[5,21.132]],[\"comment/921\",[]],[\"name/922\",[478,64.938]],[\"comment/922\",[]],[\"name/923\",[61,38.122]],[\"comment/923\",[]],[\"name/924\",[463,51.585]],[\"comment/924\",[]],[\"name/925\",[479,64.938]],[\"comment/925\",[]],[\"name/926\",[469,57.052]],[\"comment/926\",[]],[\"name/927\",[470,57.052]],[\"comment/927\",[]],[\"name/928\",[480,70.048]],[\"comment/928\",[]],[\"name/929\",[5,21.132]],[\"comment/929\",[]],[\"name/930\",[478,64.938]],[\"comment/930\",[]],[\"name/931\",[307,57.052]],[\"comment/931\",[]],[\"name/932\",[61,38.122]],[\"comment/932\",[]],[\"name/933\",[463,51.585]],[\"comment/933\",[]],[\"name/934\",[469,57.052]],[\"comment/934\",[]],[\"name/935\",[470,57.052]],[\"comment/935\",[]],[\"name/936\",[481,64.938]],[\"comment/936\",[]],[\"name/937\",[241,61.573]],[\"comment/937\",[]],[\"name/938\",[50,59.059]],[\"comment/938\",[]],[\"name/939\",[5,21.132]],[\"comment/939\",[]],[\"name/940\",[467,55.381]],[\"comment/940\",[]],[\"name/941\",[468,57.052]],[\"comment/941\",[]],[\"name/942\",[482,70.048]],[\"comment/942\",[]],[\"name/943\",[5,21.132]],[\"comment/943\",[]],[\"name/944\",[6,37.851]],[\"comment/944\",[]],[\"name/945\",[483,70.048]],[\"comment/945\",[]],[\"name/946\",[484,61.573]],[\"comment/946\",[]],[\"name/947\",[485,52.698]],[\"comment/947\",[]],[\"name/948\",[486,53.95]],[\"comment/948\",[]],[\"name/949\",[487,57.052]],[\"comment/949\",[]],[\"name/950\",[488,61.573]],[\"comment/950\",[]],[\"name/951\",[489,70.048]],[\"comment/951\",[]],[\"name/952\",[5,21.132]],[\"comment/952\",[]],[\"name/953\",[490,61.573]],[\"comment/953\",[]],[\"name/954\",[484,61.573]],[\"comment/954\",[]],[\"name/955\",[485,52.698]],[\"comment/955\",[]],[\"name/956\",[61,38.122]],[\"comment/956\",[]],[\"name/957\",[463,51.585]],[\"comment/957\",[]],[\"name/958\",[486,53.95]],[\"comment/958\",[]],[\"name/959\",[487,57.052]],[\"comment/959\",[]],[\"name/960\",[491,70.048]],[\"comment/960\",[]],[\"name/961\",[5,21.132]],[\"comment/961\",[]],[\"name/962\",[490,61.573]],[\"comment/962\",[]],[\"name/963\",[484,61.573]],[\"comment/963\",[]],[\"name/964\",[485,52.698]],[\"comment/964\",[]],[\"name/965\",[61,38.122]],[\"comment/965\",[]],[\"name/966\",[463,51.585]],[\"comment/966\",[]],[\"name/967\",[486,53.95]],[\"comment/967\",[]],[\"name/968\",[487,57.052]],[\"comment/968\",[]],[\"name/969\",[492,70.048]],[\"comment/969\",[]],[\"name/970\",[5,21.132]],[\"comment/970\",[]],[\"name/971\",[493,57.052]],[\"comment/971\",[]],[\"name/972\",[494,64.938]],[\"comment/972\",[]],[\"name/973\",[495,64.938]],[\"comment/973\",[]],[\"name/974\",[496,64.938]],[\"comment/974\",[]],[\"name/975\",[497,59.059]],[\"comment/975\",[]],[\"name/976\",[498,70.048]],[\"comment/976\",[]],[\"name/977\",[5,21.132]],[\"comment/977\",[]],[\"name/978\",[485,52.698]],[\"comment/978\",[]],[\"name/979\",[499,64.938]],[\"comment/979\",[]],[\"name/980\",[497,59.059]],[\"comment/980\",[]],[\"name/981\",[500,61.573]],[\"comment/981\",[]],[\"name/982\",[501,70.048]],[\"comment/982\",[]],[\"name/983\",[502,70.048]],[\"comment/983\",[]],[\"name/984\",[5,21.132]],[\"comment/984\",[]],[\"name/985\",[503,64.938]],[\"comment/985\",[]],[\"name/986\",[485,52.698]],[\"comment/986\",[]],[\"name/987\",[497,59.059]],[\"comment/987\",[]],[\"name/988\",[500,61.573]],[\"comment/988\",[]],[\"name/989\",[504,70.048]],[\"comment/989\",[]],[\"name/990\",[5,21.132]],[\"comment/990\",[]],[\"name/991\",[485,52.698]],[\"comment/991\",[]],[\"name/992\",[505,64.938]],[\"comment/992\",[]],[\"name/993\",[493,57.052]],[\"comment/993\",[]],[\"name/994\",[506,70.048]],[\"comment/994\",[]],[\"name/995\",[5,21.132]],[\"comment/995\",[]],[\"name/996\",[226,55.381]],[\"comment/996\",[]],[\"name/997\",[505,64.938]],[\"comment/997\",[]],[\"name/998\",[493,57.052]],[\"comment/998\",[]],[\"name/999\",[507,70.048]],[\"comment/999\",[]],[\"name/1000\",[508,70.048]],[\"comment/1000\",[]],[\"name/1001\",[509,70.048]],[\"comment/1001\",[]],[\"name/1002\",[510,70.048]],[\"comment/1002\",[]],[\"name/1003\",[5,21.132]],[\"comment/1003\",[]],[\"name/1004\",[485,52.698]],[\"comment/1004\",[]],[\"name/1005\",[499,64.938]],[\"comment/1005\",[]],[\"name/1006\",[497,59.059]],[\"comment/1006\",[]],[\"name/1007\",[500,61.573]],[\"comment/1007\",[]],[\"name/1008\",[511,70.048]],[\"comment/1008\",[]],[\"name/1009\",[5,21.132]],[\"comment/1009\",[]],[\"name/1010\",[226,55.381]],[\"comment/1010\",[]],[\"name/1011\",[493,57.052]],[\"comment/1011\",[]],[\"name/1012\",[496,64.938]],[\"comment/1012\",[]],[\"name/1013\",[495,64.938]],[\"comment/1013\",[]],[\"name/1014\",[494,64.938]],[\"comment/1014\",[]],[\"name/1015\",[512,70.048]],[\"comment/1015\",[]],[\"name/1016\",[5,21.132]],[\"comment/1016\",[]],[\"name/1017\",[513,64.938]],[\"comment/1017\",[]],[\"name/1018\",[5,21.132]],[\"comment/1018\",[]],[\"name/1019\",[485,52.698]],[\"comment/1019\",[]],[\"name/1020\",[486,53.95]],[\"comment/1020\",[]],[\"name/1021\",[463,51.585]],[\"comment/1021\",[]],[\"name/1022\",[462,61.573]],[\"comment/1022\",[]],[\"name/1023\",[307,57.052]],[\"comment/1023\",[]],[\"name/1024\",[5,21.132]],[\"comment/1024\",[]],[\"name/1025\",[514,70.048]],[\"comment/1025\",[]],[\"name/1026\",[515,70.048]],[\"comment/1026\",[]],[\"name/1027\",[5,21.132]],[\"comment/1027\",[]],[\"name/1028\",[418,61.573]],[\"comment/1028\",[]],[\"name/1029\",[455,59.059]],[\"comment/1029\",[]],[\"name/1030\",[339,55.381]],[\"comment/1030\",[]],[\"name/1031\",[516,70.048]],[\"comment/1031\",[]],[\"name/1032\",[5,21.132]],[\"comment/1032\",[]],[\"name/1033\",[418,61.573]],[\"comment/1033\",[]],[\"name/1034\",[454,61.573]],[\"comment/1034\",[]],[\"name/1035\",[455,59.059]],[\"comment/1035\",[]],[\"name/1036\",[339,55.381]],[\"comment/1036\",[]],[\"name/1037\",[517,70.048]],[\"comment/1037\",[]],[\"name/1038\",[5,21.132]],[\"comment/1038\",[]],[\"name/1039\",[454,61.573]],[\"comment/1039\",[]],[\"name/1040\",[455,59.059]],[\"comment/1040\",[]],[\"name/1041\",[339,55.381]],[\"comment/1041\",[]],[\"name/1042\",[518,70.048]],[\"comment/1042\",[]],[\"name/1043\",[5,21.132]],[\"comment/1043\",[]],[\"name/1044\",[352,55.381]],[\"comment/1044\",[]],[\"name/1045\",[96,51.585]],[\"comment/1045\",[]],[\"name/1046\",[519,70.048]],[\"comment/1046\",[]],[\"name/1047\",[5,21.132]],[\"comment/1047\",[]],[\"name/1048\",[520,70.048]],[\"comment/1048\",[]],[\"name/1049\",[5,21.132]],[\"comment/1049\",[]],[\"name/1050\",[521,70.048]],[\"comment/1050\",[]],[\"name/1051\",[5,21.132]],[\"comment/1051\",[]],[\"name/1052\",[522,70.048]],[\"comment/1052\",[]],[\"name/1053\",[5,21.132]],[\"comment/1053\",[]],[\"name/1054\",[523,70.048]],[\"comment/1054\",[]],[\"name/1055\",[5,21.132]],[\"comment/1055\",[]],[\"name/1056\",[524,70.048]],[\"comment/1056\",[]],[\"name/1057\",[474,59.059]],[\"comment/1057\",[]],[\"name/1058\",[525,70.048]],[\"comment/1058\",[]],[\"name/1059\",[292,59.059]],[\"comment/1059\",[]],[\"name/1060\",[526,70.048]],[\"comment/1060\",[]],[\"name/1061\",[5,21.132]],[\"comment/1061\",[]],[\"name/1062\",[380,50.584]],[\"comment/1062\",[]],[\"name/1063\",[527,70.048]],[\"comment/1063\",[]],[\"name/1064\",[528,70.048]],[\"comment/1064\",[]],[\"name/1065\",[529,70.048]],[\"comment/1065\",[]],[\"name/1066\",[530,70.048]],[\"comment/1066\",[]],[\"name/1067\",[531,70.048]],[\"comment/1067\",[]],[\"name/1068\",[532,70.048]],[\"comment/1068\",[]],[\"name/1069\",[5,21.132]],[\"comment/1069\",[]],[\"name/1070\",[461,64.938]],[\"comment/1070\",[]],[\"name/1071\",[259,61.573]],[\"comment/1071\",[]],[\"name/1072\",[533,70.048]],[\"comment/1072\",[]],[\"name/1073\",[534,70.048]],[\"comment/1073\",[]],[\"name/1074\",[116,53.95]],[\"comment/1074\",[]],[\"name/1075\",[535,70.048]],[\"comment/1075\",[]],[\"name/1076\",[513,64.938]],[\"comment/1076\",[]],[\"name/1077\",[536,70.048]],[\"comment/1077\",[]],[\"name/1078\",[537,70.048]],[\"comment/1078\",[]],[\"name/1079\",[538,70.048]],[\"comment/1079\",[]],[\"name/1080\",[539,70.048]],[\"comment/1080\",[]],[\"name/1081\",[540,70.048]],[\"comment/1081\",[]],[\"name/1082\",[5,21.132]],[\"comment/1082\",[]],[\"name/1083\",[541,70.048]],[\"comment/1083\",[]],[\"name/1084\",[135,57.052]],[\"comment/1084\",[]],[\"name/1085\",[542,70.048]],[\"comment/1085\",[]],[\"name/1086\",[543,70.048]],[\"comment/1086\",[]],[\"name/1087\",[131,61.573]],[\"comment/1087\",[]],[\"name/1088\",[544,70.048]],[\"comment/1088\",[]],[\"name/1089\",[206,64.938]],[\"comment/1089\",[]],[\"name/1090\",[545,70.048]],[\"comment/1090\",[]],[\"name/1091\",[5,21.132]],[\"comment/1091\",[]],[\"name/1092\",[380,50.584]],[\"comment/1092\",[]],[\"name/1093\",[546,64.938]],[\"comment/1093\",[]],[\"name/1094\",[135,57.052]],[\"comment/1094\",[]],[\"name/1095\",[547,70.048]],[\"comment/1095\",[]],[\"name/1096\",[136,61.573]],[\"comment/1096\",[]],[\"name/1097\",[548,70.048]],[\"comment/1097\",[]],[\"name/1098\",[5,21.132]],[\"comment/1098\",[]],[\"name/1099\",[549,70.048]],[\"comment/1099\",[]],[\"name/1100\",[550,70.048]],[\"comment/1100\",[]],[\"name/1101\",[546,64.938]],[\"comment/1101\",[]],[\"name/1102\",[135,57.052]],[\"comment/1102\",[]],[\"name/1103\",[551,70.048]],[\"comment/1103\",[]],[\"name/1104\",[552,70.048]],[\"comment/1104\",[]],[\"name/1105\",[352,55.381]],[\"comment/1105\",[]],[\"name/1106\",[553,70.048]],[\"comment/1106\",[]],[\"name/1107\",[61,38.122]],[\"comment/1107\",[]],[\"name/1108\",[463,51.585]],[\"comment/1108\",[]],[\"name/1109\",[554,70.048]],[\"comment/1109\",[]],[\"name/1110\",[555,59.059]],[\"comment/1110\",[]],[\"name/1111\",[556,70.048]],[\"comment/1111\",[]],[\"name/1112\",[557,70.048]],[\"comment/1112\",[]],[\"name/1113\",[558,70.048]],[\"comment/1113\",[]],[\"name/1114\",[559,70.048]],[\"comment/1114\",[]],[\"name/1115\",[560,70.048]],[\"comment/1115\",[]],[\"name/1116\",[561,70.048]],[\"comment/1116\",[]],[\"name/1117\",[562,70.048]],[\"comment/1117\",[]],[\"name/1118\",[563,70.048]],[\"comment/1118\",[]],[\"name/1119\",[564,70.048]],[\"comment/1119\",[]],[\"name/1120\",[565,70.048]],[\"comment/1120\",[]],[\"name/1121\",[566,70.048]],[\"comment/1121\",[]],[\"name/1122\",[567,70.048]],[\"comment/1122\",[]],[\"name/1123\",[568,70.048]],[\"comment/1123\",[]],[\"name/1124\",[569,70.048]],[\"comment/1124\",[]],[\"name/1125\",[570,70.048]],[\"comment/1125\",[]],[\"name/1126\",[352,55.381]],[\"comment/1126\",[]],[\"name/1127\",[83,52.698]],[\"comment/1127\",[]],[\"name/1128\",[82,53.95]],[\"comment/1128\",[]],[\"name/1129\",[571,70.048]],[\"comment/1129\",[]],[\"name/1130\",[572,70.048]],[\"comment/1130\",[]],[\"name/1131\",[573,70.048]],[\"comment/1131\",[]],[\"name/1132\",[574,70.048]],[\"comment/1132\",[]],[\"name/1133\",[575,70.048]],[\"comment/1133\",[]],[\"name/1134\",[576,70.048]],[\"comment/1134\",[]],[\"name/1135\",[96,51.585]],[\"comment/1135\",[]],[\"name/1136\",[577,70.048]],[\"comment/1136\",[]],[\"name/1137\",[578,70.048]],[\"comment/1137\",[]],[\"name/1138\",[579,70.048]],[\"comment/1138\",[]],[\"name/1139\",[580,70.048]],[\"comment/1139\",[]],[\"name/1140\",[383,61.573]],[\"comment/1140\",[]],[\"name/1141\",[581,57.052]],[\"comment/1141\",[]],[\"name/1142\",[582,70.048]],[\"comment/1142\",[]],[\"name/1143\",[583,70.048]],[\"comment/1143\",[]],[\"name/1144\",[584,70.048]],[\"comment/1144\",[]],[\"name/1145\",[585,61.573]],[\"comment/1145\",[]],[\"name/1146\",[586,70.048]],[\"comment/1146\",[]],[\"name/1147\",[587,70.048]],[\"comment/1147\",[]],[\"name/1148\",[588,70.048]],[\"comment/1148\",[]],[\"name/1149\",[589,70.048]],[\"comment/1149\",[]],[\"name/1150\",[0,51.585]],[\"comment/1150\",[]],[\"name/1151\",[590,70.048]],[\"comment/1151\",[]],[\"name/1152\",[591,70.048]],[\"comment/1152\",[]],[\"name/1153\",[592,61.573]],[\"comment/1153\",[]],[\"name/1154\",[593,70.048]],[\"comment/1154\",[]],[\"name/1155\",[594,70.048]],[\"comment/1155\",[]],[\"name/1156\",[595,70.048]],[\"comment/1156\",[]],[\"name/1157\",[596,70.048]],[\"comment/1157\",[]],[\"name/1158\",[597,70.048]],[\"comment/1158\",[]],[\"name/1159\",[598,70.048]],[\"comment/1159\",[]],[\"name/1160\",[599,70.048]],[\"comment/1160\",[]],[\"name/1161\",[600,70.048]],[\"comment/1161\",[]],[\"name/1162\",[601,70.048]],[\"comment/1162\",[]],[\"name/1163\",[602,70.048]],[\"comment/1163\",[]],[\"name/1164\",[603,70.048]],[\"comment/1164\",[]],[\"name/1165\",[604,61.573]],[\"comment/1165\",[]],[\"name/1166\",[605,70.048]],[\"comment/1166\",[]],[\"name/1167\",[606,70.048]],[\"comment/1167\",[]],[\"name/1168\",[607,70.048]],[\"comment/1168\",[]],[\"name/1169\",[608,70.048]],[\"comment/1169\",[]],[\"name/1170\",[92,61.573]],[\"comment/1170\",[]],[\"name/1171\",[609,70.048]],[\"comment/1171\",[]],[\"name/1172\",[610,70.048]],[\"comment/1172\",[]],[\"name/1173\",[611,70.048]],[\"comment/1173\",[]],[\"name/1174\",[409,64.938]],[\"comment/1174\",[]],[\"name/1175\",[612,70.048]],[\"comment/1175\",[]],[\"name/1176\",[613,70.048]],[\"comment/1176\",[]],[\"name/1177\",[614,70.048]],[\"comment/1177\",[]],[\"name/1178\",[615,70.048]],[\"comment/1178\",[]],[\"name/1179\",[616,70.048]],[\"comment/1179\",[]],[\"name/1180\",[617,70.048]],[\"comment/1180\",[]],[\"name/1181\",[618,70.048]],[\"comment/1181\",[]],[\"name/1182\",[619,70.048]],[\"comment/1182\",[]],[\"name/1183\",[620,70.048]],[\"comment/1183\",[]],[\"name/1184\",[621,70.048]],[\"comment/1184\",[]],[\"name/1185\",[622,70.048]],[\"comment/1185\",[]],[\"name/1186\",[623,70.048]],[\"comment/1186\",[]],[\"name/1187\",[624,70.048]],[\"comment/1187\",[]],[\"name/1188\",[625,70.048]],[\"comment/1188\",[]],[\"name/1189\",[626,70.048]],[\"comment/1189\",[]],[\"name/1190\",[627,70.048]],[\"comment/1190\",[]],[\"name/1191\",[628,70.048]],[\"comment/1191\",[]],[\"name/1192\",[629,70.048]],[\"comment/1192\",[]],[\"name/1193\",[630,70.048]],[\"comment/1193\",[]],[\"name/1194\",[631,70.048]],[\"comment/1194\",[]],[\"name/1195\",[632,70.048]],[\"comment/1195\",[]],[\"name/1196\",[633,70.048]],[\"comment/1196\",[]],[\"name/1197\",[634,70.048]],[\"comment/1197\",[]],[\"name/1198\",[635,70.048]],[\"comment/1198\",[]],[\"name/1199\",[636,70.048]],[\"comment/1199\",[]],[\"name/1200\",[637,70.048]],[\"comment/1200\",[]],[\"name/1201\",[638,70.048]],[\"comment/1201\",[]],[\"name/1202\",[639,70.048]],[\"comment/1202\",[]],[\"name/1203\",[640,70.048]],[\"comment/1203\",[]],[\"name/1204\",[641,70.048]],[\"comment/1204\",[]],[\"name/1205\",[642,70.048]],[\"comment/1205\",[]],[\"name/1206\",[643,70.048]],[\"comment/1206\",[]],[\"name/1207\",[644,70.048]],[\"comment/1207\",[]],[\"name/1208\",[645,70.048]],[\"comment/1208\",[]],[\"name/1209\",[646,70.048]],[\"comment/1209\",[]],[\"name/1210\",[647,61.573]],[\"comment/1210\",[]],[\"name/1211\",[648,70.048]],[\"comment/1211\",[]],[\"name/1212\",[649,70.048]],[\"comment/1212\",[]],[\"name/1213\",[650,70.048]],[\"comment/1213\",[]],[\"name/1214\",[651,70.048]],[\"comment/1214\",[]],[\"name/1215\",[249,61.573]],[\"comment/1215\",[]],[\"name/1216\",[652,70.048]],[\"comment/1216\",[]],[\"name/1217\",[5,21.132]],[\"comment/1217\",[]],[\"name/1218\",[653,64.938]],[\"comment/1218\",[]],[\"name/1219\",[654,64.938]],[\"comment/1219\",[]],[\"name/1220\",[655,70.048]],[\"comment/1220\",[]],[\"name/1221\",[656,70.048]],[\"comment/1221\",[]],[\"name/1222\",[5,21.132]],[\"comment/1222\",[]],[\"name/1223\",[657,70.048]],[\"comment/1223\",[]],[\"name/1224\",[658,70.048]],[\"comment/1224\",[]],[\"name/1225\",[659,70.048]],[\"comment/1225\",[]],[\"name/1226\",[660,70.048]],[\"comment/1226\",[]],[\"name/1227\",[248,61.573]],[\"comment/1227\",[]],[\"name/1228\",[661,64.938]],[\"comment/1228\",[]],[\"name/1229\",[662,64.938]],[\"comment/1229\",[]],[\"name/1230\",[663,64.938]],[\"comment/1230\",[]],[\"name/1231\",[5,21.132]],[\"comment/1231\",[]],[\"name/1232\",[654,64.938]],[\"comment/1232\",[]],[\"name/1233\",[664,70.048]],[\"comment/1233\",[]],[\"name/1234\",[5,21.132]],[\"comment/1234\",[]],[\"name/1235\",[653,64.938]],[\"comment/1235\",[]],[\"name/1236\",[665,70.048]],[\"comment/1236\",[]],[\"name/1237\",[116,53.95]],[\"comment/1237\",[]],[\"name/1238\",[666,70.048]],[\"comment/1238\",[]],[\"name/1239\",[667,70.048]],[\"comment/1239\",[]],[\"name/1240\",[668,70.048]],[\"comment/1240\",[]],[\"name/1241\",[283,53.95]],[\"comment/1241\",[]],[\"name/1242\",[669,70.048]],[\"comment/1242\",[]],[\"name/1243\",[670,70.048]],[\"comment/1243\",[]],[\"name/1244\",[671,70.048]],[\"comment/1244\",[]],[\"name/1245\",[61,38.122]],[\"comment/1245\",[]],[\"name/1246\",[118,61.573]],[\"comment/1246\",[]],[\"name/1247\",[283,53.95]],[\"comment/1247\",[]],[\"name/1248\",[672,64.938]],[\"comment/1248\",[]],[\"name/1249\",[673,64.938]],[\"comment/1249\",[]],[\"name/1250\",[5,21.132]],[\"comment/1250\",[]],[\"name/1251\",[116,53.95]],[\"comment/1251\",[]],[\"name/1252\",[117,64.938]],[\"comment/1252\",[]],[\"name/1253\",[118,61.573]],[\"comment/1253\",[]],[\"name/1254\",[283,53.95]],[\"comment/1254\",[]],[\"name/1255\",[674,70.048]],[\"comment/1255\",[]],[\"name/1256\",[61,38.122]],[\"comment/1256\",[]],[\"name/1257\",[672,64.938]],[\"comment/1257\",[]],[\"name/1258\",[283,53.95]],[\"comment/1258\",[]],[\"name/1259\",[673,64.938]],[\"comment/1259\",[]],[\"name/1260\",[5,21.132]],[\"comment/1260\",[]],[\"name/1261\",[116,53.95]],[\"comment/1261\",[]],[\"name/1262\",[283,53.95]],[\"comment/1262\",[]],[\"name/1263\",[481,46.09,675,49.717]],[\"comment/1263\",[]],[\"name/1264\",[676,70.048]],[\"comment/1264\",[]],[\"name/1265\",[5,21.132]],[\"comment/1265\",[]],[\"name/1266\",[467,55.381]],[\"comment/1266\",[]],[\"name/1267\",[677,70.048]],[\"comment/1267\",[]],[\"name/1268\",[468,57.052]],[\"comment/1268\",[]],[\"name/1269\",[479,64.938]],[\"comment/1269\",[]],[\"name/1270\",[678,70.048]],[\"comment/1270\",[]],[\"name/1271\",[679,70.048]],[\"comment/1271\",[]],[\"name/1272\",[680,70.048]],[\"comment/1272\",[]],[\"name/1273\",[681,70.048]],[\"comment/1273\",[]],[\"name/1274\",[682,70.048]],[\"comment/1274\",[]],[\"name/1275\",[493,57.052]],[\"comment/1275\",[]],[\"name/1276\",[683,70.048]],[\"comment/1276\",[]],[\"name/1277\",[684,70.048]],[\"comment/1277\",[]],[\"name/1278\",[486,53.95]],[\"comment/1278\",[]],[\"name/1279\",[685,70.048]],[\"comment/1279\",[]],[\"name/1280\",[462,61.573]],[\"comment/1280\",[]],[\"name/1281\",[61,38.122]],[\"comment/1281\",[]],[\"name/1282\",[686,70.048]],[\"comment/1282\",[]],[\"name/1283\",[463,51.585]],[\"comment/1283\",[]],[\"name/1284\",[467,55.381]],[\"comment/1284\",[]],[\"name/1285\",[5,21.132]],[\"comment/1285\",[]],[\"name/1286\",[486,53.95]],[\"comment/1286\",[]],[\"name/1287\",[6,37.851]],[\"comment/1287\",[]],[\"name/1288\",[488,61.573]],[\"comment/1288\",[]],[\"name/1289\",[487,57.052]],[\"comment/1289\",[]],[\"name/1290\",[687,70.048]],[\"comment/1290\",[]],[\"name/1291\",[5,21.132]],[\"comment/1291\",[]],[\"name/1292\",[61,38.122]],[\"comment/1292\",[]],[\"name/1293\",[463,51.585]],[\"comment/1293\",[]],[\"name/1294\",[486,53.95]],[\"comment/1294\",[]],[\"name/1295\",[487,57.052]],[\"comment/1295\",[]],[\"name/1296\",[490,61.573]],[\"comment/1296\",[]],[\"name/1297\",[688,70.048]],[\"comment/1297\",[]],[\"name/1298\",[5,21.132]],[\"comment/1298\",[]],[\"name/1299\",[307,57.052]],[\"comment/1299\",[]],[\"name/1300\",[689,70.048]],[\"comment/1300\",[]],[\"name/1301\",[6,37.851]],[\"comment/1301\",[]],[\"name/1302\",[581,57.052]],[\"comment/1302\",[]],[\"name/1303\",[690,70.048]],[\"comment/1303\",[]],[\"name/1304\",[691,70.048]],[\"comment/1304\",[]],[\"name/1305\",[5,21.132]],[\"comment/1305\",[]],[\"name/1306\",[692,61.573]],[\"comment/1306\",[]],[\"name/1307\",[170,64.938]],[\"comment/1307\",[]],[\"name/1308\",[171,51.585]],[\"comment/1308\",[]],[\"name/1309\",[693,70.048]],[\"comment/1309\",[]],[\"name/1310\",[5,21.132]],[\"comment/1310\",[]],[\"name/1311\",[139,46.063]],[\"comment/1311\",[]],[\"name/1312\",[175,57.052]],[\"comment/1312\",[]],[\"name/1313\",[694,70.048]],[\"comment/1313\",[]],[\"name/1314\",[5,21.132]],[\"comment/1314\",[]],[\"name/1315\",[692,61.573]],[\"comment/1315\",[]],[\"name/1316\",[139,46.063]],[\"comment/1316\",[]],[\"name/1317\",[31,55.381]],[\"comment/1317\",[]],[\"name/1318\",[176,53.95]],[\"comment/1318\",[]],[\"name/1319\",[175,57.052]],[\"comment/1319\",[]],[\"name/1320\",[695,70.048]],[\"comment/1320\",[]],[\"name/1321\",[5,21.132]],[\"comment/1321\",[]],[\"name/1322\",[692,61.573]],[\"comment/1322\",[]],[\"name/1323\",[139,46.063]],[\"comment/1323\",[]],[\"name/1324\",[176,53.95]],[\"comment/1324\",[]],[\"name/1325\",[696,70.048]],[\"comment/1325\",[]],[\"name/1326\",[5,21.132]],[\"comment/1326\",[]],[\"name/1327\",[96,51.585]],[\"comment/1327\",[]],[\"name/1328\",[445,61.573]],[\"comment/1328\",[]],[\"name/1329\",[446,61.573]],[\"comment/1329\",[]],[\"name/1330\",[697,70.048]],[\"comment/1330\",[]],[\"name/1331\",[5,21.132]],[\"comment/1331\",[]],[\"name/1332\",[96,51.585]],[\"comment/1332\",[]],[\"name/1333\",[445,61.573]],[\"comment/1333\",[]],[\"name/1334\",[446,61.573]],[\"comment/1334\",[]],[\"name/1335\",[698,70.048]],[\"comment/1335\",[]],[\"name/1336\",[5,21.132]],[\"comment/1336\",[]],[\"name/1337\",[61,38.122]],[\"comment/1337\",[]],[\"name/1338\",[699,70.048]],[\"comment/1338\",[]],[\"name/1339\",[700,64.938]],[\"comment/1339\",[]],[\"name/1340\",[143,59.059]],[\"comment/1340\",[]],[\"name/1341\",[145,53.95]],[\"comment/1341\",[]],[\"name/1342\",[142,53.95]],[\"comment/1342\",[]],[\"name/1343\",[701,70.048]],[\"comment/1343\",[]],[\"name/1344\",[152,61.573]],[\"comment/1344\",[]],[\"name/1345\",[148,59.059]],[\"comment/1345\",[]],[\"name/1346\",[153,61.573]],[\"comment/1346\",[]],[\"name/1347\",[702,70.048]],[\"comment/1347\",[]],[\"name/1348\",[5,21.132]],[\"comment/1348\",[]],[\"name/1349\",[139,46.063]],[\"comment/1349\",[]],[\"name/1350\",[700,64.938]],[\"comment/1350\",[]],[\"name/1351\",[143,59.059]],[\"comment/1351\",[]],[\"name/1352\",[145,53.95]],[\"comment/1352\",[]],[\"name/1353\",[142,53.95]],[\"comment/1353\",[]],[\"name/1354\",[152,61.573]],[\"comment/1354\",[]],[\"name/1355\",[148,59.059]],[\"comment/1355\",[]],[\"name/1356\",[153,61.573]],[\"comment/1356\",[]],[\"name/1357\",[703,59.059]],[\"comment/1357\",[]],[\"name/1358\",[704,70.048]],[\"comment/1358\",[]],[\"name/1359\",[5,21.132]],[\"comment/1359\",[]],[\"name/1360\",[703,59.059]],[\"comment/1360\",[]],[\"name/1361\",[705,70.048]],[\"comment/1361\",[]],[\"name/1362\",[5,21.132]],[\"comment/1362\",[]],[\"name/1363\",[703,59.059]],[\"comment/1363\",[]],[\"name/1364\",[706,70.048]],[\"comment/1364\",[]],[\"name/1365\",[5,21.132]],[\"comment/1365\",[]],[\"name/1366\",[703,59.059]],[\"comment/1366\",[]],[\"name/1367\",[707,70.048]],[\"comment/1367\",[]],[\"name/1368\",[61,38.122]],[\"comment/1368\",[]],[\"name/1369\",[96,51.585]],[\"comment/1369\",[]],[\"name/1370\",[581,57.052]],[\"comment/1370\",[]],[\"name/1371\",[708,70.048]],[\"comment/1371\",[]],[\"name/1372\",[709,70.048]],[\"comment/1372\",[]],[\"name/1373\",[250,59.059]],[\"comment/1373\",[]],[\"name/1374\",[252,59.059]],[\"comment/1374\",[]],[\"name/1375\",[254,59.059]],[\"comment/1375\",[]],[\"name/1376\",[256,59.059]],[\"comment/1376\",[]],[\"name/1377\",[710,70.048]],[\"comment/1377\",[]],[\"name/1378\",[61,38.122]],[\"comment/1378\",[]],[\"name/1379\",[96,51.585]],[\"comment/1379\",[]],[\"name/1380\",[581,57.052]],[\"comment/1380\",[]],[\"name/1381\",[711,70.048]],[\"comment/1381\",[]],[\"name/1382\",[661,64.938]],[\"comment/1382\",[]],[\"name/1383\",[250,59.059]],[\"comment/1383\",[]],[\"name/1384\",[252,59.059]],[\"comment/1384\",[]],[\"name/1385\",[254,59.059]],[\"comment/1385\",[]],[\"name/1386\",[256,59.059]],[\"comment/1386\",[]],[\"name/1387\",[581,57.052]],[\"comment/1387\",[]],[\"name/1388\",[61,38.122]],[\"comment/1388\",[]],[\"name/1389\",[82,53.95]],[\"comment/1389\",[]],[\"name/1390\",[83,52.698]],[\"comment/1390\",[]],[\"name/1391\",[84,57.052]],[\"comment/1391\",[]],[\"name/1392\",[85,57.052]],[\"comment/1392\",[]],[\"name/1393\",[712,70.048]],[\"comment/1393\",[]],[\"name/1394\",[713,70.048]],[\"comment/1394\",[]],[\"name/1395\",[714,70.048]],[\"comment/1395\",[]],[\"name/1396\",[715,70.048]],[\"comment/1396\",[]],[\"name/1397\",[716,70.048]],[\"comment/1397\",[]],[\"name/1398\",[274,64.938]],[\"comment/1398\",[]],[\"name/1399\",[717,70.048]],[\"comment/1399\",[]],[\"name/1400\",[718,70.048]],[\"comment/1400\",[]],[\"name/1401\",[719,70.048]],[\"comment/1401\",[]],[\"name/1402\",[720,70.048]],[\"comment/1402\",[]],[\"name/1403\",[721,70.048]],[\"comment/1403\",[]],[\"name/1404\",[277,64.938]],[\"comment/1404\",[]],[\"name/1405\",[202,55.381]],[\"comment/1405\",[]],[\"name/1406\",[722,70.048]],[\"comment/1406\",[]],[\"name/1407\",[488,61.573]],[\"comment/1407\",[]],[\"name/1408\",[270,57.052]],[\"comment/1408\",[]],[\"name/1409\",[723,70.048]],[\"comment/1409\",[]],[\"name/1410\",[5,21.132]],[\"comment/1410\",[]],[\"name/1411\",[6,37.851]],[\"comment/1411\",[]],[\"name/1412\",[724,50.584]],[\"comment/1412\",[]],[\"name/1413\",[61,38.122]],[\"comment/1413\",[]],[\"name/1414\",[725,61.573]],[\"comment/1414\",[]],[\"name/1415\",[726,64.938]],[\"comment/1415\",[]],[\"name/1416\",[727,70.048]],[\"comment/1416\",[]],[\"name/1417\",[728,70.048]],[\"comment/1417\",[]],[\"name/1418\",[729,55.381]],[\"comment/1418\",[]],[\"name/1419\",[150,59.059]],[\"comment/1419\",[]],[\"name/1420\",[730,64.938]],[\"comment/1420\",[]],[\"name/1421\",[731,70.048]],[\"comment/1421\",[]],[\"name/1422\",[732,70.048]],[\"comment/1422\",[]],[\"name/1423\",[5,21.132]],[\"comment/1423\",[]],[\"name/1424\",[6,37.851]],[\"comment/1424\",[]],[\"name/1425\",[724,50.584]],[\"comment/1425\",[]],[\"name/1426\",[61,38.122]],[\"comment/1426\",[]],[\"name/1427\",[733,70.048]],[\"comment/1427\",[]],[\"name/1428\",[729,55.381]],[\"comment/1428\",[]],[\"name/1429\",[734,70.048]],[\"comment/1429\",[]],[\"name/1430\",[5,21.132]],[\"comment/1430\",[]],[\"name/1431\",[6,37.851]],[\"comment/1431\",[]],[\"name/1432\",[724,50.584]],[\"comment/1432\",[]],[\"name/1433\",[61,38.122]],[\"comment/1433\",[]],[\"name/1434\",[735,70.048]],[\"comment/1434\",[]],[\"name/1435\",[729,55.381]],[\"comment/1435\",[]],[\"name/1436\",[736,70.048]],[\"comment/1436\",[]],[\"name/1437\",[5,21.132]],[\"comment/1437\",[]],[\"name/1438\",[6,37.851]],[\"comment/1438\",[]],[\"name/1439\",[724,50.584]],[\"comment/1439\",[]],[\"name/1440\",[737,70.048]],[\"comment/1440\",[]],[\"name/1441\",[61,38.122]],[\"comment/1441\",[]],[\"name/1442\",[725,61.573]],[\"comment/1442\",[]],[\"name/1443\",[729,55.381]],[\"comment/1443\",[]],[\"name/1444\",[738,70.048]],[\"comment/1444\",[]],[\"name/1445\",[5,21.132]],[\"comment/1445\",[]],[\"name/1446\",[61,38.122]],[\"comment/1446\",[]],[\"name/1447\",[0,51.585]],[\"comment/1447\",[]],[\"name/1448\",[7,42.109]],[\"comment/1448\",[]],[\"name/1449\",[739,59.059]],[\"comment/1449\",[]],[\"name/1450\",[740,57.052]],[\"comment/1450\",[]],[\"name/1451\",[741,70.048]],[\"comment/1451\",[]],[\"name/1452\",[5,21.132]],[\"comment/1452\",[]],[\"name/1453\",[61,38.122]],[\"comment/1453\",[]],[\"name/1454\",[0,51.585]],[\"comment/1454\",[]],[\"name/1455\",[7,42.109]],[\"comment/1455\",[]],[\"name/1456\",[742,59.059]],[\"comment/1456\",[]],[\"name/1457\",[739,59.059]],[\"comment/1457\",[]],[\"name/1458\",[743,59.059]],[\"comment/1458\",[]],[\"name/1459\",[740,57.052]],[\"comment/1459\",[]],[\"name/1460\",[364,52.698]],[\"comment/1460\",[]],[\"name/1461\",[744,70.048]],[\"comment/1461\",[]],[\"name/1462\",[5,21.132]],[\"comment/1462\",[]],[\"name/1463\",[724,50.584]],[\"comment/1463\",[]],[\"name/1464\",[745,59.059]],[\"comment/1464\",[]],[\"name/1465\",[364,52.698]],[\"comment/1465\",[]],[\"name/1466\",[746,70.048]],[\"comment/1466\",[]],[\"name/1467\",[5,21.132]],[\"comment/1467\",[]],[\"name/1468\",[747,70.048]],[\"comment/1468\",[]],[\"name/1469\",[209,61.573]],[\"comment/1469\",[]],[\"name/1470\",[748,70.048]],[\"comment/1470\",[]],[\"name/1471\",[5,21.132]],[\"comment/1471\",[]],[\"name/1472\",[6,37.851]],[\"comment/1472\",[]],[\"name/1473\",[724,50.584]],[\"comment/1473\",[]],[\"name/1474\",[61,38.122]],[\"comment/1474\",[]],[\"name/1475\",[739,59.059]],[\"comment/1475\",[]],[\"name/1476\",[730,64.938]],[\"comment/1476\",[]],[\"name/1477\",[749,70.048]],[\"comment/1477\",[]],[\"name/1478\",[5,21.132]],[\"comment/1478\",[]],[\"name/1479\",[724,50.584]],[\"comment/1479\",[]],[\"name/1480\",[745,59.059]],[\"comment/1480\",[]],[\"name/1481\",[364,52.698]],[\"comment/1481\",[]],[\"name/1482\",[750,70.048]],[\"comment/1482\",[]],[\"name/1483\",[0,51.585]],[\"comment/1483\",[]],[\"name/1484\",[7,42.109]],[\"comment/1484\",[]],[\"name/1485\",[742,59.059]],[\"comment/1485\",[]],[\"name/1486\",[743,59.059]],[\"comment/1486\",[]],[\"name/1487\",[751,70.048]],[\"comment/1487\",[]],[\"name/1488\",[752,64.938]],[\"comment/1488\",[]],[\"name/1489\",[753,64.938]],[\"comment/1489\",[]],[\"name/1490\",[754,64.938]],[\"comment/1490\",[]],[\"name/1491\",[755,64.938]],[\"comment/1491\",[]],[\"name/1492\",[756,70.048]],[\"comment/1492\",[]],[\"name/1493\",[757,70.048]],[\"comment/1493\",[]],[\"name/1494\",[758,70.048]],[\"comment/1494\",[]],[\"name/1495\",[729,55.381]],[\"comment/1495\",[]],[\"name/1496\",[364,52.698]],[\"comment/1496\",[]],[\"name/1497\",[759,70.048]],[\"comment/1497\",[]],[\"name/1498\",[760,70.048]],[\"comment/1498\",[]],[\"name/1499\",[5,21.132]],[\"comment/1499\",[]],[\"name/1500\",[61,38.122]],[\"comment/1500\",[]],[\"name/1501\",[380,50.584]],[\"comment/1501\",[]],[\"name/1502\",[726,64.938]],[\"comment/1502\",[]],[\"name/1503\",[725,61.573]],[\"comment/1503\",[]],[\"name/1504\",[761,70.048]],[\"comment/1504\",[]],[\"name/1505\",[762,70.048]],[\"comment/1505\",[]],[\"name/1506\",[763,70.048]],[\"comment/1506\",[]],[\"name/1507\",[764,70.048]],[\"comment/1507\",[]],[\"name/1508\",[765,70.048]],[\"comment/1508\",[]],[\"name/1509\",[766,70.048]],[\"comment/1509\",[]],[\"name/1510\",[767,70.048]],[\"comment/1510\",[]],[\"name/1511\",[5,21.132]],[\"comment/1511\",[]],[\"name/1512\",[61,38.122]],[\"comment/1512\",[]],[\"name/1513\",[0,51.585]],[\"comment/1513\",[]],[\"name/1514\",[7,42.109]],[\"comment/1514\",[]],[\"name/1515\",[739,59.059]],[\"comment/1515\",[]],[\"name/1516\",[740,57.052]],[\"comment/1516\",[]],[\"name/1517\",[768,70.048]],[\"comment/1517\",[]],[\"name/1518\",[202,55.381]],[\"comment/1518\",[]],[\"name/1519\",[663,64.938]],[\"comment/1519\",[]],[\"name/1520\",[5,21.132]],[\"comment/1520\",[]],[\"name/1521\",[380,50.584]],[\"comment/1521\",[]],[\"name/1522\",[769,70.048]],[\"comment/1522\",[]],[\"name/1523\",[5,21.132]],[\"comment/1523\",[]],[\"name/1524\",[61,38.122]],[\"comment/1524\",[]],[\"name/1525\",[770,70.048]],[\"comment/1525\",[]],[\"name/1526\",[647,61.573]],[\"comment/1526\",[]],[\"name/1527\",[647,61.573]],[\"comment/1527\",[]],[\"name/1528\",[771,70.048]],[\"comment/1528\",[]],[\"name/1529\",[503,64.938]],[\"comment/1529\",[]],[\"name/1530\",[772,70.048]],[\"comment/1530\",[]],[\"name/1531\",[773,70.048]],[\"comment/1531\",[]],[\"name/1532\",[774,70.048]],[\"comment/1532\",[]],[\"name/1533\",[775,70.048]],[\"comment/1533\",[]],[\"name/1534\",[555,59.059]],[\"comment/1534\",[]],[\"name/1535\",[555,59.059]],[\"comment/1535\",[]],[\"name/1536\",[555,59.059]],[\"comment/1536\",[]],[\"name/1537\",[776,70.048]],[\"comment/1537\",[]],[\"name/1538\",[777,70.048]],[\"comment/1538\",[]],[\"name/1539\",[83,52.698]],[\"comment/1539\",[]],[\"name/1540\",[778,70.048]],[\"comment/1540\",[]],[\"name/1541\",[662,64.938]],[\"comment/1541\",[]],[\"name/1542\",[779,70.048]],[\"comment/1542\",[]],[\"name/1543\",[780,70.048]],[\"comment/1543\",[]],[\"name/1544\",[604,61.573]],[\"comment/1544\",[]],[\"name/1545\",[781,70.048]],[\"comment/1545\",[]],[\"name/1546\",[782,70.048]],[\"comment/1546\",[]],[\"name/1547\",[5,21.132]],[\"comment/1547\",[]],[\"name/1548\",[171,51.585]],[\"comment/1548\",[]],[\"name/1549\",[783,70.048]],[\"comment/1549\",[]],[\"name/1550\",[5,21.132]],[\"comment/1550\",[]],[\"name/1551\",[171,51.585]],[\"comment/1551\",[]],[\"name/1552\",[784,70.048]],[\"comment/1552\",[]],[\"name/1553\",[5,21.132]],[\"comment/1553\",[]],[\"name/1554\",[380,50.584]],[\"comment/1554\",[]],[\"name/1555\",[127,64.938]],[\"comment/1555\",[]],[\"name/1556\",[604,61.573]],[\"comment/1556\",[]],[\"name/1557\",[380,50.584]],[\"comment/1557\",[]],[\"name/1558\",[82,53.95]],[\"comment/1558\",[]],[\"name/1559\",[83,52.698]],[\"comment/1559\",[]],[\"name/1560\",[785,70.048]],[\"comment/1560\",[]],[\"name/1561\",[786,70.048]],[\"comment/1561\",[]],[\"name/1562\",[787,70.048]],[\"comment/1562\",[]],[\"name/1563\",[585,61.573]],[\"comment/1563\",[]],[\"name/1564\",[788,70.048]],[\"comment/1564\",[]],[\"name/1565\",[209,61.573]],[\"comment/1565\",[]],[\"name/1566\",[789,70.048]],[\"comment/1566\",[]],[\"name/1567\",[5,21.132]],[\"comment/1567\",[]],[\"name/1568\",[6,37.851]],[\"comment/1568\",[]],[\"name/1569\",[45,64.938]],[\"comment/1569\",[]],[\"name/1570\",[790,70.048]],[\"comment/1570\",[]],[\"name/1571\",[5,21.132]],[\"comment/1571\",[]],[\"name/1572\",[6,37.851]],[\"comment/1572\",[]],[\"name/1573\",[791,70.048]],[\"comment/1573\",[]],[\"name/1574\",[792,70.048]],[\"comment/1574\",[]],[\"name/1575\",[793,70.048]],[\"comment/1575\",[]],[\"name/1576\",[794,70.048]],[\"comment/1576\",[]],[\"name/1577\",[795,70.048]],[\"comment/1577\",[]],[\"name/1578\",[745,59.059]],[\"comment/1578\",[]],[\"name/1579\",[796,70.048]],[\"comment/1579\",[]],[\"name/1580\",[797,70.048]],[\"comment/1580\",[]],[\"name/1581\",[798,70.048]],[\"comment/1581\",[]],[\"name/1582\",[799,70.048]],[\"comment/1582\",[]],[\"name/1583\",[5,21.132]],[\"comment/1583\",[]],[\"name/1584\",[592,61.573]],[\"comment/1584\",[]],[\"name/1585\",[724,50.584]],[\"comment/1585\",[]],[\"name/1586\",[742,59.059]],[\"comment/1586\",[]],[\"name/1587\",[740,57.052]],[\"comment/1587\",[]],[\"name/1588\",[743,59.059]],[\"comment/1588\",[]],[\"name/1589\",[800,64.938]],[\"comment/1589\",[]],[\"name/1590\",[729,55.381]],[\"comment/1590\",[]],[\"name/1591\",[364,52.698]],[\"comment/1591\",[]],[\"name/1592\",[801,70.048]],[\"comment/1592\",[]],[\"name/1593\",[5,21.132]],[\"comment/1593\",[]],[\"name/1594\",[752,64.938]],[\"comment/1594\",[]],[\"name/1595\",[754,64.938]],[\"comment/1595\",[]],[\"name/1596\",[753,64.938]],[\"comment/1596\",[]],[\"name/1597\",[755,64.938]],[\"comment/1597\",[]],[\"name/1598\",[802,70.048]],[\"comment/1598\",[]],[\"name/1599\",[803,70.048]],[\"comment/1599\",[]],[\"name/1600\",[804,70.048]],[\"comment/1600\",[]],[\"name/1601\",[724,50.584]],[\"comment/1601\",[]],[\"name/1602\",[745,59.059]],[\"comment/1602\",[]],[\"name/1603\",[364,52.698]],[\"comment/1603\",[]],[\"name/1604\",[805,70.048]],[\"comment/1604\",[]],[\"name/1605\",[806,70.048]],[\"comment/1605\",[]],[\"name/1606\",[5,21.132]],[\"comment/1606\",[]],[\"name/1607\",[96,51.585]],[\"comment/1607\",[]],[\"name/1608\",[202,55.381]],[\"comment/1608\",[]],[\"name/1609\",[807,70.048]],[\"comment/1609\",[]],[\"name/1610\",[5,21.132]],[\"comment/1610\",[]],[\"name/1611\",[270,57.052]],[\"comment/1611\",[]],[\"name/1612\",[808,70.048]],[\"comment/1612\",[]],[\"name/1613\",[809,70.048]],[\"comment/1613\",[]],[\"name/1614\",[5,21.132]],[\"comment/1614\",[]],[\"name/1615\",[270,57.052]],[\"comment/1615\",[]],[\"name/1616\",[810,70.048]],[\"comment/1616\",[]],[\"name/1617\",[811,70.048]],[\"comment/1617\",[]],[\"name/1618\",[5,21.132]],[\"comment/1618\",[]],[\"name/1619\",[126,64.938]],[\"comment/1619\",[]],[\"name/1620\",[380,50.584]],[\"comment/1620\",[]],[\"name/1621\",[61,38.122]],[\"comment/1621\",[]],[\"name/1622\",[812,70.048]],[\"comment/1622\",[]],[\"name/1623\",[813,70.048]],[\"comment/1623\",[]],[\"name/1624\",[814,70.048]],[\"comment/1624\",[]],[\"name/1625\",[815,70.048]],[\"comment/1625\",[]],[\"name/1626\",[816,70.048]],[\"comment/1626\",[]],[\"name/1627\",[5,21.132]],[\"comment/1627\",[]],[\"name/1628\",[592,61.573]],[\"comment/1628\",[]],[\"name/1629\",[724,50.584]],[\"comment/1629\",[]],[\"name/1630\",[742,59.059]],[\"comment/1630\",[]],[\"name/1631\",[740,57.052]],[\"comment/1631\",[]],[\"name/1632\",[743,59.059]],[\"comment/1632\",[]],[\"name/1633\",[800,64.938]],[\"comment/1633\",[]],[\"name/1634\",[364,52.698]],[\"comment/1634\",[]],[\"name/1635\",[817,70.048]],[\"comment/1635\",[]],[\"name/1636\",[818,70.048]],[\"comment/1636\",[]],[\"name/1637\",[585,61.573]],[\"comment/1637\",[]],[\"name/1638\",[61,38.122]],[\"comment/1638\",[]],[\"name/1639\",[83,52.698]],[\"comment/1639\",[]],[\"name/1640\",[82,53.95]],[\"comment/1640\",[]],[\"name/1641\",[84,57.052]],[\"comment/1641\",[]],[\"name/1642\",[243,61.573]],[\"comment/1642\",[]],[\"name/1643\",[8,42.961]],[\"comment/1643\",[]],[\"name/1644\",[819,70.048]],[\"comment/1644\",[]],[\"name/1645\",[820,70.048]],[\"comment/1645\",[]],[\"name/1646\",[85,57.052]],[\"comment/1646\",[]],[\"name/1647\",[86,61.573]],[\"comment/1647\",[]],[\"name/1648\",[352,55.381]],[\"comment/1648\",[]]],\"invertedIndex\":[[\"__type\",{\"_index\":5,\"name\":{\"5\":{},\"10\":{},\"15\":{},\"19\":{},\"22\":{},\"26\":{},\"29\":{},\"33\":{},\"38\":{},\"42\":{},\"47\":{},\"51\":{},\"59\":{},\"64\":{},\"68\":{},\"72\":{},\"76\":{},\"84\":{},\"88\":{},\"91\":{},\"95\":{},\"99\":{},\"103\":{},\"106\":{},\"110\":{},\"114\":{},\"118\":{},\"123\":{},\"127\":{},\"131\":{},\"135\":{},\"139\":{},\"143\":{},\"146\":{},\"151\":{},\"155\":{},\"159\":{},\"164\":{},\"168\":{},\"171\":{},\"177\":{},\"239\":{},\"245\":{},\"253\":{},\"259\":{},\"266\":{},\"272\":{},\"291\":{},\"299\":{},\"304\":{},\"312\":{},\"316\":{},\"319\":{},\"325\":{},\"342\":{},\"346\":{},\"352\":{},\"355\":{},\"364\":{},\"373\":{},\"384\":{},\"391\":{},\"400\":{},\"403\":{},\"409\":{},\"416\":{},\"422\":{},\"427\":{},\"432\":{},\"437\":{},\"448\":{},\"455\":{},\"464\":{},\"467\":{},\"471\":{},\"474\":{},\"477\":{},\"480\":{},\"583\":{},\"588\":{},\"592\":{},\"595\":{},\"599\":{},\"604\":{},\"606\":{},\"608\":{},\"610\":{},\"624\":{},\"689\":{},\"694\":{},\"701\":{},\"719\":{},\"729\":{},\"731\":{},\"736\":{},\"740\":{},\"749\":{},\"756\":{},\"762\":{},\"768\":{},\"772\":{},\"778\":{},\"781\":{},\"789\":{},\"797\":{},\"805\":{},\"817\":{},\"819\":{},\"828\":{},\"838\":{},\"847\":{},\"854\":{},\"859\":{},\"865\":{},\"871\":{},\"880\":{},\"885\":{},\"887\":{},\"892\":{},\"899\":{},\"908\":{},\"917\":{},\"921\":{},\"929\":{},\"939\":{},\"943\":{},\"952\":{},\"961\":{},\"970\":{},\"977\":{},\"984\":{},\"990\":{},\"995\":{},\"1003\":{},\"1009\":{},\"1016\":{},\"1018\":{},\"1024\":{},\"1027\":{},\"1032\":{},\"1038\":{},\"1043\":{},\"1047\":{},\"1049\":{},\"1051\":{},\"1053\":{},\"1055\":{},\"1061\":{},\"1069\":{},\"1082\":{},\"1091\":{},\"1098\":{},\"1217\":{},\"1222\":{},\"1231\":{},\"1234\":{},\"1250\":{},\"1260\":{},\"1265\":{},\"1285\":{},\"1291\":{},\"1298\":{},\"1305\":{},\"1310\":{},\"1314\":{},\"1321\":{},\"1326\":{},\"1331\":{},\"1336\":{},\"1348\":{},\"1359\":{},\"1362\":{},\"1365\":{},\"1410\":{},\"1423\":{},\"1430\":{},\"1437\":{},\"1445\":{},\"1452\":{},\"1462\":{},\"1467\":{},\"1471\":{},\"1478\":{},\"1499\":{},\"1511\":{},\"1520\":{},\"1523\":{},\"1547\":{},\"1550\":{},\"1553\":{},\"1567\":{},\"1571\":{},\"1583\":{},\"1593\":{},\"1606\":{},\"1610\":{},\"1614\":{},\"1618\":{},\"1627\":{}},\"comment\":{}}],[\"_from\",{\"_index\":657,\"name\":{\"1223\":{}},\"comment\":{}}],[\"_id\",{\"_index\":654,\"name\":{\"1219\":{},\"1232\":{}},\"comment\":{}}],[\"_key\",{\"_index\":653,\"name\":{\"1218\":{},\"1235\":{}},\"comment\":{}}],[\"_rev\",{\"_index\":655,\"name\":{\"1220\":{}},\"comment\":{}}],[\"_to\",{\"_index\":658,\"name\":{\"1224\":{}},\"comment\":{}}],[\"abort\",{\"_index\":786,\"name\":{\"1561\":{}},\"comment\":{}}],[\"accent\",{\"_index\":16,\"name\":{\"36\":{},\"56\":{}},\"comment\":{}}],[\"accesslevel\",{\"_index\":514,\"name\":{\"1025\":{}},\"comment\":{}}],[\"acquirehostlist\",{\"_index\":557,\"name\":{\"1112\":{}},\"comment\":{}}],[\"active\",{\"_index\":455,\"name\":{\"862\":{},\"1029\":{},\"1035\":{},\"1040\":{}},\"comment\":{}}],[\"addedgedefinition\",{\"_index\":719,\"name\":{\"1401\":{}},\"comment\":{}}],[\"addedgedefinitionoptions\",{\"_index\":705,\"name\":{\"1361\":{}},\"comment\":{}}],[\"addvertexcollection\",{\"_index\":715,\"name\":{\"1396\":{}},\"comment\":{}}],[\"addvertexcollectionoptions\",{\"_index\":704,\"name\":{\"1358\":{}},\"comment\":{}}],[\"after\",{\"_index\":299,\"name\":{\"607\":{}},\"comment\":{}}],[\"agent\",{\"_index\":316,\"name\":{\"632\":{}},\"comment\":{}}],[\"agentoptions\",{\"_index\":309,\"name\":{\"622\":{},\"633\":{}},\"comment\":{}}],[\"all\",{\"_index\":260,\"name\":{\"513\":{},\"541\":{},\"665\":{},\"678\":{}},\"comment\":{}}],[\"allowdirtyread\",{\"_index\":171,\"name\":{\"348\":{},\"353\":{},\"401\":{},\"615\":{},\"696\":{},\"702\":{},\"1308\":{},\"1548\":{},\"1551\":{}},\"comment\":{}}],[\"allowimplicit\",{\"_index\":359,\"name\":{\"695\":{}},\"comment\":{}}],[\"allowinconsistent\",{\"_index\":524,\"name\":{\"1056\":{}},\"comment\":{}}],[\"allowretry\",{\"_index\":363,\"name\":{\"703\":{}},\"comment\":{}}],[\"allowuserkeys\",{\"_index\":129,\"name\":{\"261\":{},\"321\":{}},\"comment\":{}}],[\"allplans\",{\"_index\":378,\"name\":{\"734\":{}},\"comment\":{}}],[\"analyzer\",{\"_index\":0,\"name\":{\"0\":{},\"111\":{},\"137\":{},\"200\":{},\"1150\":{},\"1447\":{},\"1454\":{},\"1483\":{},\"1513\":{}},\"comment\":{}}],[\"analyzerdescription\",{\"_index\":62,\"name\":{\"180\":{}},\"comment\":{}}],[\"analyzerfeature\",{\"_index\":2,\"name\":{\"2\":{}},\"comment\":{}}],[\"analyzers\",{\"_index\":592,\"name\":{\"1153\":{},\"1584\":{},\"1628\":{}},\"comment\":{}}],[\"any\",{\"_index\":261,\"name\":{\"514\":{},\"542\":{}},\"comment\":{}}],[\"aql\",{\"_index\":86,\"name\":{\"206\":{},\"209\":{},\"1647\":{}},\"comment\":{}}],[\"aqlanalyzerdescription\",{\"_index\":71,\"name\":{\"189\":{}},\"comment\":{}}],[\"aqlliteral\",{\"_index\":94,\"name\":{\"216\":{}},\"comment\":{}}],[\"aqlquery\",{\"_index\":91,\"name\":{\"212\":{}},\"comment\":{}}],[\"aqluserfunction\",{\"_index\":464,\"name\":{\"886\":{}},\"comment\":{}}],[\"aqlvalue\",{\"_index\":95,\"name\":{\"217\":{}},\"comment\":{}}],[\"arangoapiresponse\",{\"_index\":284,\"name\":{\"586\":{}},\"comment\":{}}],[\"arangocollection\",{\"_index\":99,\"name\":{\"221\":{}},\"comment\":{}}],[\"arangoerror\",{\"_index\":671,\"name\":{\"1244\":{}},\"comment\":{}}],[\"arangojs\",{\"_index\":722,\"name\":{\"1406\":{}},\"comment\":{}}],[\"arangoresponsemetadata\",{\"_index\":282,\"name\":{\"582\":{}},\"comment\":{}}],[\"arangosearchviewdescription\",{\"_index\":813,\"name\":{\"1623\":{}},\"comment\":{}}],[\"arangosearchviewlink\",{\"_index\":816,\"name\":{\"1626\":{}},\"comment\":{}}],[\"arangosearchviewlinkoptions\",{\"_index\":799,\"name\":{\"1582\":{}},\"comment\":{}}],[\"arangosearchviewpatchpropertiesoptions\",{\"_index\":803,\"name\":{\"1599\":{}},\"comment\":{}}],[\"arangosearchviewproperties\",{\"_index\":817,\"name\":{\"1635\":{}},\"comment\":{}}],[\"arangosearchviewpropertiesoptions\",{\"_index\":801,\"name\":{\"1592\":{}},\"comment\":{}}],[\"arangosearchviewstoredvalueoptions\",{\"_index\":804,\"name\":{\"1600\":{}},\"comment\":{}}],[\"arangouser\",{\"_index\":515,\"name\":{\"1026\":{}},\"comment\":{}}],[\"arangoversion\",{\"_index\":314,\"name\":{\"628\":{}},\"comment\":{}}],[\"arraycursor\",{\"_index\":350,\"name\":{\"673\":{}},\"comment\":{}}],[\"ast\",{\"_index\":400,\"name\":{\"776\":{}},\"comment\":{}}],[\"astnode\",{\"_index\":396,\"name\":{\"767\":{}},\"comment\":{}}],[\"asynciterator\",{\"_index\":349,\"name\":{\"672\":{},\"685\":{}},\"comment\":{}}],[\"auth\",{\"_index\":313,\"name\":{\"627\":{}},\"comment\":{}}],[\"author\",{\"_index\":683,\"name\":{\"1276\":{}},\"comment\":{}}],[\"basepath\",{\"_index\":306,\"name\":{\"619\":{}},\"comment\":{}}],[\"basicauthcredentials\",{\"_index\":285,\"name\":{\"587\":{}},\"comment\":{}}],[\"batchedarraycursor\",{\"_index\":337,\"name\":{\"658\":{}},\"comment\":{}}],[\"batches\",{\"_index\":351,\"name\":{\"674\":{}},\"comment\":{}}],[\"batchsize\",{\"_index\":32,\"name\":{\"80\":{},\"406\":{},\"412\":{},\"707\":{}},\"comment\":{}}],[\"bearerauthcredentials\",{\"_index\":288,\"name\":{\"591\":{}},\"comment\":{}}],[\"before\",{\"_index\":298,\"name\":{\"605\":{}},\"comment\":{}}],[\"beforesend\",{\"_index\":293,\"name\":{\"598\":{}},\"comment\":{}}],[\"begintransaction\",{\"_index\":605,\"name\":{\"1166\":{}},\"comment\":{}}],[\"bindvars\",{\"_index\":93,\"name\":{\"214\":{},\"775\":{},\"810\":{}},\"comment\":{}}],[\"body\",{\"_index\":302,\"name\":{\"612\":{}},\"comment\":{}}],[\"break\",{\"_index\":27,\"name\":{\"69\":{}},\"comment\":{}}],[\"byexample\",{\"_index\":262,\"name\":{\"515\":{},\"543\":{}},\"comment\":{}}],[\"bytesaccumconsolidationpolicy\",{\"_index\":789,\"name\":{\"1566\":{}},\"comment\":{}}],[\"cache\",{\"_index\":364,\"name\":{\"708\":{},\"1460\":{},\"1465\":{},\"1481\":{},\"1496\":{},\"1591\":{},\"1603\":{},\"1634\":{}},\"comment\":{}}],[\"cacheable\",{\"_index\":393,\"name\":{\"758\":{},\"764\":{}},\"comment\":{}}],[\"cacheenabled\",{\"_index\":150,\"name\":{\"286\":{},\"310\":{},\"340\":{},\"1419\":{}},\"comment\":{}}],[\"cachehits\",{\"_index\":325,\"name\":{\"644\":{}},\"comment\":{}}],[\"cachemisses\",{\"_index\":326,\"name\":{\"645\":{}},\"comment\":{}}],[\"canbedisabled\",{\"_index\":405,\"name\":{\"784\":{}},\"comment\":{}}],[\"cancel\",{\"_index\":773,\"name\":{\"1531\":{}},\"comment\":{}}],[\"cancreateadditionalplans\",{\"_index\":406,\"name\":{\"785\":{}},\"comment\":{}}],[\"case\",{\"_index\":15,\"name\":{\"35\":{},\"53\":{},\"70\":{}},\"comment\":{}}],[\"checksum\",{\"_index\":241,\"name\":{\"493\":{},\"559\":{},\"937\":{}},\"comment\":{}}],[\"classificationanalyzerdescription\",{\"_index\":76,\"name\":{\"194\":{}},\"comment\":{}}],[\"cleanupintervalstep\",{\"_index\":752,\"name\":{\"1488\":{},\"1594\":{}},\"comment\":{}}],[\"clearslowqueries\",{\"_index\":614,\"name\":{\"1177\":{}},\"comment\":{}}],[\"clearuseraccesslevel\",{\"_index\":601,\"name\":{\"1162\":{}},\"comment\":{}}],[\"close\",{\"_index\":558,\"name\":{\"1113\":{}},\"comment\":{}}],[\"clusterimbalanceinfo\",{\"_index\":421,\"name\":{\"816\":{}},\"comment\":{}}],[\"clusteronly\",{\"_index\":404,\"name\":{\"783\":{}},\"comment\":{}}],[\"clusterrebalancemove\",{\"_index\":444,\"name\":{\"846\":{}},\"comment\":{}}],[\"clusterrebalanceoptions\",{\"_index\":436,\"name\":{\"837\":{}},\"comment\":{}}],[\"clusterrebalanceresult\",{\"_index\":449,\"name\":{\"853\":{}},\"comment\":{}}],[\"clusterrebalancestate\",{\"_index\":435,\"name\":{\"836\":{}},\"comment\":{}}],[\"code\",{\"_index\":283,\"name\":{\"585\":{},\"889\":{},\"1241\":{},\"1247\":{},\"1254\":{},\"1258\":{},\"1262\":{}},\"comment\":{}}],[\"collapsepositions\",{\"_index\":30,\"name\":{\"78\":{}},\"comment\":{}}],[\"collationanalyzerdescription\",{\"_index\":74,\"name\":{\"192\":{}},\"comment\":{}}],[\"collection\",{\"_index\":96,\"name\":{\"218\":{},\"851\":{},\"1045\":{},\"1135\":{},\"1327\":{},\"1332\":{},\"1369\":{},\"1379\":{},\"1607\":{}},\"comment\":{}}],[\"collectionbatchreadoptions\",{\"_index\":172,\"name\":{\"351\":{}},\"comment\":{}}],[\"collectionchecksumoptions\",{\"_index\":157,\"name\":{\"311\":{}},\"comment\":{}}],[\"collectiondropoptions\",{\"_index\":160,\"name\":{\"315\":{}},\"comment\":{}}],[\"collectionedgesoptions\",{\"_index\":190,\"name\":{\"399\":{}},\"comment\":{}}],[\"collectionedgesresult\",{\"_index\":225,\"name\":{\"463\":{}},\"comment\":{}}],[\"collectionimportoptions\",{\"_index\":184,\"name\":{\"390\":{}},\"comment\":{}}],[\"collectionimportresult\",{\"_index\":219,\"name\":{\"454\":{}},\"comment\":{}}],[\"collectioninsertoptions\",{\"_index\":173,\"name\":{\"354\":{}},\"comment\":{}}],[\"collectionkeyoptions\",{\"_index\":162,\"name\":{\"318\":{}},\"comment\":{}}],[\"collectionkeyproperties\",{\"_index\":128,\"name\":{\"258\":{}},\"comment\":{}}],[\"collectionmetadata\",{\"_index\":125,\"name\":{\"252\":{}},\"comment\":{}}],[\"collectionproperties\",{\"_index\":137,\"name\":{\"271\":{}},\"comment\":{}}],[\"collectionpropertiesoptions\",{\"_index\":156,\"name\":{\"303\":{}},\"comment\":{}}],[\"collectionreadoptions\",{\"_index\":169,\"name\":{\"345\":{}},\"comment\":{}}],[\"collectionremoveoptions\",{\"_index\":183,\"name\":{\"383\":{}},\"comment\":{}}],[\"collectionreplaceoptions\",{\"_index\":180,\"name\":{\"363\":{}},\"comment\":{}}],[\"collections\",{\"_index\":383,\"name\":{\"743\":{},\"774\":{},\"1140\":{}},\"comment\":{}}],[\"collectionstatus\",{\"_index\":103,\"name\":{\"226\":{}},\"comment\":{}}],[\"collectiontostring\",{\"_index\":98,\"name\":{\"220\":{}},\"comment\":{}}],[\"collectiontype\",{\"_index\":100,\"name\":{\"223\":{}},\"comment\":{}}],[\"collectionupdateoptions\",{\"_index\":182,\"name\":{\"372\":{}},\"comment\":{}}],[\"commit\",{\"_index\":785,\"name\":{\"1560\":{}},\"comment\":{}}],[\"commitintervalmsec\",{\"_index\":753,\"name\":{\"1489\":{},\"1596\":{}},\"comment\":{}}],[\"commitlocalservicestate\",{\"_index\":638,\"name\":{\"1201\":{}},\"comment\":{}}],[\"compact\",{\"_index\":273,\"name\":{\"527\":{},\"576\":{}},\"comment\":{}}],[\"complete\",{\"_index\":188,\"name\":{\"397\":{}},\"comment\":{}}],[\"compression\",{\"_index\":745,\"name\":{\"1464\":{},\"1480\":{},\"1578\":{},\"1602\":{}},\"comment\":{}}],[\"computeclusterrebalance\",{\"_index\":568,\"name\":{\"1123\":{}},\"comment\":{}}],[\"computedvalueoptions\",{\"_index\":154,\"name\":{\"290\":{}},\"comment\":{}}],[\"computedvalueproperties\",{\"_index\":120,\"name\":{\"244\":{}},\"comment\":{}}],[\"computedvalues\",{\"_index\":149,\"name\":{\"285\":{},\"309\":{},\"339\":{}},\"comment\":{}}],[\"computeon\",{\"_index\":123,\"name\":{\"249\":{},\"295\":{}},\"comment\":{}}],[\"config\",{\"_index\":310,\"name\":{\"623\":{}},\"comment\":{}}],[\"configuration\",{\"_index\":467,\"name\":{\"893\":{},\"900\":{},\"909\":{},\"940\":{},\"1266\":{},\"1284\":{}},\"comment\":{}}],[\"connection\",{\"_index\":278,\"name\":{\"578\":{}},\"comment\":{}}],[\"consolidationintervalmsec\",{\"_index\":754,\"name\":{\"1490\":{},\"1595\":{}},\"comment\":{}}],[\"consolidationpolicy\",{\"_index\":755,\"name\":{\"1491\":{},\"1597\":{}},\"comment\":{}}],[\"constructor\",{\"_index\":553,\"name\":{\"1106\":{}},\"comment\":{}}],[\"contributors\",{\"_index\":684,\"name\":{\"1277\":{}},\"comment\":{}}],[\"count\",{\"_index\":237,\"name\":{\"489\":{},\"555\":{},\"661\":{},\"676\":{},\"706\":{}},\"comment\":{}}],[\"create\",{\"_index\":84,\"name\":{\"204\":{},\"487\":{},\"553\":{},\"1391\":{},\"1641\":{}},\"comment\":{}}],[\"createanalyzer\",{\"_index\":590,\"name\":{\"1151\":{}},\"comment\":{}}],[\"createanalyzeroptions\",{\"_index\":3,\"name\":{\"3\":{}},\"comment\":{}}],[\"createaqlanalyzeroptions\",{\"_index\":28,\"name\":{\"71\":{}},\"comment\":{}}],[\"createarangosearchviewoptions\",{\"_index\":805,\"name\":{\"1604\":{}},\"comment\":{}}],[\"createclassificationanalyzeroptions\",{\"_index\":42,\"name\":{\"113\":{}},\"comment\":{}}],[\"createcollationanalyzeroptions\",{\"_index\":39,\"name\":{\"98\":{}},\"comment\":{}}],[\"createcollection\",{\"_index\":577,\"name\":{\"1136\":{}},\"comment\":{}}],[\"createcollectionoptions\",{\"_index\":163,\"name\":{\"324\":{}},\"comment\":{}}],[\"created\",{\"_index\":220,\"name\":{\"457\":{}},\"comment\":{}}],[\"createdatabase\",{\"_index\":571,\"name\":{\"1129\":{}},\"comment\":{}}],[\"createdatabaseoptions\",{\"_index\":456,\"name\":{\"864\":{}},\"comment\":{}}],[\"createdatabaseuser\",{\"_index\":453,\"name\":{\"858\":{}},\"comment\":{}}],[\"createdelimiteranalyzeroptions\",{\"_index\":9,\"name\":{\"9\":{}},\"comment\":{}}],[\"createedgecollection\",{\"_index\":578,\"name\":{\"1137\":{}},\"comment\":{}}],[\"createfunction\",{\"_index\":617,\"name\":{\"1180\":{}},\"comment\":{}}],[\"creategeojsonanalyzeroptions\",{\"_index\":49,\"name\":{\"138\":{}},\"comment\":{}}],[\"creategeopointanalyzeroptions\",{\"_index\":54,\"name\":{\"150\":{}},\"comment\":{}}],[\"creategeos2analyzeroptions\",{\"_index\":58,\"name\":{\"163\":{}},\"comment\":{}}],[\"creategraph\",{\"_index\":582,\"name\":{\"1142\":{}},\"comment\":{}}],[\"creategraphoptions\",{\"_index\":702,\"name\":{\"1347\":{}},\"comment\":{}}],[\"createhotbackup\",{\"_index\":639,\"name\":{\"1202\":{}},\"comment\":{}}],[\"createidentityanalyzeroptions\",{\"_index\":4,\"name\":{\"4\":{}},\"comment\":{}}],[\"createjob\",{\"_index\":556,\"name\":{\"1111\":{}},\"comment\":{}}],[\"createminhashanalyzeroptions\",{\"_index\":40,\"name\":{\"105\":{}},\"comment\":{}}],[\"createmultidelimiteranalyzeroptions\",{\"_index\":10,\"name\":{\"14\":{}},\"comment\":{}}],[\"createnearestneighborsanalyzeroptions\",{\"_index\":46,\"name\":{\"122\":{}},\"comment\":{}}],[\"createngramanalyzeroptions\",{\"_index\":17,\"name\":{\"37\":{}},\"comment\":{}}],[\"createnormanalyzeroptions\",{\"_index\":14,\"name\":{\"28\":{}},\"comment\":{}}],[\"createpipelineanalyzeroptions\",{\"_index\":35,\"name\":{\"83\":{}},\"comment\":{}}],[\"createsearchaliasviewoptions\",{\"_index\":810,\"name\":{\"1616\":{}},\"comment\":{}}],[\"createsegmentationanalyzeroptions\",{\"_index\":26,\"name\":{\"63\":{}},\"comment\":{}}],[\"createstemanalyzeroptions\",{\"_index\":12,\"name\":{\"21\":{}},\"comment\":{}}],[\"createstopwordsanalyzeroptions\",{\"_index\":37,\"name\":{\"90\":{}},\"comment\":{}}],[\"createtextanalyzeroptions\",{\"_index\":21,\"name\":{\"46\":{}},\"comment\":{}}],[\"createuser\",{\"_index\":595,\"name\":{\"1156\":{}},\"comment\":{}}],[\"createuseroptions\",{\"_index\":516,\"name\":{\"1031\":{}},\"comment\":{}}],[\"createview\",{\"_index\":586,\"name\":{\"1146\":{}},\"comment\":{}}],[\"createviewoptions\",{\"_index\":796,\"name\":{\"1579\":{}},\"comment\":{}}],[\"createwildcardanalyzeroptions\",{\"_index\":47,\"name\":{\"130\":{}},\"comment\":{}}],[\"current\",{\"_index\":484,\"name\":{\"946\":{},\"954\":{},\"963\":{}},\"comment\":{}}],[\"currentraw\",{\"_index\":483,\"name\":{\"945\":{}},\"comment\":{}}],[\"cursor\",{\"_index\":319,\"name\":{\"637\":{}},\"comment\":{}}],[\"cursorextras\",{\"_index\":320,\"name\":{\"638\":{}},\"comment\":{}}],[\"cursorscreated\",{\"_index\":327,\"name\":{\"646\":{}},\"comment\":{}}],[\"cursorsrearmed\",{\"_index\":328,\"name\":{\"647\":{}},\"comment\":{}}],[\"cursorstats\",{\"_index\":324,\"name\":{\"643\":{}},\"comment\":{}}],[\"database\",{\"_index\":352,\"name\":{\"686\":{},\"807\":{},\"1044\":{},\"1105\":{},\"1126\":{},\"1648\":{}},\"comment\":{}}],[\"databaseinfo\",{\"_index\":459,\"name\":{\"870\":{}},\"comment\":{}}],[\"databasename\",{\"_index\":311,\"name\":{\"625\":{}},\"comment\":{}}],[\"databases\",{\"_index\":574,\"name\":{\"1132\":{}},\"comment\":{}}],[\"databasesexcluded\",{\"_index\":443,\"name\":{\"845\":{}},\"comment\":{}}],[\"date\",{\"_index\":547,\"name\":{\"1095\":{}},\"comment\":{}}],[\"datetime\",{\"_index\":529,\"name\":{\"1065\":{}},\"comment\":{}}],[\"debug\",{\"_index\":536,\"name\":{\"1077\":{}},\"comment\":{}}],[\"deduplicate\",{\"_index\":727,\"name\":{\"1416\":{}},\"comment\":{}}],[\"default\",{\"_index\":488,\"name\":{\"950\":{},\"1288\":{},\"1407\":{}},\"comment\":{}}],[\"defaultdocument\",{\"_index\":677,\"name\":{\"1267\":{}},\"comment\":{}}],[\"delete\",{\"_index\":777,\"name\":{\"1538\":{}},\"comment\":{}}],[\"deletealljobresults\",{\"_index\":651,\"name\":{\"1214\":{}},\"comment\":{}}],[\"deleted\",{\"_index\":108,\"name\":{\"231\":{},\"472\":{}},\"comment\":{}}],[\"deleteexpiredjobresults\",{\"_index\":650,\"name\":{\"1213\":{}},\"comment\":{}}],[\"deletehotbackup\",{\"_index\":642,\"name\":{\"1205\":{}},\"comment\":{}}],[\"deleteresult\",{\"_index\":774,\"name\":{\"1532\":{}},\"comment\":{}}],[\"delimiteranalyzerdescription\",{\"_index\":64,\"name\":{\"182\":{}},\"comment\":{}}],[\"delimiters\",{\"_index\":11,\"name\":{\"20\":{}},\"comment\":{}}],[\"dependencies\",{\"_index\":468,\"name\":{\"894\":{},\"901\":{},\"910\":{},\"941\":{},\"1268\":{}},\"comment\":{}}],[\"dependency\",{\"_index\":687,\"name\":{\"1290\":{}},\"comment\":{}}],[\"description\",{\"_index\":486,\"name\":{\"948\":{},\"958\":{},\"967\":{},\"1020\":{},\"1278\":{},\"1286\":{},\"1294\":{}},\"comment\":{}}],[\"details\",{\"_index\":189,\"name\":{\"398\":{},\"462\":{},\"884\":{}},\"comment\":{}}],[\"development\",{\"_index\":469,\"name\":{\"895\":{},\"902\":{},\"911\":{},\"926\":{},\"934\":{}},\"comment\":{}}],[\"direction\",{\"_index\":209,\"name\":{\"443\":{},\"1469\":{},\"1565\":{}},\"comment\":{}}],[\"disabledbydefault\",{\"_index\":407,\"name\":{\"786\":{}},\"comment\":{}}],[\"distributeshardslike\",{\"_index\":146,\"name\":{\"282\":{},\"336\":{}},\"comment\":{}}],[\"document\",{\"_index\":248,\"name\":{\"501\":{},\"530\":{},\"1227\":{}},\"comment\":{}}],[\"document_collection\",{\"_index\":101,\"name\":{\"224\":{}},\"comment\":{}}],[\"documentcollection\",{\"_index\":236,\"name\":{\"484\":{}},\"comment\":{}}],[\"documentdata\",{\"_index\":659,\"name\":{\"1225\":{}},\"comment\":{}}],[\"documentexists\",{\"_index\":247,\"name\":{\"500\":{},\"566\":{}},\"comment\":{}}],[\"documentexistsoptions\",{\"_index\":166,\"name\":{\"341\":{}},\"comment\":{}}],[\"documentid\",{\"_index\":246,\"name\":{\"499\":{},\"565\":{}},\"comment\":{}}],[\"documentmetadata\",{\"_index\":652,\"name\":{\"1216\":{}},\"comment\":{}}],[\"documentoperationfailure\",{\"_index\":115,\"name\":{\"238\":{}},\"comment\":{}}],[\"documentoperationmetadata\",{\"_index\":119,\"name\":{\"243\":{}},\"comment\":{}}],[\"documents\",{\"_index\":249,\"name\":{\"502\":{},\"531\":{},\"1215\":{}},\"comment\":{}}],[\"documentselector\",{\"_index\":665,\"name\":{\"1236\":{}},\"comment\":{}}],[\"downloadservice\",{\"_index\":637,\"name\":{\"1200\":{}},\"comment\":{}}],[\"drop\",{\"_index\":85,\"name\":{\"205\":{},\"497\":{},\"563\":{},\"1392\":{},\"1646\":{}},\"comment\":{}}],[\"dropdatabase\",{\"_index\":576,\"name\":{\"1134\":{}},\"comment\":{}}],[\"dropfunction\",{\"_index\":618,\"name\":{\"1181\":{}},\"comment\":{}}],[\"dropindex\",{\"_index\":272,\"name\":{\"526\":{},\"575\":{}},\"comment\":{}}],[\"duration\",{\"_index\":497,\"name\":{\"975\":{},\"980\":{},\"987\":{},\"1006\":{}},\"comment\":{}}],[\"edge\",{\"_index\":661,\"name\":{\"1228\":{},\"1382\":{}},\"comment\":{}}],[\"edge_collection\",{\"_index\":102,\"name\":{\"225\":{}},\"comment\":{}}],[\"edgecollection\",{\"_index\":274,\"name\":{\"529\":{},\"1398\":{}},\"comment\":{}}],[\"edgecollections\",{\"_index\":718,\"name\":{\"1400\":{}},\"comment\":{}}],[\"edgedata\",{\"_index\":660,\"name\":{\"1226\":{}},\"comment\":{}}],[\"edgedefinition\",{\"_index\":696,\"name\":{\"1325\":{}},\"comment\":{}}],[\"edgedefinitionoptions\",{\"_index\":697,\"name\":{\"1330\":{}},\"comment\":{}}],[\"edgedefinitions\",{\"_index\":699,\"name\":{\"1338\":{}},\"comment\":{}}],[\"edgeexists\",{\"_index\":711,\"name\":{\"1381\":{}},\"comment\":{}}],[\"edgemetadata\",{\"_index\":656,\"name\":{\"1221\":{}},\"comment\":{}}],[\"edgengram\",{\"_index\":25,\"name\":{\"58\":{}},\"comment\":{}}],[\"edges\",{\"_index\":215,\"name\":{\"450\":{},\"465\":{},\"547\":{}},\"comment\":{}}],[\"empty\",{\"_index\":222,\"name\":{\"459\":{}},\"comment\":{}}],[\"enabled\",{\"_index\":410,\"name\":{\"790\":{},\"798\":{}},\"comment\":{}}],[\"enforcereplicationfactor\",{\"_index\":165,\"name\":{\"330\":{}},\"comment\":{}}],[\"engines\",{\"_index\":678,\"name\":{\"1270\":{}},\"comment\":{}}],[\"ensurefulltextindexoptions\",{\"_index\":732,\"name\":{\"1422\":{}},\"comment\":{}}],[\"ensuregeoindexoptions\",{\"_index\":731,\"name\":{\"1421\":{}},\"comment\":{}}],[\"ensureindex\",{\"_index\":271,\"name\":{\"525\":{},\"574\":{}},\"comment\":{}}],[\"ensureinvertedindexoptions\",{\"_index\":748,\"name\":{\"1470\":{}},\"comment\":{}}],[\"ensuremdiindexoptions\",{\"_index\":736,\"name\":{\"1436\":{}},\"comment\":{}}],[\"ensurepersistentindexoptions\",{\"_index\":723,\"name\":{\"1409\":{}},\"comment\":{}}],[\"ensurettlindexoptions\",{\"_index\":734,\"name\":{\"1429\":{}},\"comment\":{}}],[\"enterpriseonly\",{\"_index\":408,\"name\":{\"787\":{}},\"comment\":{}}],[\"err\",{\"_index\":500,\"name\":{\"981\":{},\"988\":{},\"1007\":{}},\"comment\":{}}],[\"errno\",{\"_index\":669,\"name\":{\"1242\":{}},\"comment\":{}}],[\"error\",{\"_index\":116,\"name\":{\"240\":{},\"456\":{},\"584\":{},\"1074\":{},\"1237\":{},\"1251\":{},\"1261\":{}},\"comment\":{}}],[\"errormessage\",{\"_index\":117,\"name\":{\"241\":{},\"1252\":{}},\"comment\":{}}],[\"errornum\",{\"_index\":118,\"name\":{\"242\":{},\"1246\":{},\"1253\":{}},\"comment\":{}}],[\"errors\",{\"_index\":221,\"name\":{\"458\":{}},\"comment\":{}}],[\"estimatedcost\",{\"_index\":385,\"name\":{\"745\":{}},\"comment\":{}}],[\"estimatednritems\",{\"_index\":386,\"name\":{\"746\":{}},\"comment\":{}}],[\"estimates\",{\"_index\":728,\"name\":{\"1417\":{}},\"comment\":{}}],[\"excludesystemcollections\",{\"_index\":441,\"name\":{\"843\":{}},\"comment\":{}}],[\"exclusive\",{\"_index\":355,\"name\":{\"690\":{}},\"comment\":{}}],[\"executeclusterrebalance\",{\"_index\":569,\"name\":{\"1124\":{}},\"comment\":{}}],[\"executetransaction\",{\"_index\":603,\"name\":{\"1164\":{}},\"comment\":{}}],[\"executiontime\",{\"_index\":333,\"name\":{\"654\":{},\"754\":{}},\"comment\":{}}],[\"exists\",{\"_index\":82,\"name\":{\"202\":{},\"485\":{},\"551\":{},\"1128\":{},\"1389\":{},\"1558\":{},\"1640\":{}},\"comment\":{}}],[\"expander\",{\"_index\":208,\"name\":{\"442\":{}},\"comment\":{}}],[\"expectbinary\",{\"_index\":303,\"name\":{\"613\":{}},\"comment\":{}}],[\"expireafter\",{\"_index\":735,\"name\":{\"1434\":{}},\"comment\":{}}],[\"explain\",{\"_index\":609,\"name\":{\"1171\":{}},\"comment\":{}}],[\"explainoptions\",{\"_index\":376,\"name\":{\"728\":{}},\"comment\":{}}],[\"explainplan\",{\"_index\":382,\"name\":{\"739\":{}},\"comment\":{}}],[\"explainstats\",{\"_index\":388,\"name\":{\"748\":{}},\"comment\":{}}],[\"expression\",{\"_index\":121,\"name\":{\"247\":{},\"293\":{}},\"comment\":{}}],[\"extra\",{\"_index\":339,\"name\":{\"660\":{},\"675\":{},\"863\":{},\"1030\":{},\"1036\":{},\"1041\":{}},\"comment\":{}}],[\"failonwarning\",{\"_index\":124,\"name\":{\"251\":{},\"297\":{},\"712\":{}},\"comment\":{}}],[\"failures\",{\"_index\":495,\"name\":{\"973\":{},\"1013\":{}},\"comment\":{}}],[\"fatal\",{\"_index\":534,\"name\":{\"1073\":{}},\"comment\":{}}],[\"features\",{\"_index\":7,\"name\":{\"7\":{},\"12\":{},\"17\":{},\"24\":{},\"31\":{},\"40\":{},\"49\":{},\"66\":{},\"74\":{},\"86\":{},\"93\":{},\"101\":{},\"108\":{},\"116\":{},\"125\":{},\"133\":{},\"141\":{},\"153\":{},\"166\":{},\"179\":{},\"1448\":{},\"1455\":{},\"1484\":{},\"1514\":{}},\"comment\":{}}],[\"field\",{\"_index\":747,\"name\":{\"1468\":{}},\"comment\":{}}],[\"fields\",{\"_index\":724,\"name\":{\"1412\":{},\"1425\":{},\"1432\":{},\"1439\":{},\"1463\":{},\"1473\":{},\"1479\":{},\"1585\":{},\"1601\":{},\"1629\":{}},\"comment\":{}}],[\"fieldvaluetypes\",{\"_index\":737,\"name\":{\"1440\":{}},\"comment\":{}}],[\"figures\",{\"_index\":239,\"name\":{\"491\":{},\"557\":{}},\"comment\":{}}],[\"file\",{\"_index\":688,\"name\":{\"1297\":{}},\"comment\":{}}],[\"files\",{\"_index\":679,\"name\":{\"1271\":{}},\"comment\":{}}],[\"fillblockcache\",{\"_index\":367,\"name\":{\"717\":{}},\"comment\":{}}],[\"filter\",{\"_index\":205,\"name\":{\"439\":{}},\"comment\":{}}],[\"filtered\",{\"_index\":228,\"name\":{\"469\":{},\"652\":{}},\"comment\":{}}],[\"firstexample\",{\"_index\":263,\"name\":{\"516\":{},\"544\":{}},\"comment\":{}}],[\"flags\",{\"_index\":402,\"name\":{\"780\":{}},\"comment\":{}}],[\"flatmap\",{\"_index\":346,\"name\":{\"669\":{},\"682\":{}},\"comment\":{}}],[\"force\",{\"_index\":474,\"name\":{\"906\":{},\"915\":{},\"919\":{},\"1057\":{}},\"comment\":{}}],[\"foreach\",{\"_index\":344,\"name\":{\"667\":{},\"680\":{}},\"comment\":{}}],[\"format\",{\"_index\":59,\"name\":{\"175\":{}},\"comment\":{}}],[\"foxx\",{\"_index\":675,\"name\":{\"1263\":{}},\"comment\":{}}],[\"foxxmanifest\",{\"_index\":676,\"name\":{\"1264\":{}},\"comment\":{}}],[\"from\",{\"_index\":445,\"name\":{\"848\":{},\"1328\":{},\"1333\":{}},\"comment\":{}}],[\"fromprefix\",{\"_index\":185,\"name\":{\"392\":{}},\"comment\":{}}],[\"fullcount\",{\"_index\":334,\"name\":{\"655\":{},\"716\":{}},\"comment\":{}}],[\"fulltext\",{\"_index\":269,\"name\":{\"522\":{},\"546\":{}},\"comment\":{}}],[\"fulltextindex\",{\"_index\":763,\"name\":{\"1506\":{}},\"comment\":{}}],[\"fulltitle\",{\"_index\":499,\"name\":{\"979\":{},\"1005\":{}},\"comment\":{}}],[\"genericanalyzerdescription\",{\"_index\":60,\"name\":{\"176\":{}},\"comment\":{}}],[\"genericindex\",{\"_index\":760,\"name\":{\"1498\":{}},\"comment\":{}}],[\"genericviewdescription\",{\"_index\":811,\"name\":{\"1617\":{}},\"comment\":{}}],[\"geoindex\",{\"_index\":764,\"name\":{\"1507\":{}},\"comment\":{}}],[\"geojsonanalyzerdescription\",{\"_index\":79,\"name\":{\"197\":{}},\"comment\":{}}],[\"geopointanalyzerdescription\",{\"_index\":80,\"name\":{\"198\":{}},\"comment\":{}}],[\"geos2analyzerdescription\",{\"_index\":81,\"name\":{\"199\":{}},\"comment\":{}}],[\"get\",{\"_index\":83,\"name\":{\"203\":{},\"486\":{},\"552\":{},\"1127\":{},\"1390\":{},\"1539\":{},\"1559\":{},\"1639\":{}},\"comment\":{}}],[\"getavg\",{\"_index\":522,\"name\":{\"1052\":{}},\"comment\":{}}],[\"getclusterimbalance\",{\"_index\":567,\"name\":{\"1122\":{}},\"comment\":{}}],[\"getcompleted\",{\"_index\":775,\"name\":{\"1533\":{}},\"comment\":{}}],[\"getlatest\",{\"_index\":520,\"name\":{\"1048\":{}},\"comment\":{}}],[\"getlogentries\",{\"_index\":643,\"name\":{\"1206\":{}},\"comment\":{}}],[\"getloglevel\",{\"_index\":645,\"name\":{\"1208\":{}},\"comment\":{}}],[\"getlogmessages\",{\"_index\":644,\"name\":{\"1207\":{}},\"comment\":{}}],[\"getresponsibleshard\",{\"_index\":245,\"name\":{\"498\":{},\"564\":{}},\"comment\":{}}],[\"getservice\",{\"_index\":624,\"name\":{\"1187\":{}},\"comment\":{}}],[\"getserviceconfiguration\",{\"_index\":625,\"name\":{\"1188\":{}},\"comment\":{}}],[\"getservicedependencies\",{\"_index\":628,\"name\":{\"1191\":{}},\"comment\":{}}],[\"getservicedocumentation\",{\"_index\":636,\"name\":{\"1199\":{}},\"comment\":{}}],[\"getservicereadme\",{\"_index\":635,\"name\":{\"1198\":{}},\"comment\":{}}],[\"getuser\",{\"_index\":594,\"name\":{\"1155\":{}},\"comment\":{}}],[\"getuseraccesslevel\",{\"_index\":599,\"name\":{\"1160\":{}},\"comment\":{}}],[\"getuserdatabases\",{\"_index\":602,\"name\":{\"1163\":{}},\"comment\":{}}],[\"getvalues\",{\"_index\":521,\"name\":{\"1050\":{}},\"comment\":{}}],[\"globallyuniqueid\",{\"_index\":126,\"name\":{\"255\":{},\"1619\":{}},\"comment\":{}}],[\"graceful\",{\"_index\":170,\"name\":{\"347\":{},\"1307\":{}},\"comment\":{}}],[\"graph\",{\"_index\":581,\"name\":{\"1141\":{},\"1302\":{},\"1370\":{},\"1380\":{},\"1387\":{}},\"comment\":{}}],[\"graphcollectioninsertoptions\",{\"_index\":693,\"name\":{\"1309\":{}},\"comment\":{}}],[\"graphcollectionreadoptions\",{\"_index\":691,\"name\":{\"1304\":{}},\"comment\":{}}],[\"graphcollectionremoveoptions\",{\"_index\":695,\"name\":{\"1320\":{}},\"comment\":{}}],[\"graphcollectionreplaceoptions\",{\"_index\":694,\"name\":{\"1313\":{}},\"comment\":{}}],[\"graphedgecollection\",{\"_index\":710,\"name\":{\"1377\":{}},\"comment\":{}}],[\"graphinfo\",{\"_index\":698,\"name\":{\"1335\":{}},\"comment\":{}}],[\"graphs\",{\"_index\":584,\"name\":{\"1144\":{}},\"comment\":{}}],[\"graphvertexcollection\",{\"_index\":707,\"name\":{\"1367\":{}},\"comment\":{}}],[\"gzip\",{\"_index\":689,\"name\":{\"1300\":{}},\"comment\":{}}],[\"hasmore\",{\"_index\":340,\"name\":{\"662\":{}},\"comment\":{}}],[\"hasnext\",{\"_index\":341,\"name\":{\"663\":{},\"677\":{}},\"comment\":{}}],[\"head\",{\"_index\":778,\"name\":{\"1540\":{}},\"comment\":{}}],[\"headers\",{\"_index\":280,\"name\":{\"580\":{},\"617\":{},\"634\":{}},\"comment\":{}}],[\"hex\",{\"_index\":38,\"name\":{\"97\":{}},\"comment\":{}}],[\"hidden\",{\"_index\":403,\"name\":{\"782\":{}},\"comment\":{}}],[\"hotbackuplist\",{\"_index\":532,\"name\":{\"1068\":{}},\"comment\":{}}],[\"hotbackupoptions\",{\"_index\":523,\"name\":{\"1054\":{}},\"comment\":{}}],[\"hotbackupresult\",{\"_index\":526,\"name\":{\"1060\":{}},\"comment\":{}}],[\"httperror\",{\"_index\":674,\"name\":{\"1255\":{}},\"comment\":{}}],[\"httprequests\",{\"_index\":335,\"name\":{\"656\":{}},\"comment\":{}}],[\"id\",{\"_index\":380,\"name\":{\"737\":{},\"806\":{},\"873\":{},\"1062\":{},\"1092\":{},\"1501\":{},\"1521\":{},\"1554\":{},\"1557\":{},\"1620\":{}},\"comment\":{}}],[\"identityanalyzerdescription\",{\"_index\":63,\"name\":{\"181\":{}},\"comment\":{}}],[\"ifmatch\",{\"_index\":167,\"name\":{\"343\":{},\"349\":{},\"370\":{},\"381\":{},\"388\":{}},\"comment\":{}}],[\"ifnonematch\",{\"_index\":168,\"name\":{\"344\":{},\"350\":{}},\"comment\":{}}],[\"ignored\",{\"_index\":224,\"name\":{\"461\":{},\"482\":{}},\"comment\":{}}],[\"ignorerevs\",{\"_index\":181,\"name\":{\"368\":{},\"377\":{}},\"comment\":{}}],[\"imbalance\",{\"_index\":428,\"name\":{\"825\":{},\"835\":{}},\"comment\":{}}],[\"imbalanceafter\",{\"_index\":451,\"name\":{\"856\":{}},\"comment\":{}}],[\"imbalancebefore\",{\"_index\":450,\"name\":{\"855\":{}},\"comment\":{}}],[\"import\",{\"_index\":258,\"name\":{\"511\":{},\"540\":{}},\"comment\":{}}],[\"inbackground\",{\"_index\":729,\"name\":{\"1418\":{},\"1428\":{},\"1435\":{},\"1443\":{},\"1495\":{},\"1590\":{}},\"comment\":{}}],[\"includeallfields\",{\"_index\":742,\"name\":{\"1456\":{},\"1485\":{},\"1586\":{},\"1630\":{}},\"comment\":{}}],[\"increment\",{\"_index\":130,\"name\":{\"262\":{},\"322\":{}},\"comment\":{}}],[\"index\",{\"_index\":202,\"name\":{\"433\":{},\"524\":{},\"573\":{},\"1405\":{},\"1518\":{},\"1608\":{}},\"comment\":{}}],[\"indexes\",{\"_index\":270,\"name\":{\"523\":{},\"572\":{},\"1408\":{},\"1611\":{},\"1615\":{}},\"comment\":{}}],[\"indexselector\",{\"_index\":770,\"name\":{\"1525\":{}},\"comment\":{}}],[\"inedges\",{\"_index\":275,\"name\":{\"548\":{}},\"comment\":{}}],[\"info\",{\"_index\":513,\"name\":{\"1017\":{},\"1076\":{}},\"comment\":{}}],[\"init\",{\"_index\":204,\"name\":{\"438\":{}},\"comment\":{}}],[\"installservice\",{\"_index\":620,\"name\":{\"1183\":{}},\"comment\":{}}],[\"installserviceoptions\",{\"_index\":466,\"name\":{\"891\":{}},\"comment\":{}}],[\"intermediatecommitcount\",{\"_index\":372,\"name\":{\"724\":{}},\"comment\":{}}],[\"intermediatecommitsize\",{\"_index\":373,\"name\":{\"725\":{}},\"comment\":{}}],[\"invertedindex\",{\"_index\":768,\"name\":{\"1517\":{}},\"comment\":{}}],[\"invertedindexfieldoptions\",{\"_index\":741,\"name\":{\"1451\":{}},\"comment\":{}}],[\"invertedindexnestedfield\",{\"_index\":767,\"name\":{\"1510\":{}},\"comment\":{}}],[\"invertedindexnestedfieldoptions\",{\"_index\":738,\"name\":{\"1444\":{}},\"comment\":{}}],[\"invertedindexprimarysortfieldoptions\",{\"_index\":746,\"name\":{\"1466\":{}},\"comment\":{}}],[\"invertedindexstoredvalueoptions\",{\"_index\":744,\"name\":{\"1461\":{}},\"comment\":{}}],[\"isaqlliteral\",{\"_index\":88,\"name\":{\"208\":{}},\"comment\":{}}],[\"isaqlquery\",{\"_index\":87,\"name\":{\"207\":{}},\"comment\":{}}],[\"isarangoanalyzer\",{\"_index\":1,\"name\":{\"1\":{}},\"comment\":{}}],[\"isarangocollection\",{\"_index\":97,\"name\":{\"219\":{}},\"comment\":{}}],[\"isarangodatabase\",{\"_index\":353,\"name\":{\"687\":{}},\"comment\":{}}],[\"isarangoerror\",{\"_index\":666,\"name\":{\"1238\":{}},\"comment\":{}}],[\"isarangograph\",{\"_index\":690,\"name\":{\"1303\":{}},\"comment\":{}}],[\"isarangotransaction\",{\"_index\":781,\"name\":{\"1545\":{}},\"comment\":{}}],[\"isarangoview\",{\"_index\":788,\"name\":{\"1564\":{}},\"comment\":{}}],[\"isbinary\",{\"_index\":304,\"name\":{\"614\":{}},\"comment\":{}}],[\"isdeterministic\",{\"_index\":465,\"name\":{\"890\":{}},\"comment\":{}}],[\"isdisjoint\",{\"_index\":153,\"name\":{\"289\":{},\"1346\":{},\"1356\":{}},\"comment\":{}}],[\"isleader\",{\"_index\":448,\"name\":{\"852\":{}},\"comment\":{}}],[\"isloaded\",{\"_index\":771,\"name\":{\"1528\":{}},\"comment\":{}}],[\"ismodificationquery\",{\"_index\":387,\"name\":{\"747\":{}},\"comment\":{}}],[\"issatellite\",{\"_index\":701,\"name\":{\"1343\":{}},\"comment\":{}}],[\"issmart\",{\"_index\":152,\"name\":{\"288\":{},\"1344\":{},\"1354\":{}},\"comment\":{}}],[\"issystem\",{\"_index\":161,\"name\":{\"317\":{},\"875\":{}},\"comment\":{}}],[\"issystemerror\",{\"_index\":667,\"name\":{\"1239\":{}},\"comment\":{}}],[\"itemorder\",{\"_index\":210,\"name\":{\"444\":{}},\"comment\":{}}],[\"items\",{\"_index\":338,\"name\":{\"659\":{}},\"comment\":{}}],[\"job\",{\"_index\":647,\"name\":{\"1210\":{},\"1526\":{},\"1527\":{}},\"comment\":{}}],[\"join\",{\"_index\":90,\"name\":{\"211\":{}},\"comment\":{}}],[\"keepnull\",{\"_index\":31,\"name\":{\"79\":{},\"250\":{},\"296\":{},\"379\":{},\"417\":{},\"1317\":{}},\"comment\":{}}],[\"keygenerator\",{\"_index\":110,\"name\":{\"233\":{}},\"comment\":{}}],[\"keyoptions\",{\"_index\":140,\"name\":{\"275\":{},\"327\":{}},\"comment\":{}}],[\"keywords\",{\"_index\":685,\"name\":{\"1279\":{}},\"comment\":{}}],[\"kill\",{\"_index\":348,\"name\":{\"671\":{},\"684\":{}},\"comment\":{}}],[\"killquery\",{\"_index\":615,\"name\":{\"1178\":{}},\"comment\":{}}],[\"label\",{\"_index\":525,\"name\":{\"1058\":{}},\"comment\":{}}],[\"lastvalue\",{\"_index\":132,\"name\":{\"264\":{}},\"comment\":{}}],[\"latitude\",{\"_index\":55,\"name\":{\"156\":{}},\"comment\":{}}],[\"leader\",{\"_index\":422,\"name\":{\"818\":{}},\"comment\":{}}],[\"leaderchanges\",{\"_index\":438,\"name\":{\"840\":{}},\"comment\":{}}],[\"leaderdupl\",{\"_index\":426,\"name\":{\"823\":{}},\"comment\":{}}],[\"legacy\",{\"_index\":470,\"name\":{\"896\":{},\"903\":{},\"912\":{},\"927\":{},\"935\":{}},\"comment\":{}}],[\"level\",{\"_index\":135,\"name\":{\"269\":{},\"301\":{},\"1084\":{},\"1094\":{},\"1102\":{}},\"comment\":{}}],[\"lib\",{\"_index\":680,\"name\":{\"1272\":{}},\"comment\":{}}],[\"license\",{\"_index\":462,\"name\":{\"882\":{},\"1022\":{},\"1280\":{}},\"comment\":{}}],[\"lid\",{\"_index\":550,\"name\":{\"1100\":{}},\"comment\":{}}],[\"limit\",{\"_index\":193,\"name\":{\"405\":{},\"411\":{},\"419\":{},\"424\":{},\"434\":{}},\"comment\":{}}],[\"links\",{\"_index\":802,\"name\":{\"1598\":{}},\"comment\":{}}],[\"list\",{\"_index\":259,\"name\":{\"512\":{},\"567\":{},\"1071\":{}},\"comment\":{}}],[\"listanalyzers\",{\"_index\":591,\"name\":{\"1152\":{}},\"comment\":{}}],[\"listcollections\",{\"_index\":580,\"name\":{\"1139\":{}},\"comment\":{}}],[\"listcompletedjobs\",{\"_index\":649,\"name\":{\"1212\":{}},\"comment\":{}}],[\"listdatabases\",{\"_index\":572,\"name\":{\"1130\":{}},\"comment\":{}}],[\"listedgecollections\",{\"_index\":717,\"name\":{\"1399\":{}},\"comment\":{}}],[\"listfunctions\",{\"_index\":616,\"name\":{\"1179\":{}},\"comment\":{}}],[\"listgraphs\",{\"_index\":583,\"name\":{\"1143\":{}},\"comment\":{}}],[\"listhotbackups\",{\"_index\":640,\"name\":{\"1203\":{}},\"comment\":{}}],[\"listpendingjobs\",{\"_index\":648,\"name\":{\"1211\":{}},\"comment\":{}}],[\"listrunningqueries\",{\"_index\":612,\"name\":{\"1175\":{}},\"comment\":{}}],[\"listservices\",{\"_index\":619,\"name\":{\"1182\":{}},\"comment\":{}}],[\"listservicescripts\",{\"_index\":632,\"name\":{\"1195\":{}},\"comment\":{}}],[\"listslowqueries\",{\"_index\":613,\"name\":{\"1176\":{}},\"comment\":{}}],[\"listtransactions\",{\"_index\":607,\"name\":{\"1168\":{}},\"comment\":{}}],[\"listuserdatabases\",{\"_index\":573,\"name\":{\"1131\":{}},\"comment\":{}}],[\"listusers\",{\"_index\":593,\"name\":{\"1154\":{}},\"comment\":{}}],[\"listvertexcollections\",{\"_index\":713,\"name\":{\"1394\":{}},\"comment\":{}}],[\"listviews\",{\"_index\":588,\"name\":{\"1148\":{}},\"comment\":{}}],[\"literal\",{\"_index\":89,\"name\":{\"210\":{}},\"comment\":{}}],[\"load\",{\"_index\":772,\"name\":{\"1530\":{}},\"comment\":{}}],[\"loadall\",{\"_index\":342,\"name\":{\"664\":{}},\"comment\":{}}],[\"loadbalancingstrategy\",{\"_index\":279,\"name\":{\"579\":{},\"629\":{}},\"comment\":{}}],[\"loaded\",{\"_index\":106,\"name\":{\"229\":{}},\"comment\":{}}],[\"loadindexes\",{\"_index\":242,\"name\":{\"494\":{},\"560\":{}},\"comment\":{}}],[\"loading\",{\"_index\":109,\"name\":{\"232\":{}},\"comment\":{}}],[\"locale\",{\"_index\":13,\"name\":{\"27\":{},\"34\":{},\"52\":{},\"104\":{}},\"comment\":{}}],[\"locktimeout\",{\"_index\":360,\"name\":{\"698\":{}},\"comment\":{}}],[\"logentries\",{\"_index\":548,\"name\":{\"1097\":{}},\"comment\":{}}],[\"logentriesoptions\",{\"_index\":540,\"name\":{\"1081\":{}},\"comment\":{}}],[\"login\",{\"_index\":565,\"name\":{\"1120\":{}},\"comment\":{}}],[\"loglevel\",{\"_index\":533,\"name\":{\"1072\":{}},\"comment\":{}}],[\"loglevellabel\",{\"_index\":537,\"name\":{\"1078\":{}},\"comment\":{}}],[\"loglevelsetting\",{\"_index\":538,\"name\":{\"1079\":{}},\"comment\":{}}],[\"logmessage\",{\"_index\":545,\"name\":{\"1090\":{}},\"comment\":{}}],[\"logsortdirection\",{\"_index\":539,\"name\":{\"1080\":{}},\"comment\":{}}],[\"longitude\",{\"_index\":56,\"name\":{\"157\":{}},\"comment\":{}}],[\"lookupbykeys\",{\"_index\":267,\"name\":{\"520\":{},\"545\":{}},\"comment\":{}}],[\"main\",{\"_index\":681,\"name\":{\"1273\":{}},\"comment\":{}}],[\"manifest\",{\"_index\":481,\"name\":{\"936\":{},\"1263\":{}},\"comment\":{}}],[\"map\",{\"_index\":345,\"name\":{\"668\":{},\"681\":{}},\"comment\":{}}],[\"max\",{\"_index\":18,\"name\":{\"43\":{},\"61\":{}},\"comment\":{}}],[\"maxcells\",{\"_index\":51,\"name\":{\"147\":{},\"172\":{}},\"comment\":{}}],[\"maxdepth\",{\"_index\":217,\"name\":{\"452\":{}},\"comment\":{}}],[\"maximumnumberofmoves\",{\"_index\":437,\"name\":{\"839\":{}},\"comment\":{}}],[\"maxiterations\",{\"_index\":218,\"name\":{\"453\":{}},\"comment\":{}}],[\"maxlevel\",{\"_index\":53,\"name\":{\"149\":{},\"162\":{},\"174\":{}},\"comment\":{}}],[\"maxnodespercallstack\",{\"_index\":371,\"name\":{\"722\":{}},\"comment\":{}}],[\"maxnumberofplans\",{\"_index\":377,\"name\":{\"733\":{}},\"comment\":{}}],[\"maxplans\",{\"_index\":370,\"name\":{\"721\":{}},\"comment\":{}}],[\"maxquerystringlength\",{\"_index\":411,\"name\":{\"791\":{},\"799\":{}},\"comment\":{}}],[\"maxretries\",{\"_index\":315,\"name\":{\"630\":{}},\"comment\":{}}],[\"maxruntime\",{\"_index\":365,\"name\":{\"710\":{}},\"comment\":{}}],[\"maxslowqueries\",{\"_index\":412,\"name\":{\"792\":{},\"800\":{}},\"comment\":{}}],[\"maxsockets\",{\"_index\":291,\"name\":{\"596\":{}},\"comment\":{}}],[\"maxtransactionsize\",{\"_index\":361,\"name\":{\"699\":{},\"723\":{}},\"comment\":{}}],[\"maxwarningscount\",{\"_index\":366,\"name\":{\"715\":{}},\"comment\":{}}],[\"mdiindex\",{\"_index\":766,\"name\":{\"1509\":{}},\"comment\":{}}],[\"memorylimit\",{\"_index\":33,\"name\":{\"81\":{},\"709\":{}},\"comment\":{}}],[\"mergeobjects\",{\"_index\":178,\"name\":{\"361\":{},\"380\":{},\"420\":{}},\"comment\":{}}],[\"message\",{\"_index\":136,\"name\":{\"270\":{},\"302\":{},\"1096\":{}},\"comment\":{}}],[\"method\",{\"_index\":301,\"name\":{\"611\":{}},\"comment\":{}}],[\"min\",{\"_index\":19,\"name\":{\"44\":{},\"60\":{}},\"comment\":{}}],[\"mincells\",{\"_index\":57,\"name\":{\"160\":{}},\"comment\":{}}],[\"mindepth\",{\"_index\":216,\"name\":{\"451\":{}},\"comment\":{}}],[\"minhashanalyzerdescription\",{\"_index\":75,\"name\":{\"193\":{}},\"comment\":{}}],[\"minlength\",{\"_index\":733,\"name\":{\"1427\":{}},\"comment\":{}}],[\"minlevel\",{\"_index\":52,\"name\":{\"148\":{},\"161\":{},\"173\":{}},\"comment\":{}}],[\"minscore\",{\"_index\":795,\"name\":{\"1577\":{}},\"comment\":{}}],[\"model_location\",{\"_index\":43,\"name\":{\"119\":{},\"128\":{}},\"comment\":{}}],[\"mount\",{\"_index\":478,\"name\":{\"922\":{},\"930\":{}},\"comment\":{}}],[\"movefollowers\",{\"_index\":440,\"name\":{\"842\":{}},\"comment\":{}}],[\"moveleaders\",{\"_index\":439,\"name\":{\"841\":{}},\"comment\":{}}],[\"moves\",{\"_index\":452,\"name\":{\"857\":{}},\"comment\":{}}],[\"multidelimiteranalyzerdescription\",{\"_index\":65,\"name\":{\"183\":{}},\"comment\":{}}],[\"multiexplainresult\",{\"_index\":394,\"name\":{\"761\":{}},\"comment\":{}}],[\"multiple\",{\"_index\":490,\"name\":{\"953\":{},\"962\":{},\"1296\":{}},\"comment\":{}}],[\"multiservicedependency\",{\"_index\":491,\"name\":{\"960\":{}},\"comment\":{}}],[\"name\",{\"_index\":61,\"name\":{\"178\":{},\"201\":{},\"222\":{},\"246\":{},\"254\":{},\"292\":{},\"528\":{},\"577\":{},\"779\":{},\"872\":{},\"888\":{},\"923\":{},\"932\":{},\"956\":{},\"965\":{},\"1107\":{},\"1245\":{},\"1256\":{},\"1281\":{},\"1292\":{},\"1337\":{},\"1368\":{},\"1378\":{},\"1388\":{},\"1413\":{},\"1426\":{},\"1433\":{},\"1441\":{},\"1446\":{},\"1453\":{},\"1474\":{},\"1500\":{},\"1512\":{},\"1524\":{},\"1621\":{},\"1638\":{}},\"comment\":{}}],[\"nearestneighborsanalyzerdescription\",{\"_index\":77,\"name\":{\"195\":{}},\"comment\":{}}],[\"nested\",{\"_index\":740,\"name\":{\"1450\":{},\"1459\":{},\"1516\":{},\"1587\":{},\"1631\":{}},\"comment\":{}}],[\"newborn\",{\"_index\":104,\"name\":{\"227\":{}},\"comment\":{}}],[\"next\",{\"_index\":343,\"name\":{\"666\":{},\"679\":{}},\"comment\":{}}],[\"ngramanalyzerdescription\",{\"_index\":68,\"name\":{\"186\":{}},\"comment\":{}}],[\"ngramsize\",{\"_index\":48,\"name\":{\"136\":{}},\"comment\":{}}],[\"nodes\",{\"_index\":336,\"name\":{\"657\":{},\"741\":{}},\"comment\":{}}],[\"normanalyzerdescription\",{\"_index\":67,\"name\":{\"185\":{}},\"comment\":{}}],[\"nrdbservers\",{\"_index\":530,\"name\":{\"1066\":{}},\"comment\":{}}],[\"nrfiles\",{\"_index\":531,\"name\":{\"1067\":{}},\"comment\":{}}],[\"numberofshards\",{\"_index\":143,\"name\":{\"278\":{},\"331\":{},\"1340\":{},\"1351\":{}},\"comment\":{}}],[\"numbershards\",{\"_index\":425,\"name\":{\"822\":{},\"831\":{}},\"comment\":{}}],[\"numhashes\",{\"_index\":41,\"name\":{\"112\":{}},\"comment\":{}}],[\"objectwithid\",{\"_index\":663,\"name\":{\"1230\":{},\"1519\":{}},\"comment\":{}}],[\"objectwithkey\",{\"_index\":664,\"name\":{\"1233\":{}},\"comment\":{}}],[\"objectwithname\",{\"_index\":769,\"name\":{\"1522\":{}},\"comment\":{}}],[\"offset\",{\"_index\":131,\"name\":{\"263\":{},\"323\":{},\"1087\":{}},\"comment\":{}}],[\"old\",{\"_index\":235,\"name\":{\"483\":{}},\"comment\":{}}],[\"onduplicate\",{\"_index\":187,\"name\":{\"396\":{}},\"comment\":{}}],[\"optimizer\",{\"_index\":368,\"name\":{\"718\":{},\"730\":{}},\"comment\":{}}],[\"optimizetopk\",{\"_index\":759,\"name\":{\"1497\":{}},\"comment\":{}}],[\"options\",{\"_index\":50,\"name\":{\"145\":{},\"158\":{},\"170\":{},\"938\":{}},\"comment\":{}}],[\"order\",{\"_index\":212,\"name\":{\"446\":{}},\"comment\":{}}],[\"orphancollections\",{\"_index\":700,\"name\":{\"1339\":{},\"1350\":{}},\"comment\":{}}],[\"outedges\",{\"_index\":276,\"name\":{\"549\":{}},\"comment\":{}}],[\"overwrite\",{\"_index\":122,\"name\":{\"248\":{},\"294\":{},\"394\":{}},\"comment\":{}}],[\"overwritemode\",{\"_index\":177,\"name\":{\"360\":{}},\"comment\":{}}],[\"parallelism\",{\"_index\":751,\"name\":{\"1487\":{}},\"comment\":{}}],[\"params\",{\"_index\":281,\"name\":{\"581\":{}},\"comment\":{}}],[\"parse\",{\"_index\":610,\"name\":{\"1172\":{}},\"comment\":{}}],[\"parsed\",{\"_index\":399,\"name\":{\"773\":{}},\"comment\":{}}],[\"parseresult\",{\"_index\":398,\"name\":{\"771\":{}},\"comment\":{}}],[\"passes\",{\"_index\":494,\"name\":{\"972\":{},\"1014\":{}},\"comment\":{}}],[\"passwd\",{\"_index\":454,\"name\":{\"861\":{},\"1034\":{},\"1039\":{}},\"comment\":{}}],[\"password\",{\"_index\":287,\"name\":{\"590\":{}},\"comment\":{}}],[\"patch\",{\"_index\":662,\"name\":{\"1229\":{},\"1541\":{}},\"comment\":{}}],[\"path\",{\"_index\":307,\"name\":{\"620\":{},\"874\":{},\"931\":{},\"1023\":{},\"1299\":{}},\"comment\":{}}],[\"peakmemoryusage\",{\"_index\":332,\"name\":{\"653\":{},\"753\":{},\"813\":{}},\"comment\":{}}],[\"pending\",{\"_index\":496,\"name\":{\"974\":{},\"1012\":{}},\"comment\":{}}],[\"persistentindex\",{\"_index\":761,\"name\":{\"1504\":{}},\"comment\":{}}],[\"pifactor\",{\"_index\":442,\"name\":{\"844\":{}},\"comment\":{}}],[\"pipeline\",{\"_index\":36,\"name\":{\"89\":{}},\"comment\":{}}],[\"pipelineanalyzerdescription\",{\"_index\":72,\"name\":{\"190\":{}},\"comment\":{}}],[\"plan\",{\"_index\":322,\"name\":{\"640\":{},\"757\":{}},\"comment\":{}}],[\"plans\",{\"_index\":395,\"name\":{\"763\":{}},\"comment\":{}}],[\"planscreated\",{\"_index\":391,\"name\":{\"752\":{}},\"comment\":{}}],[\"post\",{\"_index\":779,\"name\":{\"1542\":{}},\"comment\":{}}],[\"potentiallyinconsistent\",{\"_index\":527,\"name\":{\"1063\":{}},\"comment\":{}}],[\"precapturestacktraces\",{\"_index\":317,\"name\":{\"635\":{}},\"comment\":{}}],[\"preserveoriginal\",{\"_index\":20,\"name\":{\"45\":{},\"62\":{}},\"comment\":{}}],[\"primaryindex\",{\"_index\":762,\"name\":{\"1505\":{}},\"comment\":{}}],[\"primarykeycache\",{\"_index\":750,\"name\":{\"1482\":{}},\"comment\":{}}],[\"primarysort\",{\"_index\":749,\"name\":{\"1477\":{}},\"comment\":{}}],[\"profile\",{\"_index\":323,\"name\":{\"641\":{},\"713\":{}},\"comment\":{}}],[\"properties\",{\"_index\":8,\"name\":{\"8\":{},\"13\":{},\"18\":{},\"25\":{},\"32\":{},\"41\":{},\"50\":{},\"67\":{},\"75\":{},\"87\":{},\"94\":{},\"102\":{},\"109\":{},\"117\":{},\"126\":{},\"134\":{},\"142\":{},\"154\":{},\"167\":{},\"488\":{},\"554\":{},\"1643\":{}},\"comment\":{}}],[\"provides\",{\"_index\":479,\"name\":{\"925\":{},\"1269\":{}},\"comment\":{}}],[\"put\",{\"_index\":780,\"name\":{\"1543\":{}},\"comment\":{}}],[\"qs\",{\"_index\":308,\"name\":{\"621\":{}},\"comment\":{}}],[\"query\",{\"_index\":92,\"name\":{\"213\":{},\"809\":{},\"1170\":{}},\"comment\":{}}],[\"queryinfo\",{\"_index\":417,\"name\":{\"804\":{}},\"comment\":{}}],[\"queryoptimizerrule\",{\"_index\":401,\"name\":{\"777\":{}},\"comment\":{}}],[\"queryoptions\",{\"_index\":362,\"name\":{\"700\":{}},\"comment\":{}}],[\"queryrules\",{\"_index\":611,\"name\":{\"1173\":{}},\"comment\":{}}],[\"querystring\",{\"_index\":29,\"name\":{\"77\":{}},\"comment\":{}}],[\"querytracking\",{\"_index\":409,\"name\":{\"788\":{},\"1174\":{}},\"comment\":{}}],[\"querytrackingoptions\",{\"_index\":416,\"name\":{\"796\":{}},\"comment\":{}}],[\"queuetime\",{\"_index\":561,\"name\":{\"1116\":{}},\"comment\":{}}],[\"queuetimemetrics\",{\"_index\":519,\"name\":{\"1046\":{}},\"comment\":{}}],[\"read\",{\"_index\":357,\"name\":{\"692\":{}},\"comment\":{}}],[\"rebalancecluster\",{\"_index\":570,\"name\":{\"1125\":{}},\"comment\":{}}],[\"recalculatecount\",{\"_index\":238,\"name\":{\"490\":{},\"556\":{}},\"comment\":{}}],[\"reduce\",{\"_index\":347,\"name\":{\"670\":{},\"683\":{}},\"comment\":{}}],[\"refillindexcaches\",{\"_index\":179,\"name\":{\"362\":{},\"371\":{},\"382\":{},\"389\":{}},\"comment\":{}}],[\"remove\",{\"_index\":256,\"name\":{\"509\":{},\"538\":{},\"1376\":{},\"1386\":{}},\"comment\":{}}],[\"removeall\",{\"_index\":257,\"name\":{\"510\":{},\"539\":{}},\"comment\":{}}],[\"removebyexample\",{\"_index\":264,\"name\":{\"517\":{},\"568\":{}},\"comment\":{}}],[\"removebykeys\",{\"_index\":268,\"name\":{\"521\":{},\"571\":{}},\"comment\":{}}],[\"removed\",{\"_index\":234,\"name\":{\"481\":{}},\"comment\":{}}],[\"removeedgedefinition\",{\"_index\":721,\"name\":{\"1403\":{}},\"comment\":{}}],[\"removeuser\",{\"_index\":598,\"name\":{\"1159\":{}},\"comment\":{}}],[\"removevertexcollection\",{\"_index\":716,\"name\":{\"1397\":{}},\"comment\":{}}],[\"rename\",{\"_index\":243,\"name\":{\"495\":{},\"561\":{},\"1642\":{}},\"comment\":{}}],[\"renamecollection\",{\"_index\":579,\"name\":{\"1138\":{}},\"comment\":{}}],[\"renameview\",{\"_index\":587,\"name\":{\"1147\":{}},\"comment\":{}}],[\"renewauthtoken\",{\"_index\":566,\"name\":{\"1121\":{}},\"comment\":{}}],[\"replace\",{\"_index\":252,\"name\":{\"505\":{},\"534\":{},\"1374\":{},\"1384\":{}},\"comment\":{}}],[\"replaceall\",{\"_index\":253,\"name\":{\"506\":{},\"535\":{}},\"comment\":{}}],[\"replacebyexample\",{\"_index\":265,\"name\":{\"518\":{},\"569\":{}},\"comment\":{}}],[\"replaced\",{\"_index\":231,\"name\":{\"475\":{}},\"comment\":{}}],[\"replaceedgedefinition\",{\"_index\":720,\"name\":{\"1402\":{}},\"comment\":{}}],[\"replaceedgedefinitionoptions\",{\"_index\":706,\"name\":{\"1364\":{}},\"comment\":{}}],[\"replaceproperties\",{\"_index\":820,\"name\":{\"1645\":{}},\"comment\":{}}],[\"replaceservice\",{\"_index\":621,\"name\":{\"1184\":{}},\"comment\":{}}],[\"replaceserviceconfiguration\",{\"_index\":626,\"name\":{\"1189\":{}},\"comment\":{}}],[\"replaceservicedependencies\",{\"_index\":629,\"name\":{\"1192\":{}},\"comment\":{}}],[\"replaceserviceoptions\",{\"_index\":472,\"name\":{\"898\":{}},\"comment\":{}}],[\"replaceuser\",{\"_index\":597,\"name\":{\"1158\":{}},\"comment\":{}}],[\"replicationfactor\",{\"_index\":145,\"name\":{\"280\":{},\"306\":{},\"333\":{},\"868\":{},\"877\":{},\"1341\":{},\"1352\":{}},\"comment\":{}}],[\"request\",{\"_index\":776,\"name\":{\"1537\":{}},\"comment\":{}}],[\"requestinterceptors\",{\"_index\":297,\"name\":{\"603\":{}},\"comment\":{}}],[\"requestoptions\",{\"_index\":300,\"name\":{\"609\":{}},\"comment\":{}}],[\"required\",{\"_index\":487,\"name\":{\"949\":{},\"959\":{},\"968\":{},\"1289\":{},\"1295\":{}},\"comment\":{}}],[\"response\",{\"_index\":672,\"name\":{\"1248\":{},\"1257\":{}},\"comment\":{}}],[\"responsequeuetimesamples\",{\"_index\":318,\"name\":{\"636\":{}},\"comment\":{}}],[\"restorehotbackup\",{\"_index\":641,\"name\":{\"1204\":{}},\"comment\":{}}],[\"result\",{\"_index\":503,\"name\":{\"985\":{},\"1529\":{}},\"comment\":{}}],[\"retryonconflict\",{\"_index\":305,\"name\":{\"616\":{},\"631\":{},\"705\":{}},\"comment\":{}}],[\"returnnew\",{\"_index\":175,\"name\":{\"358\":{},\"367\":{},\"376\":{},\"1312\":{},\"1319\":{}},\"comment\":{}}],[\"returnold\",{\"_index\":176,\"name\":{\"359\":{},\"369\":{},\"378\":{},\"386\":{},\"428\":{},\"1318\":{},\"1324\":{}},\"comment\":{}}],[\"returntype\",{\"_index\":34,\"name\":{\"82\":{}},\"comment\":{}}],[\"rev\",{\"_index\":692,\"name\":{\"1306\":{},\"1315\":{},\"1322\":{}},\"comment\":{}}],[\"revision\",{\"_index\":240,\"name\":{\"492\":{},\"558\":{}},\"comment\":{}}],[\"route\",{\"_index\":555,\"name\":{\"1110\":{},\"1534\":{},\"1535\":{},\"1536\":{}},\"comment\":{}}],[\"rule\",{\"_index\":134,\"name\":{\"268\":{},\"300\":{}},\"comment\":{}}],[\"rules\",{\"_index\":369,\"name\":{\"720\":{},\"732\":{},\"742\":{}},\"comment\":{}}],[\"rulesexecuted\",{\"_index\":389,\"name\":{\"750\":{}},\"comment\":{}}],[\"rulesskipped\",{\"_index\":390,\"name\":{\"751\":{}},\"comment\":{}}],[\"runservicescript\",{\"_index\":633,\"name\":{\"1196\":{}},\"comment\":{}}],[\"runservicetests\",{\"_index\":634,\"name\":{\"1197\":{}},\"comment\":{}}],[\"runtime\",{\"_index\":420,\"name\":{\"812\":{}},\"comment\":{}}],[\"satellites\",{\"_index\":703,\"name\":{\"1357\":{},\"1360\":{},\"1363\":{},\"1366\":{}},\"comment\":{}}],[\"satellitesyncwait\",{\"_index\":375,\"name\":{\"727\":{}},\"comment\":{}}],[\"save\",{\"_index\":250,\"name\":{\"503\":{},\"532\":{},\"1373\":{},\"1383\":{}},\"comment\":{}}],[\"saveall\",{\"_index\":251,\"name\":{\"504\":{},\"533\":{}},\"comment\":{}}],[\"scannedfull\",{\"_index\":331,\"name\":{\"650\":{}},\"comment\":{}}],[\"scannedindex\",{\"_index\":227,\"name\":{\"468\":{},\"651\":{}},\"comment\":{}}],[\"schema\",{\"_index\":141,\"name\":{\"276\":{},\"308\":{},\"328\":{}},\"comment\":{}}],[\"schemaoptions\",{\"_index\":155,\"name\":{\"298\":{}},\"comment\":{}}],[\"schemaproperties\",{\"_index\":133,\"name\":{\"265\":{}},\"comment\":{}}],[\"scripts\",{\"_index\":682,\"name\":{\"1274\":{}},\"comment\":{}}],[\"search\",{\"_index\":544,\"name\":{\"1088\":{}},\"comment\":{}}],[\"searchaliasviewdescription\",{\"_index\":814,\"name\":{\"1624\":{}},\"comment\":{}}],[\"searchaliasviewindexoptions\",{\"_index\":806,\"name\":{\"1605\":{}},\"comment\":{}}],[\"searchaliasviewpatchindexoptions\",{\"_index\":808,\"name\":{\"1612\":{}},\"comment\":{}}],[\"searchaliasviewpatchpropertiesoptions\",{\"_index\":809,\"name\":{\"1613\":{}},\"comment\":{}}],[\"searchaliasviewproperties\",{\"_index\":818,\"name\":{\"1636\":{}},\"comment\":{}}],[\"searchaliasviewpropertiesoptions\",{\"_index\":807,\"name\":{\"1609\":{}},\"comment\":{}}],[\"searchfield\",{\"_index\":739,\"name\":{\"1449\":{},\"1457\":{},\"1475\":{},\"1515\":{}},\"comment\":{}}],[\"segmentationanalyzerdescription\",{\"_index\":70,\"name\":{\"188\":{}},\"comment\":{}}],[\"segmentsbytesfloor\",{\"_index\":791,\"name\":{\"1573\":{}},\"comment\":{}}],[\"segmentsbytesmax\",{\"_index\":792,\"name\":{\"1574\":{}},\"comment\":{}}],[\"segmentsmax\",{\"_index\":793,\"name\":{\"1575\":{}},\"comment\":{}}],[\"segmentsmin\",{\"_index\":794,\"name\":{\"1576\":{}},\"comment\":{}}],[\"server\",{\"_index\":461,\"name\":{\"881\":{},\"1070\":{}},\"comment\":{}}],[\"serviceconfiguration\",{\"_index\":482,\"name\":{\"942\":{}},\"comment\":{}}],[\"serviceinfo\",{\"_index\":480,\"name\":{\"928\":{}},\"comment\":{}}],[\"servicesummary\",{\"_index\":477,\"name\":{\"920\":{}},\"comment\":{}}],[\"servicetestdefaultreport\",{\"_index\":511,\"name\":{\"1008\":{}},\"comment\":{}}],[\"servicetestdefaulttest\",{\"_index\":510,\"name\":{\"1002\":{}},\"comment\":{}}],[\"serviceteststats\",{\"_index\":492,\"name\":{\"969\":{}},\"comment\":{}}],[\"serviceteststreamreport\",{\"_index\":501,\"name\":{\"982\":{}},\"comment\":{}}],[\"serviceteststreamtest\",{\"_index\":498,\"name\":{\"976\":{}},\"comment\":{}}],[\"servicetestsuite\",{\"_index\":504,\"name\":{\"989\":{}},\"comment\":{}}],[\"servicetestsuitereport\",{\"_index\":506,\"name\":{\"994\":{}},\"comment\":{}}],[\"servicetestsuitetest\",{\"_index\":502,\"name\":{\"983\":{}},\"comment\":{}}],[\"servicetesttapreport\",{\"_index\":509,\"name\":{\"1001\":{}},\"comment\":{}}],[\"servicetestxunitreport\",{\"_index\":508,\"name\":{\"1000\":{}},\"comment\":{}}],[\"servicetestxunittest\",{\"_index\":507,\"name\":{\"999\":{}},\"comment\":{}}],[\"setloglevel\",{\"_index\":646,\"name\":{\"1209\":{}},\"comment\":{}}],[\"setresponsequeuetimesamples\",{\"_index\":562,\"name\":{\"1117\":{}},\"comment\":{}}],[\"setservicedevelopmentmode\",{\"_index\":631,\"name\":{\"1194\":{}},\"comment\":{}}],[\"setup\",{\"_index\":471,\"name\":{\"897\":{},\"904\":{},\"913\":{}},\"comment\":{}}],[\"setuseraccesslevel\",{\"_index\":600,\"name\":{\"1161\":{}},\"comment\":{}}],[\"shard\",{\"_index\":447,\"name\":{\"850\":{}},\"comment\":{}}],[\"sharding\",{\"_index\":458,\"name\":{\"867\":{},\"876\":{}},\"comment\":{}}],[\"shardingstrategy\",{\"_index\":111,\"name\":{\"234\":{},\"281\":{},\"335\":{}},\"comment\":{}}],[\"shardkeys\",{\"_index\":144,\"name\":{\"279\":{},\"332\":{}},\"comment\":{}}],[\"shards\",{\"_index\":430,\"name\":{\"827\":{}},\"comment\":{}}],[\"shutdown\",{\"_index\":559,\"name\":{\"1114\":{}},\"comment\":{}}],[\"silent\",{\"_index\":174,\"name\":{\"357\":{},\"366\":{},\"375\":{},\"387\":{},\"429\":{}},\"comment\":{}}],[\"simplequeryalloptions\",{\"_index\":195,\"name\":{\"408\":{}},\"comment\":{}}],[\"simplequerybyexampleoptions\",{\"_index\":191,\"name\":{\"402\":{}},\"comment\":{}}],[\"simplequeryfulltextoptions\",{\"_index\":201,\"name\":{\"431\":{}},\"comment\":{}}],[\"simplequerylisttype\",{\"_index\":112,\"name\":{\"235\":{}},\"comment\":{}}],[\"simplequeryremovebyexampleoptions\",{\"_index\":198,\"name\":{\"421\":{}},\"comment\":{}}],[\"simplequeryremovebyexampleresult\",{\"_index\":229,\"name\":{\"470\":{}},\"comment\":{}}],[\"simplequeryremovebykeysoptions\",{\"_index\":200,\"name\":{\"426\":{}},\"comment\":{}}],[\"simplequeryremovebykeysresult\",{\"_index\":233,\"name\":{\"479\":{}},\"comment\":{}}],[\"simplequeryreplacebyexampleoptions\",{\"_index\":199,\"name\":{\"425\":{}},\"comment\":{}}],[\"simplequeryreplacebyexampleresult\",{\"_index\":230,\"name\":{\"473\":{}},\"comment\":{}}],[\"simplequeryupdatebyexampleoptions\",{\"_index\":197,\"name\":{\"415\":{}},\"comment\":{}}],[\"simplequeryupdatebyexampleresult\",{\"_index\":232,\"name\":{\"476\":{}},\"comment\":{}}],[\"singleexplainresult\",{\"_index\":392,\"name\":{\"755\":{}},\"comment\":{}}],[\"singleservicedependency\",{\"_index\":489,\"name\":{\"951\":{}},\"comment\":{}}],[\"size\",{\"_index\":543,\"name\":{\"1086\":{}},\"comment\":{}}],[\"sizeinbytes\",{\"_index\":528,\"name\":{\"1064\":{}},\"comment\":{}}],[\"sizeused\",{\"_index\":431,\"name\":{\"829\":{}},\"comment\":{}}],[\"skip\",{\"_index\":192,\"name\":{\"404\":{},\"410\":{},\"435\":{}},\"comment\":{}}],[\"skipinaccessiblecollections\",{\"_index\":374,\"name\":{\"726\":{}},\"comment\":{}}],[\"slowquerythreshold\",{\"_index\":413,\"name\":{\"793\":{},\"801\":{}},\"comment\":{}}],[\"smartgraphattribute\",{\"_index\":148,\"name\":{\"284\":{},\"338\":{},\"1345\":{},\"1355\":{}},\"comment\":{}}],[\"smartjoinattribute\",{\"_index\":147,\"name\":{\"283\":{},\"337\":{}},\"comment\":{}}],[\"sort\",{\"_index\":206,\"name\":{\"440\":{},\"1089\":{}},\"comment\":{}}],[\"sparse\",{\"_index\":726,\"name\":{\"1415\":{},\"1502\":{}},\"comment\":{}}],[\"start\",{\"_index\":542,\"name\":{\"1085\":{}},\"comment\":{}}],[\"started\",{\"_index\":419,\"name\":{\"811\":{}},\"comment\":{}}],[\"state\",{\"_index\":381,\"name\":{\"738\":{},\"814\":{}},\"comment\":{}}],[\"stats\",{\"_index\":226,\"name\":{\"466\":{},\"642\":{},\"760\":{},\"766\":{},\"996\":{},\"1010\":{}},\"comment\":{}}],[\"status\",{\"_index\":127,\"name\":{\"256\":{},\"1555\":{}},\"comment\":{}}],[\"statusstring\",{\"_index\":138,\"name\":{\"273\":{}},\"comment\":{}}],[\"stemanalyzerdescription\",{\"_index\":66,\"name\":{\"184\":{}},\"comment\":{}}],[\"stemming\",{\"_index\":24,\"name\":{\"57\":{}},\"comment\":{}}],[\"step\",{\"_index\":787,\"name\":{\"1562\":{}},\"comment\":{}}],[\"stopwords\",{\"_index\":22,\"name\":{\"54\":{},\"96\":{}},\"comment\":{}}],[\"stopwordsanalyzerdescription\",{\"_index\":73,\"name\":{\"191\":{}},\"comment\":{}}],[\"stopwordspath\",{\"_index\":23,\"name\":{\"55\":{}},\"comment\":{}}],[\"storedvalues\",{\"_index\":730,\"name\":{\"1420\":{},\"1476\":{}},\"comment\":{}}],[\"storevalues\",{\"_index\":800,\"name\":{\"1589\":{},\"1633\":{}},\"comment\":{}}],[\"strategy\",{\"_index\":211,\"name\":{\"445\":{}},\"comment\":{}}],[\"stream\",{\"_index\":196,\"name\":{\"414\":{},\"714\":{},\"815\":{}},\"comment\":{}}],[\"subnodes\",{\"_index\":397,\"name\":{\"770\":{}},\"comment\":{}}],[\"suites\",{\"_index\":505,\"name\":{\"992\":{},\"997\":{}},\"comment\":{}}],[\"swaggerjson\",{\"_index\":512,\"name\":{\"1015\":{}},\"comment\":{}}],[\"syncbyrevision\",{\"_index\":151,\"name\":{\"287\":{}},\"comment\":{}}],[\"syscall\",{\"_index\":670,\"name\":{\"1243\":{}},\"comment\":{}}],[\"systemerror\",{\"_index\":668,\"name\":{\"1240\":{}},\"comment\":{}}],[\"targetsize\",{\"_index\":432,\"name\":{\"830\":{}},\"comment\":{}}],[\"targetweight\",{\"_index\":424,\"name\":{\"821\":{}},\"comment\":{}}],[\"teardown\",{\"_index\":473,\"name\":{\"905\":{},\"914\":{},\"918\":{}},\"comment\":{}}],[\"tests\",{\"_index\":493,\"name\":{\"971\":{},\"993\":{},\"998\":{},\"1011\":{},\"1275\":{}},\"comment\":{}}],[\"text\",{\"_index\":552,\"name\":{\"1104\":{}},\"comment\":{}}],[\"textanalyzerdescription\",{\"_index\":69,\"name\":{\"187\":{}},\"comment\":{}}],[\"threshold\",{\"_index\":45,\"name\":{\"121\":{},\"1569\":{}},\"comment\":{}}],[\"thumbnail\",{\"_index\":686,\"name\":{\"1282\":{}},\"comment\":{}}],[\"tierconsolidationpolicy\",{\"_index\":790,\"name\":{\"1570\":{}},\"comment\":{}}],[\"time\",{\"_index\":554,\"name\":{\"1109\":{}},\"comment\":{}}],[\"timeout\",{\"_index\":292,\"name\":{\"597\":{},\"618\":{},\"704\":{},\"1059\":{}},\"comment\":{}}],[\"timestamp\",{\"_index\":551,\"name\":{\"1103\":{}},\"comment\":{}}],[\"title\",{\"_index\":485,\"name\":{\"947\":{},\"955\":{},\"964\":{},\"978\":{},\"986\":{},\"991\":{},\"1004\":{},\"1019\":{}},\"comment\":{}}],[\"to\",{\"_index\":446,\"name\":{\"849\":{},\"1329\":{},\"1334\":{}},\"comment\":{}}],[\"tojson\",{\"_index\":673,\"name\":{\"1249\":{},\"1259\":{}},\"comment\":{}}],[\"token\",{\"_index\":289,\"name\":{\"593\":{}},\"comment\":{}}],[\"top_k\",{\"_index\":44,\"name\":{\"120\":{},\"129\":{}},\"comment\":{}}],[\"topic\",{\"_index\":546,\"name\":{\"1093\":{},\"1101\":{}},\"comment\":{}}],[\"toprefix\",{\"_index\":186,\"name\":{\"393\":{}},\"comment\":{}}],[\"totalamount\",{\"_index\":549,\"name\":{\"1099\":{}},\"comment\":{}}],[\"totalshards\",{\"_index\":429,\"name\":{\"826\":{},\"833\":{}},\"comment\":{}}],[\"totalshardsfromsystemcollections\",{\"_index\":434,\"name\":{\"834\":{}},\"comment\":{}}],[\"totalused\",{\"_index\":433,\"name\":{\"832\":{}},\"comment\":{}}],[\"totalweight\",{\"_index\":427,\"name\":{\"824\":{}},\"comment\":{}}],[\"trackbindvars\",{\"_index\":414,\"name\":{\"794\":{},\"802\":{}},\"comment\":{}}],[\"tracklistpositions\",{\"_index\":743,\"name\":{\"1458\":{},\"1486\":{},\"1588\":{},\"1632\":{}},\"comment\":{}}],[\"trackslowqueries\",{\"_index\":415,\"name\":{\"795\":{},\"803\":{}},\"comment\":{}}],[\"transaction\",{\"_index\":604,\"name\":{\"1165\":{},\"1544\":{},\"1556\":{}},\"comment\":{}}],[\"transactionabortoptions\",{\"_index\":783,\"name\":{\"1549\":{}},\"comment\":{}}],[\"transactioncollections\",{\"_index\":354,\"name\":{\"688\":{}},\"comment\":{}}],[\"transactioncommitoptions\",{\"_index\":782,\"name\":{\"1546\":{}},\"comment\":{}}],[\"transactiondetails\",{\"_index\":379,\"name\":{\"735\":{}},\"comment\":{}}],[\"transactionoptions\",{\"_index\":358,\"name\":{\"693\":{}},\"comment\":{}}],[\"transactions\",{\"_index\":608,\"name\":{\"1169\":{}},\"comment\":{}}],[\"transactionstatus\",{\"_index\":784,\"name\":{\"1552\":{}},\"comment\":{}}],[\"traversal\",{\"_index\":277,\"name\":{\"550\":{},\"1404\":{}},\"comment\":{}}],[\"traversaloptions\",{\"_index\":203,\"name\":{\"436\":{}},\"comment\":{}}],[\"truncate\",{\"_index\":244,\"name\":{\"496\":{},\"562\":{}},\"comment\":{}}],[\"ttl\",{\"_index\":194,\"name\":{\"407\":{},\"413\":{},\"711\":{}},\"comment\":{}}],[\"ttlindex\",{\"_index\":765,\"name\":{\"1508\":{}},\"comment\":{}}],[\"type\",{\"_index\":6,\"name\":{\"6\":{},\"11\":{},\"16\":{},\"23\":{},\"30\":{},\"39\":{},\"48\":{},\"65\":{},\"73\":{},\"85\":{},\"92\":{},\"100\":{},\"107\":{},\"115\":{},\"124\":{},\"132\":{},\"140\":{},\"144\":{},\"152\":{},\"165\":{},\"169\":{},\"215\":{},\"257\":{},\"260\":{},\"267\":{},\"320\":{},\"769\":{},\"944\":{},\"1287\":{},\"1301\":{},\"1411\":{},\"1424\":{},\"1431\":{},\"1438\":{},\"1472\":{},\"1568\":{},\"1572\":{}},\"comment\":{}}],[\"uninstallservice\",{\"_index\":623,\"name\":{\"1186\":{}},\"comment\":{}}],[\"uninstallserviceoptions\",{\"_index\":476,\"name\":{\"916\":{}},\"comment\":{}}],[\"unique\",{\"_index\":725,\"name\":{\"1414\":{},\"1442\":{},\"1503\":{}},\"comment\":{}}],[\"uniqueness\",{\"_index\":213,\"name\":{\"447\":{}},\"comment\":{}}],[\"unloaded\",{\"_index\":105,\"name\":{\"228\":{}},\"comment\":{}}],[\"unloading\",{\"_index\":107,\"name\":{\"230\":{}},\"comment\":{}}],[\"update\",{\"_index\":254,\"name\":{\"507\":{},\"536\":{},\"1375\":{},\"1385\":{}},\"comment\":{}}],[\"updateall\",{\"_index\":255,\"name\":{\"508\":{},\"537\":{}},\"comment\":{}}],[\"updatebyexample\",{\"_index\":266,\"name\":{\"519\":{},\"570\":{}},\"comment\":{}}],[\"updated\",{\"_index\":223,\"name\":{\"460\":{},\"478\":{}},\"comment\":{}}],[\"updateproperties\",{\"_index\":819,\"name\":{\"1644\":{}},\"comment\":{}}],[\"updateserviceconfiguration\",{\"_index\":627,\"name\":{\"1190\":{}},\"comment\":{}}],[\"updateservicedependencies\",{\"_index\":630,\"name\":{\"1193\":{}},\"comment\":{}}],[\"updateuser\",{\"_index\":596,\"name\":{\"1157\":{}},\"comment\":{}}],[\"upgradeservice\",{\"_index\":622,\"name\":{\"1185\":{}},\"comment\":{}}],[\"upgradeserviceoptions\",{\"_index\":475,\"name\":{\"907\":{}},\"comment\":{}}],[\"upto\",{\"_index\":541,\"name\":{\"1083\":{}},\"comment\":{}}],[\"url\",{\"_index\":312,\"name\":{\"626\":{}},\"comment\":{}}],[\"usebasicauth\",{\"_index\":563,\"name\":{\"1118\":{}},\"comment\":{}}],[\"usebearerauth\",{\"_index\":564,\"name\":{\"1119\":{}},\"comment\":{}}],[\"user\",{\"_index\":418,\"name\":{\"808\":{},\"1028\":{},\"1033\":{}},\"comment\":{}}],[\"useraccessleveloptions\",{\"_index\":518,\"name\":{\"1042\":{}},\"comment\":{}}],[\"userdatabases\",{\"_index\":575,\"name\":{\"1133\":{}},\"comment\":{}}],[\"username\",{\"_index\":286,\"name\":{\"589\":{},\"860\":{}},\"comment\":{}}],[\"useroptions\",{\"_index\":517,\"name\":{\"1037\":{}},\"comment\":{}}],[\"users\",{\"_index\":457,\"name\":{\"866\":{}},\"comment\":{}}],[\"usexdr\",{\"_index\":295,\"name\":{\"601\":{}},\"comment\":{}}],[\"validationlevel\",{\"_index\":113,\"name\":{\"236\":{}},\"comment\":{}}],[\"variables\",{\"_index\":384,\"name\":{\"744\":{}},\"comment\":{}}],[\"version\",{\"_index\":463,\"name\":{\"883\":{},\"924\":{},\"933\":{},\"957\":{},\"966\":{},\"1021\":{},\"1108\":{},\"1283\":{},\"1293\":{}},\"comment\":{}}],[\"versioninfo\",{\"_index\":460,\"name\":{\"879\":{}},\"comment\":{}}],[\"vertex\",{\"_index\":709,\"name\":{\"1372\":{}},\"comment\":{}}],[\"vertexcollection\",{\"_index\":712,\"name\":{\"1393\":{}},\"comment\":{}}],[\"vertexcollections\",{\"_index\":714,\"name\":{\"1395\":{}},\"comment\":{}}],[\"vertexexists\",{\"_index\":708,\"name\":{\"1371\":{}},\"comment\":{}}],[\"vertices\",{\"_index\":214,\"name\":{\"449\":{}},\"comment\":{}}],[\"view\",{\"_index\":585,\"name\":{\"1145\":{},\"1563\":{},\"1637\":{}},\"comment\":{}}],[\"viewdescription\",{\"_index\":812,\"name\":{\"1622\":{}},\"comment\":{}}],[\"viewpatchpropertiesoptions\",{\"_index\":798,\"name\":{\"1581\":{}},\"comment\":{}}],[\"viewproperties\",{\"_index\":815,\"name\":{\"1625\":{}},\"comment\":{}}],[\"viewpropertiesoptions\",{\"_index\":797,\"name\":{\"1580\":{}},\"comment\":{}}],[\"views\",{\"_index\":589,\"name\":{\"1149\":{}},\"comment\":{}}],[\"visitor\",{\"_index\":207,\"name\":{\"441\":{}},\"comment\":{}}],[\"waitforpropagation\",{\"_index\":560,\"name\":{\"1115\":{}},\"comment\":{}}],[\"waitforsync\",{\"_index\":139,\"name\":{\"274\":{},\"305\":{},\"326\":{},\"356\":{},\"365\":{},\"374\":{},\"385\":{},\"395\":{},\"418\":{},\"423\":{},\"430\":{},\"697\":{},\"1311\":{},\"1316\":{},\"1323\":{},\"1349\":{}},\"comment\":{}}],[\"waitforsyncreplication\",{\"_index\":164,\"name\":{\"329\":{}},\"comment\":{}}],[\"warning\",{\"_index\":535,\"name\":{\"1075\":{}},\"comment\":{}}],[\"warnings\",{\"_index\":321,\"name\":{\"639\":{},\"759\":{},\"765\":{}},\"comment\":{}}],[\"weightused\",{\"_index\":423,\"name\":{\"820\":{}},\"comment\":{}}],[\"wildcardanalyzerdescription\",{\"_index\":78,\"name\":{\"196\":{}},\"comment\":{}}],[\"withcredentials\",{\"_index\":296,\"name\":{\"602\":{}},\"comment\":{}}],[\"withdata\",{\"_index\":159,\"name\":{\"314\":{}},\"comment\":{}}],[\"withrevisions\",{\"_index\":158,\"name\":{\"313\":{}},\"comment\":{}}],[\"withtransaction\",{\"_index\":606,\"name\":{\"1167\":{}},\"comment\":{}}],[\"write\",{\"_index\":356,\"name\":{\"691\":{}},\"comment\":{}}],[\"writebufferactive\",{\"_index\":757,\"name\":{\"1493\":{}},\"comment\":{}}],[\"writebufferidle\",{\"_index\":756,\"name\":{\"1492\":{}},\"comment\":{}}],[\"writebuffersizemax\",{\"_index\":758,\"name\":{\"1494\":{}},\"comment\":{}}],[\"writeconcern\",{\"_index\":142,\"name\":{\"277\":{},\"307\":{},\"334\":{},\"869\":{},\"878\":{},\"1342\":{},\"1353\":{}},\"comment\":{}}],[\"writeoperation\",{\"_index\":114,\"name\":{\"237\":{}},\"comment\":{}}],[\"writesexecuted\",{\"_index\":329,\"name\":{\"648\":{}},\"comment\":{}}],[\"writesignored\",{\"_index\":330,\"name\":{\"649\":{}},\"comment\":{}}],[\"xhr\",{\"_index\":294,\"name\":{\"600\":{}},\"comment\":{}}],[\"xhroptions\",{\"_index\":290,\"name\":{\"594\":{}},\"comment\":{}}]],\"pipeline\":[]}}"); \ No newline at end of file diff --git a/8.8.0/assets/style.css b/8.8.0/assets/style.css new file mode 100644 index 000000000..496e66f21 --- /dev/null +++ b/8.8.0/assets/style.css @@ -0,0 +1,1279 @@ +:root { + /* Light */ + --light-color-background: #f2f4f8; + --light-color-background-secondary: #eff0f1; + --light-color-warning-text: #222; + --light-color-background-warning: #e6e600; + --light-color-icon-background: var(--light-color-background); + --light-color-accent: #c5c7c9; + --light-color-text: #222; + --light-color-text-aside: #707070; + --light-color-link: #4da6ff; + --light-color-ts: #db1373; + --light-color-ts-interface: #139d2c; + --light-color-ts-enum: #9c891a; + --light-color-ts-class: #2484e5; + --light-color-ts-function: #572be7; + --light-color-ts-namespace: #b111c9; + --light-color-ts-private: #707070; + --light-color-ts-variable: #4d68ff; + --light-external-icon: url("data:image/svg+xml;utf8,"); + --light-color-scheme: light; + + /* Dark */ + --dark-color-background: #2b2e33; + --dark-color-background-secondary: #1e2024; + --dark-color-background-warning: #bebe00; + --dark-color-warning-text: #222; + --dark-color-icon-background: var(--dark-color-background-secondary); + --dark-color-accent: #9096a2; + --dark-color-text: #f5f5f5; + --dark-color-text-aside: #dddddd; + --dark-color-link: #00aff4; + --dark-color-ts: #ff6492; + --dark-color-ts-interface: #6cff87; + --dark-color-ts-enum: #f4d93e; + --dark-color-ts-class: #61b0ff; + --dark-color-ts-function: #9772ff; + --dark-color-ts-namespace: #e14dff; + --dark-color-ts-private: #e2e2e2; + --dark-color-ts-variable: #4d68ff; + --dark-external-icon: url("data:image/svg+xml;utf8,"); + --dark-color-scheme: dark; +} + +@media (prefers-color-scheme: light) { + :root { + --color-background: var(--light-color-background); + --color-background-secondary: var(--light-color-background-secondary); + --color-background-warning: var(--light-color-background-warning); + --color-warning-text: var(--light-color-warning-text); + --color-icon-background: var(--light-color-icon-background); + --color-accent: var(--light-color-accent); + --color-text: var(--light-color-text); + --color-text-aside: var(--light-color-text-aside); + --color-link: var(--light-color-link); + --color-ts: var(--light-color-ts); + --color-ts-interface: var(--light-color-ts-interface); + --color-ts-enum: var(--light-color-ts-enum); + --color-ts-class: var(--light-color-ts-class); + --color-ts-function: var(--light-color-ts-function); + --color-ts-namespace: var(--light-color-ts-namespace); + --color-ts-private: var(--light-color-ts-private); + --color-ts-variable: var(--light-color-ts-variable); + --external-icon: var(--light-external-icon); + --color-scheme: var(--light-color-scheme); + } +} + +@media (prefers-color-scheme: dark) { + :root { + --color-background: var(--dark-color-background); + --color-background-secondary: var(--dark-color-background-secondary); + --color-background-warning: var(--dark-color-background-warning); + --color-warning-text: var(--dark-color-warning-text); + --color-icon-background: var(--dark-color-icon-background); + --color-accent: var(--dark-color-accent); + --color-text: var(--dark-color-text); + --color-text-aside: var(--dark-color-text-aside); + --color-link: var(--dark-color-link); + --color-ts: var(--dark-color-ts); + --color-ts-interface: var(--dark-color-ts-interface); + --color-ts-enum: var(--dark-color-ts-enum); + --color-ts-class: var(--dark-color-ts-class); + --color-ts-function: var(--dark-color-ts-function); + --color-ts-namespace: var(--dark-color-ts-namespace); + --color-ts-private: var(--dark-color-ts-private); + --color-ts-variable: var(--dark-color-ts-variable); + --external-icon: var(--dark-external-icon); + --color-scheme: var(--dark-color-scheme); + } +} + +html { + color-scheme: var(--color-scheme); +} + +body { + margin: 0; +} + +:root[data-theme="light"] { + --color-background: var(--light-color-background); + --color-background-secondary: var(--light-color-background-secondary); + --color-background-warning: var(--light-color-background-warning); + --color-warning-text: var(--light-color-warning-text); + --color-icon-background: var(--light-color-icon-background); + --color-accent: var(--light-color-accent); + --color-text: var(--light-color-text); + --color-text-aside: var(--light-color-text-aside); + --color-link: var(--light-color-link); + --color-ts: var(--light-color-ts); + --color-ts-interface: var(--light-color-ts-interface); + --color-ts-enum: var(--light-color-ts-enum); + --color-ts-class: var(--light-color-ts-class); + --color-ts-function: var(--light-color-ts-function); + --color-ts-namespace: var(--light-color-ts-namespace); + --color-ts-private: var(--light-color-ts-private); + --color-ts-variable: var(--light-color-ts-variable); + --external-icon: var(--light-external-icon); + --color-scheme: var(--light-color-scheme); +} + +:root[data-theme="dark"] { + --color-background: var(--dark-color-background); + --color-background-secondary: var(--dark-color-background-secondary); + --color-background-warning: var(--dark-color-background-warning); + --color-warning-text: var(--dark-color-warning-text); + --color-icon-background: var(--dark-color-icon-background); + --color-accent: var(--dark-color-accent); + --color-text: var(--dark-color-text); + --color-text-aside: var(--dark-color-text-aside); + --color-link: var(--dark-color-link); + --color-ts: var(--dark-color-ts); + --color-ts-interface: var(--dark-color-ts-interface); + --color-ts-enum: var(--dark-color-ts-enum); + --color-ts-class: var(--dark-color-ts-class); + --color-ts-function: var(--dark-color-ts-function); + --color-ts-namespace: var(--dark-color-ts-namespace); + --color-ts-private: var(--dark-color-ts-private); + --color-ts-variable: var(--dark-color-ts-variable); + --external-icon: var(--dark-external-icon); + --color-scheme: var(--dark-color-scheme); +} + +.always-visible, +.always-visible .tsd-signatures { + display: inherit !important; +} + +h1, +h2, +h3, +h4, +h5, +h6 { + line-height: 1.2; +} + +h1 { + font-size: 1.875rem; + margin: 0.67rem 0; +} + +h2 { + font-size: 1.5rem; + margin: 0.83rem 0; +} + +h3 { + font-size: 1.25rem; + margin: 1rem 0; +} + +h4 { + font-size: 1.05rem; + margin: 1.33rem 0; +} + +h5 { + font-size: 1rem; + margin: 1.5rem 0; +} + +h6 { + font-size: 0.875rem; + margin: 2.33rem 0; +} + +.uppercase { + text-transform: uppercase; +} + +pre { + white-space: pre; + white-space: pre-wrap; + word-wrap: break-word; +} + +dl, +menu, +ol, +ul { + margin: 1em 0; +} + +dd { + margin: 0 0 0 40px; +} + +.container { + max-width: 1600px; + padding: 0 2rem; +} + +@media (min-width: 640px) { + .container { + padding: 0 4rem; + } +} +@media (min-width: 1200px) { + .container { + padding: 0 8rem; + } +} +@media (min-width: 1600px) { + .container { + padding: 0 12rem; + } +} + +/* Footer */ +.tsd-generator { + border-top: 1px solid var(--color-accent); + padding-top: 1rem; + padding-bottom: 1rem; + max-height: 3.5rem; +} + +.tsd-generator > p { + margin-top: 0; + margin-bottom: 0; + padding: 0 1rem; +} + +.container-main { + display: flex; + justify-content: space-between; + position: relative; + margin: 0 auto; +} + +.col-4, +.col-8 { + box-sizing: border-box; + float: left; + padding: 2rem 1rem; +} + +.col-4 { + flex: 0 0 25%; +} +.col-8 { + flex: 1 0; + flex-wrap: wrap; + padding-left: 0; +} + +@keyframes fade-in { + from { + opacity: 0; + } + to { + opacity: 1; + } +} +@keyframes fade-out { + from { + opacity: 1; + visibility: visible; + } + to { + opacity: 0; + } +} +@keyframes fade-in-delayed { + 0% { + opacity: 0; + } + 33% { + opacity: 0; + } + 100% { + opacity: 1; + } +} +@keyframes fade-out-delayed { + 0% { + opacity: 1; + visibility: visible; + } + 66% { + opacity: 0; + } + 100% { + opacity: 0; + } +} +@keyframes shift-to-left { + from { + transform: translate(0, 0); + } + to { + transform: translate(-25%, 0); + } +} +@keyframes unshift-to-left { + from { + transform: translate(-25%, 0); + } + to { + transform: translate(0, 0); + } +} +@keyframes pop-in-from-right { + from { + transform: translate(100%, 0); + } + to { + transform: translate(0, 0); + } +} +@keyframes pop-out-to-right { + from { + transform: translate(0, 0); + visibility: visible; + } + to { + transform: translate(100%, 0); + } +} +body { + background: var(--color-background); + font-family: "Segoe UI", sans-serif; + font-size: 16px; + color: var(--color-text); +} + +a { + color: var(--color-link); + text-decoration: none; +} +a:hover { + text-decoration: underline; +} +a.external[target="_blank"] { + background-image: var(--external-icon); + background-position: top 3px right; + background-repeat: no-repeat; + padding-right: 13px; +} + +code, +pre { + font-family: Menlo, Monaco, Consolas, "Courier New", monospace; + padding: 0.2em; + margin: 0; + font-size: 0.875rem; + border-radius: 0.8em; +} + +pre { + padding: 10px; + border: 0.1em solid var(--color-accent); +} +pre code { + padding: 0; + font-size: 100%; +} + +blockquote { + margin: 1em 0; + padding-left: 1em; + border-left: 4px solid gray; +} + +.tsd-typography { + line-height: 1.333em; +} +.tsd-typography ul { + list-style: square; + padding: 0 0 0 20px; + margin: 0; +} +.tsd-typography h4, +.tsd-typography .tsd-index-panel h3, +.tsd-index-panel .tsd-typography h3, +.tsd-typography h5, +.tsd-typography h6 { + font-size: 1em; + margin: 0; +} +.tsd-typography h5, +.tsd-typography h6 { + font-weight: normal; +} +.tsd-typography p, +.tsd-typography ul, +.tsd-typography ol { + margin: 1em 0; +} + +@media (max-width: 1024px) { + html .col-content { + float: none; + max-width: 100%; + width: 100%; + padding-top: 3rem; + } + html .col-menu { + position: fixed !important; + overflow-y: auto; + -webkit-overflow-scrolling: touch; + z-index: 1024; + top: 0 !important; + bottom: 0 !important; + left: auto !important; + right: 0 !important; + padding: 1.5rem 1.5rem 0 0; + max-width: 25rem; + visibility: hidden; + background-color: var(--color-background); + transform: translate(100%, 0); + } + html .col-menu > *:last-child { + padding-bottom: 20px; + } + html .overlay { + content: ""; + display: block; + position: fixed; + z-index: 1023; + top: 0; + left: 0; + right: 0; + bottom: 0; + background-color: rgba(0, 0, 0, 0.75); + visibility: hidden; + } + + .to-has-menu .overlay { + animation: fade-in 0.4s; + } + + .to-has-menu :is(header, footer, .col-content) { + animation: shift-to-left 0.4s; + } + + .to-has-menu .col-menu { + animation: pop-in-from-right 0.4s; + } + + .from-has-menu .overlay { + animation: fade-out 0.4s; + } + + .from-has-menu :is(header, footer, .col-content) { + animation: unshift-to-left 0.4s; + } + + .from-has-menu .col-menu { + animation: pop-out-to-right 0.4s; + } + + .has-menu body { + overflow: hidden; + } + .has-menu .overlay { + visibility: visible; + } + .has-menu :is(header, footer, .col-content) { + transform: translate(-25%, 0); + } + .has-menu .col-menu { + visibility: visible; + transform: translate(0, 0); + display: flex; + flex-direction: column; + gap: 1.5rem; + max-height: 100vh; + padding: 1rem 2rem; + } + .has-menu .tsd-navigation { + max-height: 100%; + } +} + +.tsd-breadcrumb { + margin: 0; + padding: 0; + color: var(--color-text-aside); +} +.tsd-breadcrumb a { + color: var(--color-text-aside); + text-decoration: none; +} +.tsd-breadcrumb a:hover { + text-decoration: underline; +} +.tsd-breadcrumb li { + display: inline; +} +.tsd-breadcrumb li:after { + content: " / "; +} + +.tsd-comment-tags { + display: flex; + flex-direction: column; +} +dl.tsd-comment-tag-group { + display: flex; + align-items: center; + overflow: hidden; + margin: 0.5em 0; +} +dl.tsd-comment-tag-group dt { + display: flex; + margin-right: 0.5em; + font-size: 0.875em; + font-weight: normal; +} +dl.tsd-comment-tag-group dd { + margin: 0; +} +code.tsd-tag { + padding: 0.25em 0.4em; + border: 0.1em solid var(--color-accent); + margin-right: 0.25em; + font-size: 70%; +} +h1 code.tsd-tag:first-of-type { + margin-left: 0.25em; +} + +dl.tsd-comment-tag-group dd:before, +dl.tsd-comment-tag-group dd:after { + content: " "; +} +dl.tsd-comment-tag-group dd pre, +dl.tsd-comment-tag-group dd:after { + clear: both; +} +dl.tsd-comment-tag-group p { + margin: 0; +} + +.tsd-panel.tsd-comment .lead { + font-size: 1.1em; + line-height: 1.333em; + margin-bottom: 2em; +} +.tsd-panel.tsd-comment .lead:last-child { + margin-bottom: 0; +} + +.tsd-filter-visibility h4 { + font-size: 1rem; + padding-top: 0.75rem; + padding-bottom: 0.5rem; + margin: 0; +} +.tsd-filter-item:not(:last-child) { + margin-bottom: 0.5rem; +} +.tsd-filter-input { + display: flex; + width: fit-content; + width: -moz-fit-content; + align-items: center; + user-select: none; + -webkit-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + cursor: pointer; +} +.tsd-filter-input input[type="checkbox"] { + cursor: pointer; + position: absolute; + width: 1.5em; + height: 1.5em; + opacity: 0; +} +.tsd-filter-input input[type="checkbox"]:disabled { + pointer-events: none; +} +.tsd-filter-input svg { + cursor: pointer; + width: 1.5em; + height: 1.5em; + margin-right: 0.5em; + border-radius: 0.33em; + /* Leaving this at full opacity breaks event listeners on Firefox. + Don't remove unless you know what you're doing. */ + opacity: 0.99; +} +.tsd-filter-input input[type="checkbox"]:focus + svg { + transform: scale(0.95); +} +.tsd-filter-input input[type="checkbox"]:focus:not(:focus-visible) + svg { + transform: scale(1); +} +.tsd-checkbox-background { + fill: var(--color-accent); +} +input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark { + stroke: var(--color-text); +} +.tsd-filter-input input:disabled ~ svg > .tsd-checkbox-background { + fill: var(--color-background); + stroke: var(--color-accent); + stroke-width: 0.25rem; +} +.tsd-filter-input input:disabled ~ svg > .tsd-checkbox-checkmark { + stroke: var(--color-accent); +} + +.tsd-theme-toggle { + padding-top: 0.75rem; +} +.tsd-theme-toggle > h4 { + display: inline; + vertical-align: middle; + margin-right: 0.75rem; +} + +.tsd-hierarchy { + list-style: square; + margin: 0; +} +.tsd-hierarchy .target { + font-weight: bold; +} + +.tsd-panel-group.tsd-index-group { + margin-bottom: 0; +} +.tsd-index-panel .tsd-index-list { + list-style: none; + line-height: 1.333em; + margin: 0; + padding: 0.25rem 0 0 0; + overflow: hidden; + display: grid; + grid-template-columns: repeat(3, 1fr); + column-gap: 1rem; + grid-template-rows: auto; +} +@media (max-width: 1024px) { + .tsd-index-panel .tsd-index-list { + grid-template-columns: repeat(2, 1fr); + } +} +@media (max-width: 768px) { + .tsd-index-panel .tsd-index-list { + grid-template-columns: repeat(1, 1fr); + } +} +.tsd-index-panel .tsd-index-list li { + -webkit-page-break-inside: avoid; + -moz-page-break-inside: avoid; + -ms-page-break-inside: avoid; + -o-page-break-inside: avoid; + page-break-inside: avoid; +} +.tsd-index-panel a, +.tsd-index-panel a.tsd-parent-kind-module { + color: var(--color-ts); +} +.tsd-index-panel a.tsd-parent-kind-interface { + color: var(--color-ts-interface); +} +.tsd-index-panel a.tsd-parent-kind-enum { + color: var(--color-ts-enum); +} +.tsd-index-panel a.tsd-parent-kind-class { + color: var(--color-ts-class); +} +.tsd-index-panel a.tsd-kind-module { + color: var(--color-ts-namespace); +} +.tsd-index-panel a.tsd-kind-interface { + color: var(--color-ts-interface); +} +.tsd-index-panel a.tsd-kind-enum { + color: var(--color-ts-enum); +} +.tsd-index-panel a.tsd-kind-class { + color: var(--color-ts-class); +} +.tsd-index-panel a.tsd-kind-function { + color: var(--color-ts-function); +} +.tsd-index-panel a.tsd-kind-namespace { + color: var(--color-ts-namespace); +} +.tsd-index-panel a.tsd-kind-variable { + color: var(--color-ts-variable); +} +.tsd-index-panel a.tsd-is-private { + color: var(--color-ts-private); +} + +.tsd-flag { + display: inline-block; + padding: 0.25em 0.4em; + border-radius: 4px; + color: var(--color-comment-tag-text); + background-color: var(--color-comment-tag); + text-indent: 0; + font-size: 75%; + line-height: 1; + font-weight: normal; +} + +.tsd-anchor { + position: absolute; + top: -100px; +} + +.tsd-member { + position: relative; +} +.tsd-member .tsd-anchor + h3 { + display: flex; + align-items: center; + margin-top: 0; + margin-bottom: 0; + border-bottom: none; +} +.tsd-member [data-tsd-kind] { + color: var(--color-ts); +} +.tsd-member [data-tsd-kind="Interface"] { + color: var(--color-ts-interface); +} +.tsd-member [data-tsd-kind="Enum"] { + color: var(--color-ts-enum); +} +.tsd-member [data-tsd-kind="Class"] { + color: var(--color-ts-class); +} +.tsd-member [data-tsd-kind="Private"] { + color: var(--color-ts-private); +} + +.tsd-navigation a { + display: block; + margin: 0.4rem 0; + border-left: 2px solid transparent; + color: var(--color-text); + text-decoration: none; + transition: border-left-color 0.1s; +} +.tsd-navigation a:hover { + text-decoration: underline; +} +.tsd-navigation ul { + margin: 0; + padding: 0; + list-style: none; +} +.tsd-navigation li { + padding: 0; +} + +.tsd-navigation.primary .tsd-accordion-details > ul { + margin-top: 0.75rem; +} +.tsd-navigation.primary a { + padding: 0.75rem 0.5rem; + margin: 0; +} +.tsd-navigation.primary ul li a { + margin-left: 0.5rem; +} +.tsd-navigation.primary ul li li a { + margin-left: 1.5rem; +} +.tsd-navigation.primary ul li li li a { + margin-left: 2.5rem; +} +.tsd-navigation.primary ul li li li li a { + margin-left: 3.5rem; +} +.tsd-navigation.primary ul li li li li li a { + margin-left: 4.5rem; +} +.tsd-navigation.primary ul li li li li li li a { + margin-left: 5.5rem; +} +.tsd-navigation.primary li.current > a { + border-left: 0.15rem var(--color-text) solid; +} +.tsd-navigation.primary li.selected > a { + font-weight: bold; + border-left: 0.2rem var(--color-text) solid; +} +.tsd-navigation.primary ul li a:hover { + border-left: 0.2rem var(--color-text-aside) solid; +} +.tsd-navigation.primary li.globals + li > span, +.tsd-navigation.primary li.globals + li > a { + padding-top: 20px; +} + +.tsd-navigation.secondary.tsd-navigation--toolbar-hide { + max-height: calc(100vh - 1rem); + top: 0.5rem; +} +.tsd-navigation.secondary > ul { + display: inline; + padding-right: 0.5rem; + transition: opacity 0.2s; +} +.tsd-navigation.secondary ul li a { + padding-left: 0; +} +.tsd-navigation.secondary ul li li a { + padding-left: 1.1rem; +} +.tsd-navigation.secondary ul li li li a { + padding-left: 2.2rem; +} +.tsd-navigation.secondary ul li li li li a { + padding-left: 3.3rem; +} +.tsd-navigation.secondary ul li li li li li a { + padding-left: 4.4rem; +} +.tsd-navigation.secondary ul li li li li li li a { + padding-left: 5.5rem; +} + +#tsd-sidebar-links a { + margin-top: 0; + margin-bottom: 0.5rem; + line-height: 1.25rem; +} +#tsd-sidebar-links a:last-of-type { + margin-bottom: 0; +} + +a.tsd-index-link { + margin: 0.25rem 0; + font-size: 1rem; + line-height: 1.25rem; + display: inline-flex; + align-items: center; +} +.tsd-accordion-summary > h1, +.tsd-accordion-summary > h2, +.tsd-accordion-summary > h3, +.tsd-accordion-summary > h4, +.tsd-accordion-summary > h5 { + display: inline-flex; + align-items: center; + vertical-align: middle; + margin-bottom: 0; + user-select: none; + -moz-user-select: none; + -webkit-user-select: none; + -ms-user-select: none; +} +.tsd-accordion-summary { + display: block; + cursor: pointer; +} +.tsd-accordion-summary > * { + margin-top: 0; + margin-bottom: 0; + padding-top: 0; + padding-bottom: 0; +} +.tsd-accordion-summary::-webkit-details-marker { + display: none; +} +.tsd-index-accordion .tsd-accordion-summary svg { + margin-right: 0.25rem; +} +.tsd-index-content > :not(:first-child) { + margin-top: 0.75rem; +} +.tsd-index-heading { + margin-top: 1.5rem; + margin-bottom: 0.75rem; +} + +.tsd-kind-icon { + margin-right: 0.5rem; + width: 1.25rem; + height: 1.25rem; + min-width: 1.25rem; + min-height: 1.25rem; +} +.tsd-kind-icon path { + transform-origin: center; + transform: scale(1.1); +} +.tsd-signature > .tsd-kind-icon { + margin-right: 0.8rem; +} + +@media (min-width: 1025px) { + .col-content { + margin: 2rem auto; + } + + .menu-sticky-wrap { + position: sticky; + height: calc(100vh - 2rem); + top: 4rem; + right: 0; + padding: 0 1.5rem; + padding-top: 1rem; + margin-top: 3rem; + transition: 0.3s ease-in-out; + transition-property: top, padding-top, padding, height; + overflow-y: auto; + } + .col-menu { + border-left: 1px solid var(--color-accent); + } + .col-menu--hide { + top: 1rem; + } + .col-menu .tsd-navigation:not(:last-child) { + padding-bottom: 1.75rem; + } +} + +.tsd-panel { + margin-bottom: 2.5rem; +} +.tsd-panel.tsd-member { + margin-bottom: 4rem; +} +.tsd-panel:empty { + display: none; +} +.tsd-panel > h1, +.tsd-panel > h2, +.tsd-panel > h3 { + margin: 1.5rem -1.5rem 0.75rem -1.5rem; + padding: 0 1.5rem 0.75rem 1.5rem; +} +.tsd-panel > h1.tsd-before-signature, +.tsd-panel > h2.tsd-before-signature, +.tsd-panel > h3.tsd-before-signature { + margin-bottom: 0; + border-bottom: none; +} + +.tsd-panel-group { + margin: 4rem 0; +} +.tsd-panel-group.tsd-index-group { + margin: 2rem 0; +} +.tsd-panel-group.tsd-index-group details { + margin: 2rem 0; +} + +#tsd-search { + transition: background-color 0.2s; +} +#tsd-search .title { + position: relative; + z-index: 2; +} +#tsd-search .field { + position: absolute; + left: 0; + top: 0; + right: 2.5rem; + height: 100%; +} +#tsd-search .field input { + box-sizing: border-box; + position: relative; + top: -50px; + z-index: 1; + width: 100%; + padding: 0 10px; + opacity: 0; + outline: 0; + border: 0; + background: transparent; + color: var(--color-text); +} +#tsd-search .field label { + position: absolute; + overflow: hidden; + right: -40px; +} +#tsd-search .field input, +#tsd-search .title, +#tsd-toolbar-links a { + transition: opacity 0.2s; +} +#tsd-search .results { + position: absolute; + visibility: hidden; + top: 40px; + width: 100%; + margin: 0; + padding: 0; + list-style: none; + box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); +} +#tsd-search .results li { + padding: 0 10px; + background-color: var(--color-background); +} +#tsd-search .results li:nth-child(even) { + background-color: var(--color-background-secondary); +} +#tsd-search .results li.state { + display: none; +} +#tsd-search .results li.current, +#tsd-search .results li:hover { + background-color: var(--color-accent); +} +#tsd-search .results a { + display: block; +} +#tsd-search .results a:before { + top: 10px; +} +#tsd-search .results span.parent { + color: var(--color-text-aside); + font-weight: normal; +} +#tsd-search.has-focus { + background-color: var(--color-accent); +} +#tsd-search.has-focus .field input { + top: 0; + opacity: 1; +} +#tsd-search.has-focus .title, +#tsd-search.has-focus #tsd-toolbar-links a { + z-index: 0; + opacity: 0; +} +#tsd-search.has-focus .results { + visibility: visible; +} +#tsd-search.loading .results li.state.loading { + display: block; +} +#tsd-search.failure .results li.state.failure { + display: block; +} + +#tsd-toolbar-links { + position: absolute; + top: 0; + right: 2rem; + height: 100%; + display: flex; + align-items: center; + justify-content: flex-end; +} +#tsd-toolbar-links a { + margin-left: 1.5rem; +} +#tsd-toolbar-links a:hover { + text-decoration: underline; +} + +.tsd-signature { + margin: 0 0 1rem 0; + padding: 1rem 0.5rem; + border: 1px solid var(--color-accent); + font-family: Menlo, Monaco, Consolas, "Courier New", monospace; + font-size: 14px; + overflow-x: auto; +} + +.tsd-signature-symbol { + color: var(--color-text-aside); + font-weight: normal; +} + +.tsd-signature-type { + font-style: italic; + font-weight: normal; +} + +.tsd-signatures { + padding: 0; + margin: 0 0 1em 0; + list-style-type: none; +} +.tsd-signatures .tsd-signature { + margin: 0; + border-color: var(--color-accent); + border-width: 1px 0; + transition: background-color 0.1s; +} +.tsd-description .tsd-signatures .tsd-signature { + border-width: 1px; +} + +ul.tsd-parameter-list, +ul.tsd-type-parameter-list { + list-style: square; + margin: 0; + padding-left: 20px; +} +ul.tsd-parameter-list > li.tsd-parameter-signature, +ul.tsd-type-parameter-list > li.tsd-parameter-signature { + list-style: none; + margin-left: -20px; +} +ul.tsd-parameter-list h5, +ul.tsd-type-parameter-list h5 { + font-size: 16px; + margin: 1em 0 0.5em 0; +} +.tsd-sources { + margin-top: 1rem; + font-size: 0.875em; +} +.tsd-sources a { + color: var(--color-text-aside); + text-decoration: underline; +} +.tsd-sources ul { + list-style: none; + padding: 0; +} + +.tsd-page-toolbar { + position: fixed; + z-index: 1; + top: 0; + left: 0; + width: 100%; + color: var(--color-text); + background: var(--color-background-secondary); + border-bottom: 1px var(--color-accent) solid; + transition: transform 0.3s ease-in-out; +} +.tsd-page-toolbar a { + color: var(--color-text); + text-decoration: none; +} +.tsd-page-toolbar a.title { + font-weight: bold; +} +.tsd-page-toolbar a.title:hover { + text-decoration: underline; +} +.tsd-page-toolbar .tsd-toolbar-contents { + display: flex; + justify-content: space-between; + height: 2.5rem; + margin: 0 auto; +} +.tsd-page-toolbar .table-cell { + position: relative; + white-space: nowrap; + line-height: 40px; +} +.tsd-page-toolbar .table-cell:first-child { + width: 100%; +} +.tsd-page-toolbar .tsd-toolbar-icon { + box-sizing: border-box; + line-height: 0; + padding: 12px 0; +} + +.tsd-page-toolbar--hide { + transform: translateY(-100%); +} + +.tsd-widget { + display: inline-block; + overflow: hidden; + opacity: 0.8; + height: 40px; + transition: opacity 0.1s, background-color 0.2s; + vertical-align: bottom; + cursor: pointer; +} +.tsd-widget:hover { + opacity: 0.9; +} +.tsd-widget.active { + opacity: 1; + background-color: var(--color-accent); +} +.tsd-widget.no-caption { + width: 40px; +} +.tsd-widget.no-caption:before { + margin: 0; +} + +.tsd-widget.options, +.tsd-widget.menu { + display: none; +} +@media (max-width: 1024px) { + .tsd-widget.options, + .tsd-widget.menu { + display: inline-block; + } +} +input[type="checkbox"] + .tsd-widget:before { + background-position: -120px 0; +} +input[type="checkbox"]:checked + .tsd-widget:before { + background-position: -160px 0; +} + +img { + max-width: 100%; +} + +.tsd-anchor-icon { + display: inline-flex; + align-items: center; + margin-left: 0.5rem; + vertical-align: middle; + color: var(--color-text); +} + +.tsd-anchor-icon svg { + width: 1em; + height: 1em; + visibility: hidden; +} + +.tsd-anchor-link:hover > .tsd-anchor-icon svg { + visibility: visible; +} + +.deprecated { + text-decoration: line-through; +} + +.warning { + padding: 1rem; + color: var(--color-warning-text); + background: var(--color-background-warning); +} + +* { + scrollbar-width: thin; + scrollbar-color: var(--color-accent) var(--color-icon-background); +} + +*::-webkit-scrollbar { + width: 0.75rem; +} + +*::-webkit-scrollbar-track { + background: var(--color-icon-background); +} + +*::-webkit-scrollbar-thumb { + background-color: var(--color-accent); + border-radius: 999rem; + border: 0.25rem solid var(--color-icon-background); +} diff --git a/8.8.0/classes/analyzer.Analyzer.html b/8.8.0/classes/analyzer.Analyzer.html new file mode 100644 index 000000000..cc8217f12 --- /dev/null +++ b/8.8.0/classes/analyzer.Analyzer.html @@ -0,0 +1,173 @@ +Analyzer | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Class Analyzer

+
+

Represents an Analyzer in a Database.

+
+
+

Hierarchy

+
    +
  • Analyzer
+
+
+
+ +
+
+

Accessors

+
+
+

Methods

+
+
+

Accessors

+
+ +
    +
  • get name(): string
  • +
  • +

    Name of this Analyzer.

    +

    See also Database.

    +
    +

    Returns string

+
+

Methods

+
+ +
+
+ +
    + +
  • +

    Deletes the Analyzer from the database.

    + +

    Example

    const db = new Database();
    const analyzer = db.analyzer("some-analyzer");
    await analyzer.drop();
    // the Analyzer "some-analyzer" no longer exists +
    +
    +
    +

    Parameters

    +
      +
    • +
      force: boolean = false
      +

      Whether the Analyzer should still be deleted even if it +is currently in use.

      +
    +

    Returns Promise<ArangoApiResponse<{
        name: string;
    }>>

+
+ +
    + +
  • +

    Checks whether the Analyzer exists.

    + +

    Example

    const db = new Database();
    const analyzer = db.analyzer("some-analyzer");
    const result = await analyzer.exists();
    // result indicates whether the Analyzer exists +
    +
    +

    Returns Promise<boolean>

+
+ +
    + +
  • +

    Retrieves the Analyzer definition for the Analyzer.

    + +

    Example

    const db = new Database();
    const analyzer = db.analyzer("some-analyzer");
    const definition = await analyzer.get();
    // definition contains the Analyzer definition +
    +
    +

    Returns Promise<ArangoApiResponse<AnalyzerDescription>>

+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/classes/cursor.ArrayCursor.html b/8.8.0/classes/cursor.ArrayCursor.html new file mode 100644 index 000000000..d6eca4b06 --- /dev/null +++ b/8.8.0/classes/cursor.ArrayCursor.html @@ -0,0 +1,489 @@ +ArrayCursor | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Class ArrayCursor<T>

+
+

The ArrayCursor type represents a cursor returned from a +query.

+

When using TypeScript, cursors can be cast to a specific item type in order +to increase type safety.

+

See also BatchedArrayCursor.

+ +

Example

const db = new Database();
const query = aql`FOR x IN 1..5 RETURN x`;
const result = await db.query(query) as ArrayCursor<number>; +
+ +

Example

const db = new Database();
const query = aql`FOR x IN 1..10 RETURN x`;
const cursor = await db.query(query);
for await (const value of cursor) {
// Process each value asynchronously
await processValue(value);
} +
+
+
+

Type Parameters

+
    +
  • +

    T = any

    +

    Type to use for each item. Defaults to any.

    +
+
+

Hierarchy

+
    +
  • ArrayCursor
+
+
+
+ +
+
+

Accessors

+
+
+

Methods

+
+
+

Accessors

+
+ +
+
+ +
    +
  • get count(): undefined | number
  • +
  • +

    Total number of documents in the query result. Only available if the +count option was used.

    +
    +

    Returns undefined | number

+
+ +
    +
  • get extra(): CursorExtras
  • +
  • +

    Additional information about the cursor.

    +
    +

    Returns CursorExtras

+
+ +
    +
  • get hasNext(): boolean
  • +
  • +

    Whether the cursor has more values. If set to false, the cursor has +already been depleted and contains no more items.

    +
    +

    Returns boolean

+
+

Methods

+
+ +
    + +
  • +

    Enables use with for await to deplete the cursor by asynchronously +yielding every value in the cursor's remaining result set.

    +

    Note: If the result set spans multiple batches, any remaining batches +will only be fetched on demand. Depending on the cursor's TTL and the +processing speed, this may result in the server discarding the cursor +before it is fully depleted.

    + +

    Example

    const cursor = await db.query(aql`
    FOR user IN users
    FILTER user.isActive
    RETURN user
    `);
    for await (const user of cursor) {
    console.log(user.email, user.isAdmin);
    } +
    +
    +

    Returns AsyncGenerator<T, undefined, undefined>

+
+ +
    + +
  • +

    Depletes the cursor, then returns an array containing all values in the +cursor's remaining result list.

    + +

    Example

    const cursor = await db.query(aql`FOR x IN 1..5 RETURN x`);
    const result = await cursor.all(); // [1, 2, 3, 4, 5]
    console.log(cursor.hasNext); // false +
    +
    +

    Returns Promise<T[]>

+
+ +
    + +
  • +

    Depletes the cursor by applying the callback function to each item in +the cursor's remaining result list. Returns an array containing the +return values of callback for each item, flattened to a depth of 1.

    +

    Note: If the result set spans multiple batches, any remaining batches +will only be fetched on demand. Depending on the cursor's TTL and the +processing speed, this may result in the server discarding the cursor +before it is fully depleted.

    +

    See also: +Array.prototype.flatMap.

    + +

    Example

    const cursor = await db.query(aql`FOR x IN 1..5 RETURN x`);
    const squares = await cursor.flatMap((currentValue) => {
    return [currentValue, currentValue ** 2];
    });
    console.log(squares); // [1, 1, 2, 4, 3, 9, 4, 16, 5, 25]
    console.log(cursor.hasNext); // false +
    + +

    Example

    const cursor = await db.query(aql`FOR x IN 1..5 RETURN x`);
    const odds = await cursor.flatMap((currentValue) => {
    if (currentValue % 2 === 0) {
    return []; // empty array flattens into nothing
    }
    return currentValue; // or [currentValue]
    });
    console.logs(odds); // [1, 3, 5] +
    +
    +
    +

    Type Parameters

    +
      +
    • +

      R

      +

      Return type of the callback function.

      +
    +
    +

    Parameters

    +
      +
    • +
      callback: ((currentValue: T, index: number, self: ArrayCursor<T>) => R | R[])
      +

      Function to execute on each element.

      +
      +
        +
      • +
          +
        • (currentValue: T, index: number, self: ArrayCursor<T>): R | R[]
        • +
        • +
          +

          Parameters

          +
            +
          • +
            currentValue: T
          • +
          • +
            index: number
          • +
          • +
            self: ArrayCursor<T>
          +

          Returns R | R[]

    +

    Returns Promise<R[]>

+
+ +
    + +
  • +

    Advances the cursor by applying the callback function to each item in +the cursor's remaining result list until the cursor is depleted or +callback returns the exact value false. Returns a promise that +evalues to true unless the function returned false.

    +

    Note: If the result set spans multiple batches, any remaining batches +will only be fetched on demand. Depending on the cursor's TTL and the +processing speed, this may result in the server discarding the cursor +before it is fully depleted.

    +

    See also: +Array.prototype.forEach.

    + +

    Example

    const cursor = await db.query(aql`FOR x IN 1..5 RETURN x`);
    const result = await cursor.forEach((currentValue) => {
    console.log(currentValue);
    });
    console.log(result) // true
    console.log(cursor.hasNext); // false +
    + +

    Example

    const cursor = await db.query(aql`FOR x IN 1..5 RETURN x`);
    const result = await cursor.forEach((currentValue) => {
    console.log(currentValue);
    return false; // stop after the first item
    });
    console.log(result); // false
    console.log(cursor.hasNext); // true +
    +
    +
    +

    Parameters

    +
      +
    • +
      callback: ((currentValue: T, index: number, self: ArrayCursor<T>) => false | void)
      +

      Function to execute on each element.

      +
      +
        +
      • +
          +
        • (currentValue: T, index: number, self: ArrayCursor<T>): false | void
        • +
        • +
          +

          Parameters

          +
            +
          • +
            currentValue: T
          • +
          • +
            index: number
          • +
          • +
            self: ArrayCursor<T>
          +

          Returns false | void

    +

    Returns Promise<boolean>

+
+ +
    + +
  • +

    Kills the cursor and frees up associated database resources.

    +

    This method has no effect if all batches have already been fetched.

    + +

    Example

    const cursor1 = await db.query(aql`FOR x IN 1..5 RETURN x`);
    console.log(cursor1.hasMore); // false
    await cursor1.kill(); // no effect

    const cursor2 = await db.query(
    aql`FOR x IN 1..5 RETURN x`,
    { batchSize: 2 }
    );
    console.log(cursor2.hasMore); // true
    await cursor2.kill(); // cursor is depleted +
    +
    +

    Returns Promise<void>

+
+ +
    + +
  • +

    Depletes the cursor by applying the callback function to each item in +the cursor's remaining result list. Returns an array containing the +return values of callback for each item.

    +

    Note: This creates an array of all return values, which may impact +memory use when working with very large query result sets. Consider using +forEach, reduce or +flatMap instead.

    +

    See also: +Array.prototype.map.

    + +

    Example

    const cursor = await db.query(aql`FOR x IN 1..5 RETURN x`);
    const squares = await cursor.map((currentValue) => {
    return currentValue ** 2;
    });
    console.log(squares); // [1, 4, 9, 16, 25]
    console.log(cursor.hasNext); // false +
    +
    +
    +

    Type Parameters

    +
      +
    • +

      R

      +

      Return type of the callback function.

      +
    +
    +

    Parameters

    +
      +
    • +
      callback: ((currentValue: T, index: number, self: ArrayCursor<T>) => R)
      +

      Function to execute on each element.

      +
      +
        +
      • +
          +
        • (currentValue: T, index: number, self: ArrayCursor<T>): R
        • +
        • +
          +

          Parameters

          +
            +
          • +
            currentValue: T
          • +
          • +
            index: number
          • +
          • +
            self: ArrayCursor<T>
          +

          Returns R

    +

    Returns Promise<R[]>

+
+ +
    + +
  • +

    Advances the cursor and returns the next value in the cursor's remaining +result list, or undefined if the cursor has been depleted.

    +

    Note: If the result set spans multiple batches, any remaining batches +will only be fetched on demand. Depending on the cursor's TTL and the +processing speed, this may result in the server discarding the cursor +before it is fully depleted.

    + +

    Example

    const cursor = await db.query(aql`FOR x IN 1..3 RETURN x`);
    const one = await cursor.next(); // 1
    const two = await cursor.next(); // 2
    const three = await cursor.next(); // 3
    const empty = await cursor.next(); // undefined +
    +
    +

    Returns Promise<undefined | T>

+
+ +
    + +
  • +

    Depletes the cursor by applying the reducer function to each item in +the cursor's remaining result list. Returns the return value of reducer +for the last item.

    +

    Note: Most complex uses of the reduce method can be replaced with +simpler code using forEach or the for await syntax.

    +

    Note: If the result set spans multiple batches, any remaining batches +will only be fetched on demand. Depending on the cursor's TTL and the +processing speed, this may result in the server discarding the cursor +before it is fully depleted.

    +

    See also: +Array.prototype.reduce.

    + +

    Example

    function largestOfTwo(one, two) {
    return Math.max(one, two);
    }
    const cursor = await db.query(aql`FOR x IN 1..5 RETURN x`);
    const result = await cursor.reduce(largestOfTwo, 0);
    console.log(result); // 5
    console.log(cursor.hasNext); // false
    const emptyResult = await cursor.reduce(largestOfTwo, 0);
    console.log(emptyResult); // 0 +
    + +

    Example

    // BAD! NEEDLESSLY COMPLEX!
    const cursor = await db.query(aql`FOR x IN 1..5 RETURN x`);
    const result = await cursor.reduce((accumulator, currentValue) => {
    if (currentValue % 2 === 0) {
    accumulator.even.push(...currentValue);
    } else {
    accumulator.odd.push(...currentValue);
    }
    return accumulator;
    }, { odd: [], even: [] });
    console.log(result); // { odd: [1, 3, 5], even: [2, 4] }

    // GOOD! MUCH SIMPLER!
    const cursor = await db.query(aql`FOR x IN 1..5 RETURN x`);
    const odd = [];
    const even = [];
    for await (const currentValue of cursor) {
    if (currentValue % 2 === 0) {
    even.push(currentValue);
    } else {
    odd.push(currentValue);
    }
    }
    console.log({ odd, even }); // { odd: [1, 3, 5], even: [2, 4] } +
    +
    +
    +

    Type Parameters

    +
      +
    • +

      R

      +

      Return type of the reducer function.

      +
    +
    +

    Parameters

    +
      +
    • +
      reducer: ((accumulator: R, currentValue: T, index: number, self: ArrayCursor<T>) => R)
      +

      Function to execute on each element.

      +
      +
        +
      • +
          +
        • (accumulator: R, currentValue: T, index: number, self: ArrayCursor<T>): R
        • +
        • +
          +

          Parameters

          +
            +
          • +
            accumulator: R
          • +
          • +
            currentValue: T
          • +
          • +
            index: number
          • +
          • +
            self: ArrayCursor<T>
          +

          Returns R

    • +
    • +
      initialValue: R
      +

      Initial value of the accumulator value passed to +the reducer function.

      +
    +

    Returns Promise<R>

  • + +
  • +

    Depletes the cursor by applying the reducer function to each item in +the cursor's remaining result list. Returns the return value of reducer +for the last item.

    +

    Note: If the result set spans multiple batches, any remaining batches +will only be fetched on demand. Depending on the cursor's TTL and the +processing speed, this may result in the server discarding the cursor +before it is fully depleted.

    +

    See also: +Array.prototype.reduce.

    + +

    Example

    function largestOfTwo(one, two) {
    return Math.max(one, two);
    }
    const cursor = await db.query(aql`FOR x IN 1..5 RETURN x`);
    const result = await cursor.reduce(largestOfTwo);
    console.log(result); // 5
    console.log(cursor.hasNext); // false
    const emptyResult = await cursor.reduce(largestOfTwo);
    console.log(emptyResult); // undefined +
    +
    +
    +

    Type Parameters

    +
      +
    • +

      R

      +

      Return type of the reducer function.

      +
    +
    +

    Parameters

    +
      +
    • +
      reducer: ((accumulator: T | R, currentValue: T, index: number, self: ArrayCursor<T>) => R)
      +

      Function to execute on each element.

      +
      +
        +
      • +
          +
        • (accumulator: T | R, currentValue: T, index: number, self: ArrayCursor<T>): R
        • +
        • +
          +

          Parameters

          +
            +
          • +
            accumulator: T | R
          • +
          • +
            currentValue: T
          • +
          • +
            index: number
          • +
          • +
            self: ArrayCursor<T>
          +

          Returns R

    +

    Returns Promise<undefined | R>

+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/classes/cursor.BatchedArrayCursor.html b/8.8.0/classes/cursor.BatchedArrayCursor.html new file mode 100644 index 000000000..f71a59c47 --- /dev/null +++ b/8.8.0/classes/cursor.BatchedArrayCursor.html @@ -0,0 +1,521 @@ +BatchedArrayCursor | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Class BatchedArrayCursor<T>

+
+

The BatchedArrayCursor provides a batch-wise API to an ArrayCursor.

+

When using TypeScript, cursors can be cast to a specific item type in order +to increase type safety.

+ +

Example

const db = new Database();
const query = aql`FOR x IN 1..5 RETURN x`;
const cursor = await db.query(query) as ArrayCursor<number>;
const batches = cursor.batches; +
+ +

Example

const db = new Database();
const query = aql`FOR x IN 1..10000 RETURN x`;
const cursor = await db.query(query, { batchSize: 10 });
for await (const batch of cursor.batches) {
// Process all values in a batch in parallel
await Promise.all(batch.map(
value => asyncProcessValue(value)
));
} +
+
+
+

Type Parameters

+
    +
  • +

    T = any

    +

    Type to use for each item. Defaults to any.

    +
+
+

Hierarchy

+
    +
  • BatchedArrayCursor
+
+
+
+ +
+
+

Accessors

+
+ +
    +
  • get count(): undefined | number
  • +
  • +

    Total number of documents in the query result. Only available if the +count option was used.

    +
    +

    Returns undefined | number

+
+ +
    +
  • get extra(): Readonly<CursorExtras>
  • +
  • +

    Additional information about the cursor.

    +
    +

    Returns Readonly<CursorExtras>

+
+ +
    +
  • get hasMore(): boolean
  • +
  • +

    Whether the cursor has any remaining batches that haven't yet been +fetched. If set to false, all batches have been fetched and no +additional requests to the server will be made when consuming any +remaining batches from this cursor.

    +
    +

    Returns boolean

+
+ +
    +
  • get hasNext(): boolean
  • +
  • +

    Whether the cursor has more batches. If set to false, the cursor has +already been depleted and contains no more batches.

    +
    +

    Returns boolean

+
+ +
+
+

Methods

+
+ +
    + +
  • +

    Enables use with for await to deplete the cursor by asynchronously +yielding every batch in the cursor's remaining result set.

    +

    Note: If the result set spans multiple batches, any remaining batches +will only be fetched on demand. Depending on the cursor's TTL and the +processing speed, this may result in the server discarding the cursor +before it is fully depleted.

    + +

    Example

    const cursor = await db.query(aql`
    FOR user IN users
    FILTER user.isActive
    RETURN user
    `);
    for await (const users of cursor.batches) {
    for (const user of users) {
    console.log(user.email, user.isAdmin);
    }
    } +
    +
    +

    Returns AsyncGenerator<T[], undefined, undefined>

+
+ +
    + +
  • +

    Depletes the cursor, then returns an array containing all batches in the +cursor's remaining result list.

    + +

    Example

    const cursor = await db.query(
    aql`FOR x IN 1..5 RETURN x`,
    { batchSize: 2 }
    );
    const result = await cursor.batches.all(); // [[1, 2], [3, 4], [5]]
    console.log(cursor.hasNext); // false +
    +
    +

    Returns Promise<T[][]>

+
+ +
    + +
  • +

    Depletes the cursor by applying the callback function to each batch in +the cursor's remaining result list. Returns an array containing the +return values of callback for each batch, flattened to a depth of 1.

    +

    Note: If the result set spans multiple batches, any remaining batches +will only be fetched on demand. Depending on the cursor's TTL and the +processing speed, this may result in the server discarding the cursor +before it is fully depleted.

    +

    See also: +Array.prototype.flatMap.

    + +

    Example

    const cursor = await db.query(
    aql`FOR x IN 1..5 RETURN x`,
    { batchSize: 2 }
    );
    const squares = await cursor.batches.flatMap((currentBatch) => {
    return currentBatch.map((value) => value ** 2);
    });
    console.log(squares); // [1, 1, 2, 4, 3, 9, 4, 16, 5, 25]
    console.log(cursor.hasNext); // false +
    + +

    Example

    const cursor = await db.query(
    aql`FOR x IN 1..5 RETURN x`,
    { batchSize: 1 }
    );
    const odds = await cursor.batches.flatMap((currentBatch) => {
    if (currentBatch[0] % 2 === 0) {
    return []; // empty array flattens into nothing
    }
    return currentBatch;
    });
    console.logs(odds); // [1, 3, 5] +
    +
    +
    +

    Type Parameters

    +
      +
    • +

      R

      +

      Return type of the callback function.

      +
    +
    +

    Parameters

    +
      +
    • +
      callback: ((currentBatch: T[], index: number, self: BatchedArrayCursor<T>) => R | R[])
      +

      Function to execute on each element.

      +
      +
        +
      • +
    +

    Returns Promise<R[]>

+
+ +
    + +
  • +

    Advances the cursor by applying the callback function to each item in +the cursor's remaining result list until the cursor is depleted or +callback returns the exact value false. Returns a promise that +evalues to true unless the function returned false.

    +

    Note: If the result set spans multiple batches, any remaining batches +will only be fetched on demand. Depending on the cursor's TTL and the +processing speed, this may result in the server discarding the cursor +before it is fully depleted.

    +

    See also: +Array.prototype.forEach.

    + +

    Example

    const cursor = await db.query(
    aql`FOR x IN 1..5 RETURN x`,
    { batchSize: 2 }
    );
    const result = await cursor.batches.forEach((currentBatch) => {
    for (const value of currentBatch) {
    console.log(value);
    }
    });
    console.log(result) // true
    console.log(cursor.hasNext); // false +
    + +

    Example

    const cursor = await db.query(
    aql`FOR x IN 1..5 RETURN x`,
    { batchSize: 2 }
    );
    const result = await cursor.batches.forEach((currentBatch) => {
    for (const value of currentBatch) {
    console.log(value);
    }
    return false; // stop after the first batch
    });
    console.log(result); // false
    console.log(cursor.hasNext); // true +
    +
    +
    +

    Parameters

    +
      +
    • +
      callback: ((currentBatch: T[], index: number, self: BatchedArrayCursor<T>) => false | void)
      +

      Function to execute on each element.

      +
      +
        +
      • +
          +
        • (currentBatch: T[], index: number, self: BatchedArrayCursor<T>): false | void
        • +
        • +
          +

          Parameters

          +
          +

          Returns false | void

    +

    Returns Promise<boolean>

+
+ +
    + +
  • +

    Drains the cursor and frees up associated database resources.

    +

    This method has no effect if all batches have already been consumed.

    + +

    Example

    const cursor1 = await db.query(aql`FOR x IN 1..5 RETURN x`);
    console.log(cursor1.hasMore); // false
    await cursor1.kill(); // no effect

    const cursor2 = await db.query(
    aql`FOR x IN 1..5 RETURN x`,
    { batchSize: 2 }
    );
    console.log(cursor2.hasMore); // true
    await cursor2.kill(); // cursor is depleted +
    +
    +

    Returns Promise<void>

+
+ +
    + +
  • +

    Loads all remaining batches from the server.

    +

    Warning: This may impact memory use when working with very large +query result sets.

    + +

    Example

    const cursor = await db.query(
    aql`FOR x IN 1..5 RETURN x`,
    { batchSize: 1 }
    );
    console.log(cursor.hasMore); // true
    await cursor.batches.loadAll();
    console.log(cursor.hasMore); // false
    console.log(cursor.hasNext); // true
    for await (const item of cursor) {
    console.log(item);
    // No server roundtrips necessary any more
    } +
    +
    +

    Returns Promise<void>

+
+ +
    + +
  • +

    Depletes the cursor by applying the callback function to each batch in +the cursor's remaining result list. Returns an array containing the +return values of callback for each batch.

    +

    Note: This creates an array of all return values, which may impact +memory use when working with very large query result sets. Consider using +forEach, reduce or +flatMap instead.

    +

    See also: +Array.prototype.map.

    + +

    Example

    const cursor = await db.query(
    aql`FOR x IN 1..5 RETURN x`,
    { batchSize: 2 }
    );
    const squares = await cursor.batches.map((currentBatch) => {
    return currentBatch.map((value) => value ** 2);
    });
    console.log(squares); // [[1, 4], [9, 16], [25]]
    console.log(cursor.hasNext); // false +
    +
    +
    +

    Type Parameters

    +
      +
    • +

      R

      +

      Return type of the callback function.

      +
    +
    +

    Parameters

    +
      +
    • +
      callback: ((currentBatch: T[], index: number, self: BatchedArrayCursor<T>) => R)
      +

      Function to execute on each element.

      +
      +
    +

    Returns Promise<R[]>

+
+ +
    + +
  • +

    Advances the cursor and returns all remaining values in the cursor's +current batch. If the current batch has already been exhausted, fetches +the next batch from the server and returns it, or undefined if the +cursor has been depleted.

    +

    Note: If the result set spans multiple batches, any remaining batches +will only be fetched on demand. Depending on the cursor's TTL and the +processing speed, this may result in the server discarding the cursor +before it is fully depleted.

    + +

    Example

    const cursor = await db.query(
    aql`FOR i IN 1..10 RETURN i`,
    { batchSize: 5 }
    );
    const firstBatch = await cursor.batches.next(); // [1, 2, 3, 4, 5]
    await cursor.next(); // 6
    const lastBatch = await cursor.batches.next(); // [7, 8, 9, 10]
    console.log(cursor.hasNext); // false +
    +
    +

    Returns Promise<undefined | T[]>

+
+ +
    + +
  • +

    Depletes the cursor by applying the reducer function to each batch in +the cursor's remaining result list. Returns the return value of reducer +for the last batch.

    +

    Note: Most complex uses of the reduce method can be replaced with +simpler code using forEach or the for await +syntax.

    +

    Note: If the result set spans multiple batches, any remaining batches +will only be fetched on demand. Depending on the cursor's TTL and the +processing speed, this may result in the server discarding the cursor +before it is fully depleted.

    +

    See also: +Array.prototype.reduce.

    + +

    Example

    function largestValue(baseline, values) {
    return Math.max(baseline, ...values);
    }
    const cursor = await db.query(
    aql`FOR x IN 1..5 RETURN x`,
    { batchSize: 3 }
    );
    const result = await cursor.batches.reduce(largestValue, 0);
    console.log(result); // 5
    console.log(cursor.hasNext); // false
    const emptyResult = await cursor.batches.reduce(largestValue, 0);
    console.log(emptyResult); // 0 +
    + +

    Example

    // BAD! NEEDLESSLY COMPLEX!
    const cursor = await db.query(
    aql`FOR x IN 1..5 RETURN x`,
    { batchSize: 1 }
    );
    const result = await cursor.reduce((accumulator, currentBatch) => {
    if (currentBatch[0] % 2 === 0) {
    accumulator.even.push(...currentBatch);
    } else {
    accumulator.odd.push(...currentBatch);
    }
    return accumulator;
    }, { odd: [], even: [] });
    console.log(result); // { odd: [1, 3, 5], even: [2, 4] }

    // GOOD! MUCH SIMPLER!
    const cursor = await db.query(aql`FOR x IN 1..5 RETURN x`);
    const odd = [];
    const even = [];
    for await (const currentBatch of cursor) {
    if (currentBatch[0] % 2 === 0) {
    even.push(...currentBatch);
    } else {
    odd.push(...currentBatch);
    }
    }
    console.log({ odd, even }); // { odd: [1, 3, 5], even: [2, 4] } +
    +
    +
    +

    Type Parameters

    +
      +
    • +

      R

      +

      Return type of the reducer function.

      +
    +
    +

    Parameters

    +
      +
    • +
      reducer: ((accumulator: R, currentBatch: T[], index: number, self: BatchedArrayCursor<T>) => R)
      +

      Function to execute on each element.

      +
      +
        +
      • +
          +
        • (accumulator: R, currentBatch: T[], index: number, self: BatchedArrayCursor<T>): R
        • +
        • +
          +

          Parameters

          +
          +

          Returns R

    • +
    • +
      initialValue: R
      +

      Initial value of the accumulator value passed to +the reducer function.

      +
    +

    Returns Promise<R>

  • + +
  • +

    Depletes the cursor by applying the reducer function to each batch in +the cursor's remaining result list. Returns the return value of reducer +for the last batch.

    +

    Note: If the result set spans multiple batches, any remaining batches +will only be fetched on demand. Depending on the cursor's TTL and the +processing speed, this may result in the server discarding the cursor +before it is fully depleted.

    +

    See also: +Array.prototype.reduce.

    + +

    Example

    function largestValue(values1, values2) {
    return [Math.max(...values1, ...values2)];
    }
    const cursor = await db.query(
    aql`FOR x IN 1..5 RETURN x`,
    { batchSize: 3 }
    );
    const result = await cursor.batches.reduce(largestValue);
    console.log(result); // [5]
    console.log(cursor.hasNext); // false +
    +
    +
    +

    Type Parameters

    +
      +
    • +

      R

      +

      Return type of the reducer function.

      +
    +
    +

    Parameters

    +
      +
    • +
      reducer: ((accumulator: T[] | R, currentBatch: T[], index: number, self: BatchedArrayCursor<T>) => R)
      +

      Function to execute on each element.

      +
      +
        +
      • +
          +
        • (accumulator: T[] | R, currentBatch: T[], index: number, self: BatchedArrayCursor<T>): R
        • +
        • +
          +

          Parameters

          +
            +
          • +
            accumulator: T[] | R
          • +
          • +
            currentBatch: T[]
          • +
          • +
            index: number
          • +
          • +
            self: BatchedArrayCursor<T>
          +

          Returns R

    +

    Returns Promise<undefined | R>

+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/classes/database.Database.html b/8.8.0/classes/database.Database.html new file mode 100644 index 000000000..5389028a9 --- /dev/null +++ b/8.8.0/classes/database.Database.html @@ -0,0 +1,3918 @@ +Database | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Class Database

+
+

An object representing a single ArangoDB database. All arangojs collections, +cursors, analyzers and so on are linked to a Database object.

+
+
+

Hierarchy

+
    +
  • Database
+
+
+
+ +
+
+

Constructors

+
+
+

Accessors

+
+
+

Methods

+
acquireHostList +analyzer +analyzers +beginTransaction +clearSlowQueries +clearUserAccessLevel +close +collection +collections +commitLocalServiceState +computeClusterRebalance +createAnalyzer +createCollection +createDatabase +createEdgeCollection +createFunction +createGraph +createHotBackup +createJob +createUser +createView +database +databases +deleteAllJobResults +deleteExpiredJobResults +deleteHotBackup +downloadService +dropDatabase +dropFunction +executeClusterRebalance +executeTransaction +exists +explain +get +getClusterImbalance +getLogEntries +getLogLevel +getLogMessages +getService +getServiceConfiguration +getServiceDependencies +getServiceDocumentation +getServiceReadme +getUser +getUserAccessLevel +getUserDatabases +graph +graphs +installService +job +killQuery +listAnalyzers +listCollections +listCompletedJobs +listDatabases +listFunctions +listGraphs +listHotBackups +listPendingJobs +listRunningQueries +listServiceScripts +listServices +listSlowQueries +listTransactions +listUserDatabases +listUsers +listViews +login +parse +query +queryRules +queryTracking +rebalanceCluster +removeUser +renameCollection +renameView +renewAuthToken +replaceService +replaceServiceConfiguration +replaceServiceDependencies +replaceUser +restoreHotBackup +route +runServiceScript +runServiceTests +setLogLevel +setResponseQueueTimeSamples +setServiceDevelopmentMode +setUserAccessLevel +shutdown +time +transaction +transactions +uninstallService +updateServiceConfiguration +updateServiceDependencies +updateUser +upgradeService +useBasicAuth +useBearerAuth +userDatabases +version +view +views +waitForPropagation +withTransaction +
+
+

Constructors

+
+ +
    + +
  • +

    Creates a new Database instance with its own connection pool.

    +

    See also database.

    + +

    Example

    const db = new Database({
    url: "http://127.0.0.1:8529",
    databaseName: "my_database",
    auth: { username: "admin", password: "hunter2" },
    }); +
    +
    +
    +

    Parameters

    +
      +
    • +
      Optional config: Config
      +

      An object with configuration options.

      +
    +

    Returns Database

  • + +
  • +

    Creates a new Database instance with its own connection pool.

    +

    See also database.

    + +

    Example

    const db = new Database("http://127.0.0.1:8529", "my_database");
    db.useBasicAuth("admin", "hunter2"); +
    +
    +
    +

    Parameters

    +
      +
    • +
      url: string | string[]
      +

      Base URL of the ArangoDB server or list of server URLs. +Equivalent to the url option in Config.

      +
    • +
    • +
      Optional name: string
    +

    Returns Database

+
+

Accessors

+
+ +
    +
  • get name(): string
  • +
  • +

    Name of the ArangoDB database this instance represents.

    +
    +

    Returns string

+
+ +
    +
  • get queueTime(): QueueTimeMetrics
  • +
  • +

    Methods for accessing the server-reported queue times of the mostly +recently received responses.

    +
    +

    Returns QueueTimeMetrics

+
+

Methods

+
+ +
    + +
  • +

    Updates the URL list by requesting a list of all coordinators in the +cluster and adding any endpoints not initially specified in the +Config.

    +

    For long-running processes communicating with an ArangoDB cluster it is +recommended to run this method periodically (e.g. once per hour) to make +sure new coordinators are picked up correctly and can be used for +fail-over or load balancing.

    + +

    Example

    const db = new Database();
    const interval = setInterval(
    () => db.acquireHostList(),
    5 * 60 * 1000 // every 5 minutes
    );

    // later
    clearInterval(interval);
    system.close(); +
    +
    +
    +

    Parameters

    +
      +
    • +
      overwrite: boolean = false
      +

      If set to true, the existing host list will be +replaced instead of extended.

      +
    +

    Returns Promise<void>

+
+ +
    + +
  • +

    Returns an Analyzer instance representing the Analyzer with the +given analyzerName.

    + +

    Example

    const db = new Database();
    const analyzer = db.analyzer("some-analyzer");
    const info = await analyzer.get(); +
    +
    +
    +

    Parameters

    +
      +
    • +
      analyzerName: string
    +

    Returns Analyzer

+
+ +
    + +
  • +

    Fetches all Analyzers visible in the database and returns an array of +Analyzer instances for those Analyzers.

    +

    See also listAnalyzers.

    + +

    Example

    const db = new Database();
    const analyzers = await db.analyzers();
    // analyzers is an array of Analyzer instances +
    +
    +

    Returns Promise<Analyzer[]>

+
+ +
    + +
  • +

    Begins a new streaming transaction for the given collections, then returns +a Transaction instance for the transaction.

    +

    Collections can be specified as collection names (strings) or objects +implementing the ArangoCollection interface: Collection, +GraphVertexCollection, GraphEdgeCollection as +well as (in TypeScript) DocumentCollection and +EdgeCollection.

    + +

    Example

    const vertices = db.collection("vertices");
    const edges = db.collection("edges");
    const trx = await db.beginTransaction({
    read: ["vertices"],
    write: [edges] // collection instances can be passed directly
    });
    const start = await trx.step(() => vertices.document("a"));
    const end = await trx.step(() => vertices.document("b"));
    await trx.step(() => edges.save({ _from: start._id, _to: end._id }));
    await trx.commit(); +
    +
    +
    +

    Parameters

    +
    +

    Returns Promise<Transaction>

  • + +
  • +

    Begins a new streaming transaction for the given collections, then returns +a Transaction instance for the transaction.

    +

    Collections can be specified as collection names (strings) or objects +implementing the ArangoCollection interface: Collection, +GraphVertexCollection, GraphEdgeCollection as well as +(in TypeScript) DocumentCollection and EdgeCollection.

    + +

    Example

    const vertices = db.collection("vertices");
    const edges = db.collection("edges");
    const trx = await db.beginTransaction([
    "vertices",
    edges // collection instances can be passed directly
    ]);
    const start = await trx.step(() => vertices.document("a"));
    const end = await trx.step(() => vertices.document("b"));
    await trx.step(() => edges.save({ _from: start._id, _to: end._id }));
    await trx.commit(); +
    +
    +
    +

    Parameters

    +
      +
    • +
      collections: (string | ArangoCollection)[]
      +

      Collections that can be read from and written to +during the transaction.

      +
    • +
    • +
      Optional options: TransactionOptions
      +

      Options for the transaction.

      +
    +

    Returns Promise<Transaction>

  • + +
  • +

    Begins a new streaming transaction for the given collections, then returns +a Transaction instance for the transaction.

    +

    The Collection can be specified as a collection name (string) or an object +implementing the ArangoCollection interface: Collection, +GraphVertexCollection, GraphEdgeCollection as well as +(in TypeScript) DocumentCollection and EdgeCollection.

    + +

    Example

    const vertices = db.collection("vertices");
    const start = vertices.document("a");
    const end = vertices.document("b");
    const edges = db.collection("edges");
    const trx = await db.beginTransaction(
    edges // collection instances can be passed directly
    );
    await trx.step(() => edges.save({ _from: start._id, _to: end._id }));
    await trx.commit(); +
    +
    +
    +

    Parameters

    +
      +
    • +
      collection: string | ArangoCollection
      +

      A collection that can be read from and written to +during the transaction.

      +
    • +
    • +
      Optional options: TransactionOptions
      +

      Options for the transaction.

      +
    +

    Returns Promise<Transaction>

+
+ +
    + +
  • +

    Clears the list of recent slow queries.

    +

    See also listSlowQueries.

    + +

    Example

    const db = new Database();
    await db.clearSlowQueries();
    // Slow query list is now cleared +
    +
    +

    Returns Promise<void>

+
+ +
    + +
  • +

    Clears the given ArangoDB user's access level for the database, or the +given collection in the given database.

    + +

    Example

    const db = new Database();
    await db.clearUserAccessLevel("steve");
    // The access level of the user "steve" has been cleared for the current
    // database. +
    + +

    Example

    const db = new Database();
    await db.clearUserAccessLevel("steve", { database: "staging" });
    // The access level of the user "steve" has been cleared for the "staging"
    // database. +
    + +

    Example

    const db = new Database();
    await db.clearUserAccessLevel("steve", { collection: "pokemons" });
    // The access level of the user "steve" has been cleared for the
    // "pokemons" collection in the current database. +
    + +

    Example

    const db = new Database();
    await db.clearUserAccessLevel("steve", {
    database: "staging",
    collection: "pokemons"
    });
    // The access level of the user "steve" has been cleared for the
    // "pokemons" collection in the "staging" database. +
    + +

    Example

    const db = new Database();
    const staging = db.database("staging");
    await db.clearUserAccessLevel("steve", { database: staging });
    // The access level of the user "steve" has been cleared for the "staging"
    // database. +
    + +

    Example

    const db = new Database();
    const staging = db.database("staging");
    await db.clearUserAccessLevel("steve", {
    collection: staging.collection("pokemons")
    });
    // The access level of the user "steve" has been cleared for the
    // "pokemons" collection in database "staging". +
    +
    +
    +

    Parameters

    +
      +
    • +
      username: string
      +

      Name of the ArangoDB user to clear the access level for.

      +
    • +
    • +
      __namedParameters: UserAccessLevelOptions
    +

    Returns Promise<ArangoApiResponse<Record<string, AccessLevel>>>

+
+ +
    + +
  • +

    Closes all active connections of this database instance.

    +

    Can be used to clean up idling connections during longer periods of +inactivity.

    +

    Note: This method currently has no effect in the browser version of +arangojs.

    + +

    Example

    const db = new Database();
    const sessions = db.collection("sessions");
    // Clean up expired sessions once per hour
    setInterval(async () => {
    await db.query(aql`
    FOR session IN ${sessions}
    FILTER session.expires < DATE_NOW()
    REMOVE session IN ${sessions}
    `);
    // Making sure to close the connections because they're no longer used
    system.close();
    }, 1000 * 60 * 60); +
    +
    +

    Returns void

+
+ +
    + +
  • +

    Returns a Collection instance for the given collection name.

    +

    In TypeScript the collection implements both the +DocumentCollection and EdgeCollection +interfaces and can be cast to either type to enforce a stricter API.

    + +

    Example

    const db = new Database();
    const collection = db.collection("potatoes"); +
    + +

    Example

    interface Person {
    name: string;
    }
    const db = new Database();
    const persons = db.collection<Person>("persons"); +
    + +

    Example

    interface Person {
    name: string;
    }
    interface Friend {
    startDate: number;
    endDate?: number;
    }
    const db = new Database();
    const documents = db.collection("persons") as DocumentCollection<Person>;
    const edges = db.collection("friends") as EdgeCollection<Friend>; +
    +
    +
    +

    Type Parameters

    +
      +
    • +

      T extends Record<string, any> = any

      +

      Type to use for document data. Defaults to any.

      +
    +
    +

    Parameters

    +
      +
    • +
      collectionName: string
      +

      Name of the edge collection.

      +
    +

    Returns DocumentCollection<T> & EdgeCollection<T>

+
+ +
    + +
  • +

    Fetches all collections from the database and returns an array of +Collection instances.

    +

    In TypeScript these instances implement both the +DocumentCollection and EdgeCollection +interfaces and can be cast to either type to enforce a stricter API.

    +

    See also listCollections.

    + +

    Example

    const db = new Database();
    const collections = await db.collections();
    // collections is an array of DocumentCollection and EdgeCollection
    // instances not including system collections +
    + +

    Example

    const db = new Database();
    const collections = await db.collections(false);
    // collections is an array of DocumentCollection and EdgeCollection
    // instances including system collections +
    +
    +
    +

    Parameters

    +
      +
    • +
      excludeSystem: boolean = true
      +

      Whether system collections should be excluded.

      +
    +

    Returns Promise<(DocumentCollection<any> & EdgeCollection<any>)[]>

+
+ +
    + +
  • +

    Writes all locally available services to the database and updates any +service bundles missing in the database.

    + +

    Example

    await db.commitLocalServiceState();
    // all services available on the coordinator have been written to the db +
    + +

    Example

    await db.commitLocalServiceState(true);
    // all service conflicts have been resolved in favor of this coordinator +
    +
    +
    +

    Parameters

    +
      +
    • +
      replace: boolean = false
      +

      If set to true, outdated services will also be +committed. This can be used to solve some consistency problems when +service bundles are missing in the database or were deleted manually.

      +
    +

    Returns Promise<void>

+
+ +
    + +
  • +

    Computes a set of move shard operations to rebalance the cluster.

    + +

    Example

    const db = new Database();
    const result = await db.computerClusterRebalance({
    moveLeaders: true,
    moveFollowers: true
    });
    if (result.moves.length) {
    await db.executeClusterRebalance(result.moves);
    } +
    +
    +
    +

    Parameters

    +
    +

    Returns Promise<ClusterRebalanceResult>

+
+ +
    + +
  • +

    Creates a new Analyzer with the given analyzerName and options, then +returns an Analyzer instance for the new Analyzer.

    + +

    Example

    const db = new Database();
    const analyzer = await db.createAnalyzer("potatoes", { type: "identity" });
    // the identity Analyzer "potatoes" now exists +
    +
    +
    +

    Parameters

    +
      +
    • +
      analyzerName: string
      +

      Name of the Analyzer.

      +
    • +
    • +
      options: CreateAnalyzerOptions
      +

      An object defining the properties of the Analyzer.

      +
    +

    Returns Promise<Analyzer>

+
+ +
    + +
  • +

    Creates a new collection with the given collectionName and options, +then returns a DocumentCollection instance for the new collection.

    + +

    Example

    const db = new Database();
    const documents = db.createCollection("persons"); +
    + +

    Example

    interface Person {
    name: string;
    }
    const db = new Database();
    const documents = db.createCollection<Person>("persons"); +
    +
    +
    +

    Type Parameters

    +
      +
    • +

      T extends Record<string, any> = any

      +

      Type to use for document data. Defaults to any.

      +
    +
    +

    Parameters

    +
    +

    Returns Promise<DocumentCollection<T>>

  • + +
  • +

    Creates a new edge collection with the given collectionName and +options, then returns an EdgeCollection instance for the new +edge collection.

    + +

    Example

    const db = new Database();
    const edges = db.createCollection("friends", {
    type: CollectionType.EDGE_COLLECTION
    }); +
    + +

    Example

    interface Friend {
    startDate: number;
    endDate?: number;
    }
    const db = new Database();
    const edges = db.createCollection<Friend>("friends", {
    type: CollectionType.EDGE_COLLECTION
    }); +
    +
    +
    +

    Type Parameters

    +
      +
    • +

      T extends Record<string, any> = any

      +

      Type to use for edge document data. Defaults to any.

      +
    +
    +

    Parameters

    +
    +

    Returns Promise<EdgeCollection<T>>

+
+ +
    + +
  • +

    Creates a new database with the given databaseName with the given +options and returns a Database instance for that database.

    + +

    Example

    const db = new Database();
    const info = await db.createDatabase("mydb", {
    users: [{ username: "root" }]
    });
    // the database has been created +
    +
    +
    +

    Parameters

    +
      +
    • +
      databaseName: string
      +

      Name of the database to create.

      +
    • +
    • +
      Optional options: CreateDatabaseOptions
      +

      Options for creating the database.

      +
    +

    Returns Promise<Database>

  • + +
  • +

    Creates a new database with the given databaseName with the given +users and returns a Database instance for that database.

    + +

    Example

    const db = new Database();
    const info = await db.createDatabase("mydb", [{ username: "root" }]);
    // the database has been created +
    +
    +
    +

    Parameters

    +
      +
    • +
      databaseName: string
      +

      Name of the database to create.

      +
    • +
    • +
      users: CreateDatabaseUser[]
      +

      Database users to create with the database.

      +
    +

    Returns Promise<Database>

+
+ +
    + +
  • +

    Creates a new edge collection with the given collectionName and +options, then returns an EdgeCollection instance for the new +edge collection.

    +

    This is a convenience method for calling createCollection +with options.type set to EDGE_COLLECTION.

    + +

    Example

    const db = new Database();
    const edges = db.createEdgeCollection("friends"); +
    + +

    Example

    interface Friend {
    startDate: number;
    endDate?: number;
    }
    const db = new Database();
    const edges = db.createEdgeCollection<Friend>("friends"); +
    +
    +
    +

    Type Parameters

    +
      +
    • +

      T extends Record<string, any> = any

      +

      Type to use for edge document data. Defaults to any.

      +
    +
    +

    Parameters

    +
      +
    • +
      collectionName: string
      +

      Name of the new collection.

      +
    • +
    • +
      Optional options: CreateCollectionOptions
      +

      Options for creating the collection.

      +
    +

    Returns Promise<EdgeCollection<T>>

+
+ +
    + +
  • +

    Creates an AQL user function with the given name and code if it does +not already exist or replaces it if a function with the same name already +existed.

    + +

    Example

    const db = new Database();
    await db.createFunction(
    "ACME::ACCOUNTING::CALCULATE_VAT",
    "(price) => price * 0.19"
    );
    // Use the new function in an AQL query with template handler:
    const cursor = await db.query(aql`
    FOR product IN products
    RETURN MERGE(
    { vat: ACME::ACCOUNTING::CALCULATE_VAT(product.price) },
    product
    )
    `);
    // cursor is a cursor for the query result +
    +
    +
    +

    Parameters

    +
      +
    • +
      name: string
      +

      A valid AQL function name. The function name must consist +of at least two alphanumeric identifiers separated with double colons.

      +
    • +
    • +
      code: string
      +

      A string evaluating to a JavaScript function (not a +JavaScript function object).

      +
    • +
    • +
      isDeterministic: boolean = false
      +

      If set to true, the function is expected to +always return the same result for equivalent inputs. This option currently +has no effect but may allow for optimizations in the future.

      +
    +

    Returns Promise<ArangoApiResponse<{
        isNewlyCreated: boolean;
    }>>

+
+ +
    + +
  • +

    Creates a graph with the given graphName and edgeDefinitions, then +returns a Graph instance for the new graph.

    +
    +
    +

    Parameters

    +
      +
    • +
      graphName: string
      +

      Name of the graph to be created.

      +
    • +
    • +
      edgeDefinitions: EdgeDefinitionOptions[]
      +

      An array of edge definitions.

      +
    • +
    • +
      Optional options: CreateGraphOptions
      +

      An object defining the properties of the graph.

      +
    +

    Returns Promise<Graph>

+
+ +
    + +
  • +

    (Enterprise Edition only.) Creates a hot backup of the entire ArangoDB +deployment including all databases, collections, etc.

    +

    Returns an object describing the backup result.

    + +

    Example

    const info = await db.createHotBackup();
    // a hot backup has been created +
    +
    +
    +

    Parameters

    +
    +

    Returns Promise<HotBackupResult>

+
+ +
    + +
  • +

    Creates an async job by executing the given callback function. The first +database request performed by the callback will be marked for asynchronous +execution and its result will be made available as an async job.

    +

    Returns a Job instance that can be used to retrieve the result +of the callback function once the request has been executed.

    + +

    Example

    const db = new Database();
    const job = await db.createJob(() => db.collections());
    while (!job.isLoaded) {
    await timeout(1000);
    await job.load();
    }
    // job.result is a list of Collection instances +
    +
    +
    +

    Type Parameters

    +
      +
    • +

      T

    +
    +

    Parameters

    +
      +
    • +
      callback: (() => Promise<T>)
      +

      Callback function to execute as an async job.

      +
      +
        +
      • +
          +
        • (): Promise<T>
        • +
        • +

          Returns Promise<T>

    +

    Returns Promise<Job<T>>

+
+ +
    + +
  • +

    Creates a new ArangoDB user with the given password.

    + +

    Example

    const db = new Database();
    const user = await db.createUser("steve", "hunter2");
    // The user "steve" has been created +
    +
    +
    +

    Parameters

    +
      +
    • +
      username: string
      +

      Name of the ArangoDB user to create.

      +
    • +
    • +
      passwd: string
      +

      Password of the new ArangoDB user.

      +
    +

    Returns Promise<ArangoApiResponse<ArangoUser>>

  • + +
  • +

    Creates a new ArangoDB user with the given options.

    + +

    Example

    const db = new Database();
    const user = await db.createUser("steve", { passwd: "hunter2" });
    // The user "steve" has been created +
    +
    +
    +

    Parameters

    +
      +
    • +
      username: string
      +

      Name of the ArangoDB user to create.

      +
    • +
    • +
      options: UserOptions
      +

      Additional options for creating the ArangoDB user.

      +
    +

    Returns Promise<ArangoApiResponse<ArangoUser>>

+
+ +
    + +
  • +

    Creates a new View with the given viewName and options, then returns a +View instance for the new View.

    + +

    Example

    const db = new Database();
    const view = await db.createView("potatoes", { type: "arangosearch" });
    // the ArangoSearch View "potatoes" now exists +
    +
    +
    +

    Parameters

    +
      +
    • +
      viewName: string
      +

      Name of the View.

      +
    • +
    • +
      options: CreateViewOptions
      +

      An object defining the properties of the View.

      +
    +

    Returns Promise<View>

+
+ +
    + +
  • +

    Creates a new Database instance for the given databaseName that +shares this database's connection pool.

    +

    See also new Database.

    + +

    Example

    const systemDb = new Database();
    const myDb = system.database("my_database"); +
    +
    +
    +

    Parameters

    +
      +
    • +
      databaseName: string
      +

      Name of the database.

      +
    +

    Returns Database

+
+ +
    + +
  • +

    Fetches all databases from the server and returns an array of Database +instances for those databases.

    +

    See also listDatabases and +userDatabases.

    + +

    Example

    const db = new Database();
    const names = await db.databases();
    // databases is an array of databases +
    +
    +

    Returns Promise<Database[]>

+
+ +
    + +
  • +

    Deletes the results of all completed async jobs.

    +
    +

    Returns Promise<void>

+
+ +
    + +
  • +

    Deletes the results of all completed async jobs created before the given +threshold.

    + +

    Example

    const db = new Database();
    const ONE_WEEK = 7 * 24 * 60 * 60 * 1000;
    await db.deleteExpiredJobResults(Date.now() - ONE_WEEK);
    // all job results older than a week have been deleted +
    +
    +
    +

    Parameters

    +
      +
    • +
      threshold: number
      +

      The expiration timestamp in milliseconds.

      +
    +

    Returns Promise<void>

+
+ +
    + +
  • +

    (Enterprise Edition only.) Deletes a local hot backup.

    + +

    Example

    await db.deleteHotBackup("2023-09-19T15.38.21Z_example");
    // the backup has been deleted +
    +
    +
    +

    Parameters

    +
      +
    • +
      id: string
      +

      The ID of the backup to delete.

      +
    +

    Returns Promise<void>

+
+ +
    + +
  • +

    Retrieves a zip bundle containing the service files.

    +

    Returns a Buffer in node.js or Blob in the browser.

    + +

    Example

    const db = new Database();
    const serviceBundle = await db.downloadService("/my-foxx"); +
    +
    +
    +

    Parameters

    +
      +
    • +
      mount: string
      +

      The service's mount point, relative to the database.

      +
    +

    Returns Promise<Blob | Buffer>

+
+ +
    + +
  • +

    Deletes the database with the given databaseName from the server.

    + +

    Example

    const db = new Database();
    await db.dropDatabase("mydb");
    // database "mydb" no longer exists +
    +
    +
    +

    Parameters

    +
      +
    • +
      databaseName: string
      +

      Name of the database to delete.

      +
    +

    Returns Promise<boolean>

+
+ +
    + +
  • +

    Deletes the AQL user function with the given name from the database.

    + +

    Example

    const db = new Database();
    await db.dropFunction("ACME::ACCOUNTING::CALCULATE_VAT");
    // the function no longer exists +
    +
    +
    +

    Parameters

    +
      +
    • +
      name: string
      +

      The name of the user function to drop.

      +
    • +
    • +
      group: boolean = false
      +

      If set to true, all functions with a name starting with +name will be deleted, otherwise only the function with the exact name +will be deleted.

      +
    +

    Returns Promise<ArangoApiResponse<{
        deletedCount: number;
    }>>

+
+ +
    + +
  • +

    Executes the given cluster move shard operations.

    + +

    Example

    const db = new Database();
    const result = await db.computerClusterRebalance({
    moveLeaders: true,
    moveFollowers: true
    });
    if (result.moves.length) {
    await db.executeClusterRebalance(result.moves);
    } +
    +
    +
    +

    Parameters

    +
    +

    Returns Promise<unknown>

+
+ +
    + +
  • +

    Performs a server-side JavaScript transaction and returns its return +value.

    +

    Collections can be specified as collection names (strings) or objects +implementing the ArangoCollection interface: Collection, +GraphVertexCollection, GraphEdgeCollection as well as +(in TypeScript) DocumentCollection and EdgeCollection.

    +

    Note: The action function will be evaluated and executed on the +server inside ArangoDB's embedded JavaScript environment and can not +access any values other than those passed via the params option.

    +

    See the official ArangoDB documentation for +the JavaScript @arangodb module +for information about accessing the database from within ArangoDB's +server-side JavaScript environment.

    + +

    Example

    const db = new Database();

    const action = `
    function(params) {
    // This code will be executed inside ArangoDB!
    const { query } = require("@arangodb");
    return query\`
    FOR user IN _users
    FILTER user.age > ${params.age}
    RETURN u.user
    \`.toArray();
    }
    `);

    const result = await db.executeTransaction({
    read: ["_users"]
    }, action, {
    params: { age: 12 }
    });
    // result contains the return value of the action +
    +
    +
    +

    Parameters

    +
      +
    • +
      collections: TransactionCollections & {
          allowImplicit?: boolean;
      }
      +

      Collections involved in the transaction.

      +
    • +
    • +
      action: string
      +

      A string evaluating to a JavaScript function to be +executed on the server.

      +
    • +
    • +
      Optional options: TransactionOptions & {
          params?: any;
      }
      +

      Options for the transaction. If options.allowImplicit +is specified, it will be used if collections.allowImplicit was not +specified.

      +
    +

    Returns Promise<any>

  • + +
  • +

    Performs a server-side transaction and returns its return value.

    +

    Collections can be specified as collection names (strings) or objects +implementing the ArangoCollection interface: Collection, +GraphVertexCollection, GraphEdgeCollection as well as +(in TypeScript) DocumentCollection and EdgeCollection.

    +

    Note: The action function will be evaluated and executed on the +server inside ArangoDB's embedded JavaScript environment and can not +access any values other than those passed via the params option. +See the official ArangoDB documentation for +the JavaScript @arangodb module +for information about accessing the database from within ArangoDB's +server-side JavaScript environment.

    + +

    Example

    const db = new Database();

    const action = `
    function(params) {
    // This code will be executed inside ArangoDB!
    const { query } = require("@arangodb");
    return query\`
    FOR user IN _users
    FILTER user.age > ${params.age}
    RETURN u.user
    \`.toArray();
    }
    `);

    const result = await db.executeTransaction(["_users"], action, {
    params: { age: 12 }
    });
    // result contains the return value of the action +
    +
    +
    +

    Parameters

    +
      +
    • +
      collections: (string | ArangoCollection)[]
      +

      Collections that can be read from and written to +during the transaction.

      +
    • +
    • +
      action: string
      +

      A string evaluating to a JavaScript function to be +executed on the server.

      +
    • +
    • +
      Optional options: TransactionOptions & {
          params?: any;
      }
      +

      Options for the transaction.

      +
    +

    Returns Promise<any>

  • + +
  • +

    Performs a server-side transaction and returns its return value.

    +

    The Collection can be specified as a collection name (string) or an object +implementing the ArangoCollection interface: Collection, +GraphVertexCollection, GraphEdgeCollection as well as +(in TypeScript) DocumentCollection and EdgeCollection.

    +

    Note: The action function will be evaluated and executed on the +server inside ArangoDB's embedded JavaScript environment and can not +access any values other than those passed via the params option. +See the official ArangoDB documentation for +the JavaScript @arangodb module +for information about accessing the database from within ArangoDB's +server-side JavaScript environment.

    + +

    Example

    const db = new Database();

    const action = `
    function(params) {
    // This code will be executed inside ArangoDB!
    const { query } = require("@arangodb");
    return query\`
    FOR user IN _users
    FILTER user.age > ${params.age}
    RETURN u.user
    \`.toArray();
    }
    `);

    const result = await db.executeTransaction("_users", action, {
    params: { age: 12 }
    });
    // result contains the return value of the action +
    +
    +
    +

    Parameters

    +
      +
    • +
      collection: string | ArangoCollection
      +

      A collection that can be read from and written to +during the transaction.

      +
    • +
    • +
      action: string
      +

      A string evaluating to a JavaScript function to be +executed on the server.

      +
    • +
    • +
      Optional options: TransactionOptions & {
          params?: any;
      }
      +

      Options for the transaction.

      +
    +

    Returns Promise<any>

+
+ +
    + +
  • +

    Checks whether the database exists.

    + +

    Example

    const db = new Database();
    const result = await db.exists();
    // result indicates whether the database exists +
    +
    +

    Returns Promise<boolean>

+
+ +
    + +
  • +

    Explains a database query using the given query.

    +

    See the aql template string handler for information about how +to create a query string without manually defining bind parameters nor +having to worry about escaping variables.

    + +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    const explanation = await db.explain(aql`
    FOR doc IN ${collection}
    FILTER doc.flavor == "strawberry"
    RETURN doc._key
    `); +
    +
    +
    +

    Parameters

    +
      +
    • +
      query: AqlQuery<any>
      +

      An object containing an AQL query string and bind +parameters, e.g. the object returned from an aql template string.

      +
    • +
    • +
      Optional options: ExplainOptions & {
          allPlans?: false;
      }
      +

      Options for explaining the query.

      +
    +

    Returns Promise<ArangoApiResponse<SingleExplainResult>>

  • + +
  • +

    Explains a database query using the given query.

    +

    See the aql template string handler for information about how +to create a query string without manually defining bind parameters nor +having to worry about escaping variables.

    + +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    const explanation = await db.explain(
    aql`
    FOR doc IN ${collection}
    FILTER doc.flavor == "strawberry"
    RETURN doc._key
    `,
    { allPlans: true }
    ); +
    +
    +
    +

    Parameters

    +
      +
    • +
      query: AqlQuery<any>
      +

      An object containing an AQL query string and bind +parameters, e.g. the object returned from an aql template string.

      +
    • +
    • +
      Optional options: ExplainOptions & {
          allPlans: true;
      }
      +

      Options for explaining the query.

      +
    +

    Returns Promise<ArangoApiResponse<MultiExplainResult>>

  • + +
  • +

    Explains a database query using the given query and bindVars.

    +

    See the aql template string handler for a safer and easier +alternative to passing strings directly.

    + +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    const explanation = await db.explain(
    `
    FOR doc IN @@collection
    FILTER doc.flavor == "strawberry"
    RETURN doc._key
    `,
    { "@collection": collection.name }
    ); +
    +
    +
    +

    Parameters

    +
      +
    • +
      query: string | AqlLiteral
      +

      An AQL query string.

      +
    • +
    • +
      Optional bindVars: Record<string, any>
      +

      An object defining bind parameters for the query.

      +
    • +
    • +
      Optional options: ExplainOptions & {
          allPlans?: false;
      }
      +

      Options for explaining the query.

      +
    +

    Returns Promise<ArangoApiResponse<SingleExplainResult>>

  • + +
  • +

    Explains a database query using the given query and bindVars.

    +

    See the aql template string handler for a safer and easier +alternative to passing strings directly.

    + +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    const explanation = await db.explain(
    `
    FOR doc IN @@collection
    FILTER doc.flavor == "strawberry"
    RETURN doc._key
    `,
    { "@collection": collection.name },
    { allPlans: true }
    ); +
    +
    +
    +

    Parameters

    +
      +
    • +
      query: string | AqlLiteral
      +

      An AQL query string.

      +
    • +
    • +
      Optional bindVars: Record<string, any>
      +

      An object defining bind parameters for the query.

      +
    • +
    • +
      Optional options: ExplainOptions & {
          allPlans: true;
      }
      +

      Options for explaining the query.

      +
    +

    Returns Promise<ArangoApiResponse<MultiExplainResult>>

+
+ +
    + +
  • +

    Fetches the database description for the active database from the server.

    + +

    Example

    const db = new Database();
    const info = await db.get();
    // the database exists +
    +
    +

    Returns Promise<DatabaseInfo>

+
+ +
    + +
  • +

    Computes the current cluster imbalance.

    + +

    Example

    const db = new Database();
    const imbalance = await db.getClusterImbalance(); +
    +
    +

    Returns Promise<ClusterRebalanceState>

+
+ +
    + +
  • +

    Retrieves the log messages from the server's global log.

    + +

    Example

    const log = await db.getLogEntries();
    for (let i = 0; i < log.totalAmount; i++) {
    console.log(`${
    new Date(log.timestamp[i] * 1000).toISOString()
    } - [${LogLevel[log.level[i]]}] ${log.text[i]} (#${log.lid[i]})`);
    } +
    +
    +
    +

    Parameters

    +
    +

    Returns Promise<LogEntries>

+
+ +
    + +
  • +

    Retrieves the server's current log level for each topic.

    + +

    Example

    const levels = await db.getLogLevel();
    console.log(levels.request); // log level for incoming requests +
    +
    +

    Returns Promise<Record<string, LogLevelSetting>>

+
+ +
    + +
  • +

    Retrieves the log messages from the server's global log.

    + +

    Deprecated

    This endpoint has been deprecated in ArangoDB 3.8. +Use getLogEntries instead.

    + +

    Example

    const messages = await db.getLogMessages();
    for (const m of messages) {
    console.log(`${m.date} - [${m.level}] ${m.message} (#${m.id})`);
    } +
    +
    +
    +

    Parameters

    +
    +

    Returns Promise<LogMessage[]>

+
+ +
    + +
  • +

    Retrieves information about a mounted service.

    + +

    Example

    const db = new Database();
    const info = await db.getService("/my-service");
    // info contains detailed information about the service +
    +
    +
    +

    Parameters

    +
      +
    • +
      mount: string
      +

      The service's mount point, relative to the database.

      +
    +

    Returns Promise<ServiceInfo>

+
+ +
    + +
  • +

    Retrieves information about the service's configuration options and their +current values.

    +

    See also replaceServiceConfiguration and +updateServiceConfiguration.

    + +

    Example

    const db = new Database();
    const config = await db.getServiceConfiguration("/my-service");
    for (const [key, option] of Object.entries(config)) {
    console.log(`${option.title} (${key}): ${option.current}`);
    } +
    +
    +
    +

    Parameters

    +
      +
    • +
      mount: string
      +

      The service's mount point, relative to the database.

      +
    • +
    • +
      Optional minimal: false
      +

      If set to true, the result will only include each +configuration option's current value. Otherwise it will include the full +definition for each option.

      +
    +

    Returns Promise<Record<string, ServiceConfiguration>>

  • + +
  • +

    Retrieves information about the service's configuration options and their +current values.

    +

    See also replaceServiceConfiguration and +updateServiceConfiguration.

    + +

    Example

    const db = new Database();
    const config = await db.getServiceConfiguration("/my-service", true);
    for (const [key, value] of Object.entries(config)) {
    console.log(`${key}: ${value}`);
    } +
    +
    +
    +

    Parameters

    +
      +
    • +
      mount: string
      +

      The service's mount point, relative to the database.

      +
    • +
    • +
      minimal: true
      +

      If set to true, the result will only include each +configuration option's current value. Otherwise it will include the full +definition for each option.

      +
    +

    Returns Promise<Record<string, any>>

+
+ +
    + +
  • +

    Retrieves information about the service's dependencies and their current +mount points.

    +

    See also replaceServiceDependencies and +updateServiceDependencies.

    + +

    Example

    const db = new Database();
    const deps = await db.getServiceDependencies("/my-service");
    for (const [key, dep] of Object.entries(deps)) {
    console.log(`${dep.title} (${key}): ${dep.current}`);
    } +
    +
    +
    +

    Parameters

    +
      +
    • +
      mount: string
      +

      The service's mount point, relative to the database.

      +
    • +
    • +
      Optional minimal: false
      +

      If set to true, the result will only include each +dependency's current mount point. Otherwise it will include the full +definition for each dependency.

      +
    +

    Returns Promise<Record<string, SingleServiceDependency | MultiServiceDependency>>

  • + +
  • +

    Retrieves information about the service's dependencies and their current +mount points.

    +

    See also replaceServiceDependencies and +updateServiceDependencies.

    + +

    Example

    const db = new Database();
    const deps = await db.getServiceDependencies("/my-service", true);
    for (const [key, value] of Object.entries(deps)) {
    console.log(`${key}: ${value}`);
    } +
    +
    +
    +

    Parameters

    +
      +
    • +
      mount: string
      +

      The service's mount point, relative to the database.

      +
    • +
    • +
      minimal: true
      +

      If set to true, the result will only include each +dependency's current mount point. Otherwise it will include the full +definition for each dependency.

      +
    +

    Returns Promise<Record<string, string | string[]>>

+
+ +
    + +
  • +

    Retrieves an Open API compatible Swagger API description object for the +service installed at the given mount point.

    + +

    Example

    const db = new Database();
    const spec = await db.getServiceDocumentation("/my-service");
    // spec is a Swagger API description of the service +
    +
    +
    +

    Parameters

    +
      +
    • +
      mount: string
      +

      The service's mount point, relative to the database.

      +
    +

    Returns Promise<SwaggerJson>

+
+ +
    + +
  • +

    Retrieves the text content of the service's README or README.md file.

    +

    Returns undefined if no such file could be found.

    + +

    Example

    const db = new Database();
    const readme = await db.getServiceReadme("/my-service");
    if (readme !== undefined) console.log(readme);
    else console.warn(`No README found.`) +
    +
    +
    +

    Parameters

    +
      +
    • +
      mount: string
      +

      The service's mount point, relative to the database.

      +
    +

    Returns Promise<undefined | string>

+
+ +
    + +
  • +

    Fetches the user data of a single ArangoDB user.

    + +

    Example

    const db = new Database();
    const user = await db.getUser("steve");
    // user is the user object for the user named "steve" +
    +
    +
    +

    Parameters

    +
      +
    • +
      username: string
      +

      Name of the ArangoDB user to fetch.

      +
    +

    Returns Promise<ArangoApiResponse<ArangoUser>>

+
+ +
    + +
  • +

    Fetches the given ArangoDB user's access level for the database, or the +given collection in the given database.

    + +

    Example

    const db = new Database();
    const accessLevel = await db.getUserAccessLevel("steve");
    // The access level of the user "steve" has been fetched for the current
    // database. +
    + +

    Example

    const db = new Database();
    const accessLevel = await db.getUserAccessLevel("steve", {
    database: "staging"
    });
    // The access level of the user "steve" has been fetched for the "staging"
    // database. +
    + +

    Example

    const db = new Database();
    const accessLevel = await db.getUserAccessLevel("steve", {
    collection: "pokemons"
    });
    // The access level of the user "steve" has been fetched for the
    // "pokemons" collection in the current database. +
    + +

    Example

    const db = new Database();
    const accessLevel = await db.getUserAccessLevel("steve", {
    database: "staging",
    collection: "pokemons"
    });
    // The access level of the user "steve" has been fetched for the
    // "pokemons" collection in the "staging" database. +
    + +

    Example

    const db = new Database();
    const staging = db.database("staging");
    const accessLevel = await db.getUserAccessLevel("steve", {
    database: staging
    });
    // The access level of the user "steve" has been fetched for the "staging"
    // database. +
    + +

    Example

    const db = new Database();
    const staging = db.database("staging");
    const accessLevel = await db.getUserAccessLevel("steve", {
    collection: staging.collection("pokemons")
    });
    // The access level of the user "steve" has been fetched for the
    // "pokemons" collection in database "staging". +
    +
    +
    +

    Parameters

    +
      +
    • +
      username: string
      +

      Name of the ArangoDB user to fetch the access level for.

      +
    • +
    • +
      __namedParameters: UserAccessLevelOptions
    +

    Returns Promise<AccessLevel>

+
+ +
    + +
  • +

    Fetches an object mapping names of databases to the access level of the +given ArangoDB user for those databases.

    + +

    Example

    const db = new Database();
    const accessLevels = await db.getUserDatabases("steve");
    for (const [databaseName, accessLevel] of Object.entries(accessLevels)) {
    console.log(`${databaseName}: ${accessLevel}`);
    } +
    +
    +
    +

    Parameters

    +
      +
    • +
      username: string
      +

      Name of the ArangoDB user to fetch the access levels for.

      +
    • +
    • +
      Optional full: false
      +

      Whether access levels for collections should be included.

      +
    +

    Returns Promise<Record<string, AccessLevel>>

  • + +
  • +

    Fetches an object mapping names of databases to the access level of the +given ArangoDB user for those databases and the collections within each +database.

    + +

    Example

    const db = new Database();
    const accessLevels = await db.getUserDatabases("steve", true);
    for (const [databaseName, obj] of Object.entries(accessLevels)) {
    console.log(`${databaseName}: ${obj.permission}`);
    for (const [collectionName, accessLevel] of Object.entries(obj.collections)) {
    console.log(`${databaseName}/${collectionName}: ${accessLevel}`);
    }
    } +
    +
    +
    +

    Parameters

    +
      +
    • +
      username: string
      +

      Name of the ArangoDB user to fetch the access levels for.

      +
    • +
    • +
      full: true
      +

      Whether access levels for collections should be included.

      +
    +

    Returns Promise<Record<string, {
        collections: Record<string, "undefined" | AccessLevel>;
        permission: AccessLevel;
    }>>

+
+ +
    + +
  • +

    Returns a Graph instance representing the graph with the given +graphName.

    + +

    Example

    const db = new Database();
    const graph = db.graph("some-graph"); +
    +
    +
    +

    Parameters

    +
      +
    • +
      graphName: string
      +

      Name of the graph.

      +
    +

    Returns Graph

+
+ +
    + +
  • +

    Fetches all graphs from the database and returns an array of Graph +instances for those graphs.

    +

    See also listGraphs.

    + +

    Example

    const db = new Database();
    const graphs = await db.graphs();
    // graphs is an array of Graph instances +
    +
    +

    Returns Promise<Graph[]>

+
+ +
    + +
  • +

    Installs a new service.

    + +

    Example

    const db = new Database();
    // Using a node.js file stream as source
    const source = fs.createReadStream("./my-foxx-service.zip");
    const info = await db.installService("/hello", source); +
    + +

    Example

    const db = new Database();
    // Using a node.js Buffer as source
    const source = fs.readFileSync("./my-foxx-service.zip");
    const info = await db.installService("/hello", source); +
    + +

    Example

    const db = new Database();
    // Using a File (Blob) from a browser file input
    const element = document.getElementById("my-file-input");
    const source = element.files[0];
    const info = await db.installService("/hello", source); +
    +
    +
    +

    Parameters

    +
      +
    • +
      mount: string
      +

      The service's mount point, relative to the database.

      +
    • +
    • +
      source: string | Readable | Blob | Buffer
      +

      The service bundle to install.

      +
    • +
    • +
      options: InstallServiceOptions = {}
      +

      Options for installing the service.

      +
    +

    Returns Promise<ServiceInfo>

+
+ +
    + +
  • +

    Returns a Job instance for the given jobId.

    + +

    Example

    const db = new Database();
    const job = db.job("12345"); +
    +
    +
    +

    Parameters

    +
      +
    • +
      jobId: string
      +

      ID of the async job.

      +
    +

    Returns Job<any>

+
+ +
    + +
  • +

    Kills a running query with the given queryId.

    +

    See also listRunningQueries.

    + +

    Example

    const db = new Database();
    const queries = await db.listRunningQueries();
    await Promise.all(queries.map(
    async (query) => {
    if (query.state === "executing") {
    await db.killQuery(query.id);
    }
    }
    )); +
    +
    +
    +

    Parameters

    +
      +
    • +
      queryId: string
      +

      The ID of a currently running query.

      +
    +

    Returns Promise<void>

+
+ +
    + +
  • +

    Fetches all Analyzers visible in the database and returns an array of +Analyzer descriptions.

    +

    See also analyzers.

    + +

    Example

    const db = new Database();
    const analyzers = await db.listAnalyzers();
    // analyzers is an array of Analyzer descriptions +
    +
    +

    Returns Promise<AnalyzerDescription[]>

+
+ +
    + +
  • +

    Fetches all collections from the database and returns an array of +collection descriptions.

    +

    See also collections.

    + +

    Example

    const db = new Database();
    const collections = await db.listCollections();
    // collections is an array of collection descriptions
    // not including system collections +
    + +

    Example

    const db = new Database();
    const collections = await db.listCollections(false);
    // collections is an array of collection descriptions
    // including system collections +
    +
    +
    +

    Parameters

    +
      +
    • +
      excludeSystem: boolean = true
      +

      Whether system collections should be excluded.

      +
    +

    Returns Promise<CollectionMetadata[]>

+
+ +
    + +
  • +

    Returns a list of the IDs of all currently available completed async jobs.

    + +

    Example

    const db = new Database();
    const completedJobs = await db.listCompletedJobs();
    console.log(completedJobs); // e.g. ["12345", "67890"] +
    +
    +

    Returns Promise<string[]>

+
+ +
    + +
  • +

    Fetches all databases from the server and returns an array of their names.

    +

    See also databases and +listUserDatabases.

    + +

    Example

    const db = new Database();
    const names = await db.listDatabases();
    // databases is an array of database names +
    +
    +

    Returns Promise<string[]>

+
+ +
    + +
  • +

    Fetches a list of all AQL user functions registered with the database.

    + +

    Example

    const db = new Database();
    const functions = await db.listFunctions();
    const names = functions.map(fn => fn.name); +
    +
    +

    Returns Promise<AqlUserFunction[]>

+
+ +
    + +
  • +

    Fetches all graphs from the database and returns an array of graph +descriptions.

    +

    See also graphs.

    + +

    Example

    const db = new Database();
    const graphs = await db.listGraphs();
    // graphs is an array of graph descriptions +
    +
    +

    Returns Promise<GraphInfo[]>

+
+ +
    + +
  • +

    (Enterprise Edition only.) Retrieves a list of all locally found hot +backups.

    + +

    Example

    const backups = await db.listHotBackups();
    for (const backup of backups) {
    console.log(backup.id);
    } +
    +
    +
    +

    Parameters

    +
      +
    • +
      Optional id: string | string[]
      +

      If specified, only the backup with the given ID will be +returned.

      +
    +

    Returns Promise<HotBackupList>

+
+ +
    + +
  • +

    Returns a list of the IDs of all currently pending async jobs.

    + +

    Example

    const db = new Database();
    const pendingJobs = await db.listPendingJobs();
    console.log(pendingJobs); // e.g. ["12345", "67890"] +
    +
    +

    Returns Promise<string[]>

+
+ +
    + +
  • +

    Fetches a list of information for all currently running queries.

    +

    See also listSlowQueries and killQuery.

    + +

    Example

    const db = new Database();
    const queries = await db.listRunningQueries(); +
    +
    +

    Returns Promise<QueryInfo[]>

+
+ +
    + +
  • +

    Retrieves a list of scripts defined in the service manifest's "scripts" +section mapped to their human readable representations.

    + +

    Example

    const db = new Database();
    const scripts = await db.listServiceScripts("/my-service");
    for (const [name, title] of Object.entries(scripts)) {
    console.log(`${name}: ${title}`);
    } +
    +
    +
    +

    Parameters

    +
      +
    • +
      mount: string
      +

      The service's mount point, relative to the database.

      +
    +

    Returns Promise<Record<string, string>>

+
+ +
    + +
  • +

    Fetches a list of all installed service.

    + +

    Example

    const db = new Database();
    const services = await db.listServices(); +
    + +

    Example

    const db = new Database();
    const services = await db.listServices(false); // all services +
    +
    +
    +

    Parameters

    +
      +
    • +
      excludeSystem: boolean = true
      +

      Whether system services should be excluded.

      +
    +

    Returns Promise<ServiceSummary[]>

+
+ +
    + +
  • +

    Fetches a list of information for all recent slow queries.

    +

    See also listRunningQueries and +clearSlowQueries.

    + +

    Example

    const db = new Database();
    const queries = await db.listSlowQueries();
    // Only works if slow query tracking is enabled +
    +
    +

    Returns Promise<QueryInfo[]>

+
+ +
    + +
  • +

    Fetches all active transactions from the database and returns an array of +transaction descriptions.

    +

    See also transactions.

    + +

    Example

    const db = new Database();
    const transactions = await db.listTransactions();
    // transactions is an array of transaction descriptions +
    +
    +

    Returns Promise<TransactionDetails[]>

+
+ +
    + +
  • +

    Fetches all databases accessible to the active user from the server and +returns an array of their names.

    +

    See also userDatabases and +listDatabases.

    + +

    Example

    const db = new Database();
    const names = await db.listUserDatabases();
    // databases is an array of database names +
    +
    +

    Returns Promise<string[]>

+
+ +
    + +
  • +

    Fetches all ArangoDB users visible to the authenticated user and returns +an array of user objects.

    + +

    Example

    const db = new Database();
    const users = await db.listUsers();
    // users is an array of user objects +
    +
    +

    Returns Promise<ArangoUser[]>

+
+ +
    + +
  • +

    Fetches all Views from the database and returns an array of View +descriptions.

    +

    See also views.

    + +

    Example

    const db = new Database();

    const views = await db.listViews();
    // views is an array of View descriptions +
    +
    +

    Returns Promise<ViewDescription[]>

+
+ +
    + +
  • +

    Validates the given database credentials and exchanges them for an +authentication token, then uses the authentication token for future +requests and returns it.

    + +

    Example

    const db = new Database();
    await db.login("admin", "hunter2");
    // with an authentication token for the "admin" user. +
    +
    +
    +

    Parameters

    +
      +
    • +
      username: string = "root"
      +

      The username to authenticate with.

      +
    • +
    • +
      password: string = ""
      +

      The password to authenticate with.

      +
    +

    Returns Promise<string>

+
+ +
    + +
  • +

    Parses the given query and returns the result.

    +

    See the aql template string handler for information about how +to create a query string without manually defining bind parameters nor +having to worry about escaping variables.

    + +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    const ast = await db.parse(aql`
    FOR doc IN ${collection}
    FILTER doc.flavor == "strawberry"
    RETURN doc._key
    `); +
    +
    +
    +

    Parameters

    +
      +
    • +
      query: string | AqlLiteral | AqlQuery<any>
      +

      An AQL query string or an object containing an AQL query +string and bind parameters, e.g. the object returned from an aql +template string.

      +
    +

    Returns Promise<ParseResult>

+
+ +
    + +
  • +

    Performs a database query using the given query, then returns a new +ArrayCursor instance for the result set.

    +

    See the aql template string handler for information about how +to create a query string without manually defining bind parameters nor +having to worry about escaping variables.

    +

    Note: When executing a query in a streaming transaction using the +step method, the resulting cursor will be bound to that transaction and +you do not need to use the step method to consume it.

    + +

    Example

    const db = new Database();
    const active = true;
    const Users = db.collection("_users");

    // Using an aql template string:
    // Bind parameters are automatically extracted and arangojs collections
    // are automatically passed as collection bind parameters.
    const cursor = await db.query(aql`
    FOR u IN ${Users}
    FILTER u.authData.active == ${active}
    RETURN u.user
    `);
    // cursor is a cursor for the query result +
    + +

    Example

    const db = new Database();
    const active = true;
    const Users = db.collection("_users");

    // Using an object with a regular multi-line string
    const cursor = await db.query({
    query: `
    FOR u IN @@users
    FILTER u.authData.active == @active
    RETURN u.user
    `,
    bindVars: { active: active, "@users": Users.name }
    }); +
    +
    +
    +

    Type Parameters

    +
      +
    • +

      T = any

    +
    +

    Parameters

    +
      +
    • +
      query: AqlQuery<T>
      +

      An object containing an AQL query string and bind +parameters, e.g. the object returned from an aql template string.

      +
    • +
    • +
      Optional options: QueryOptions
      +

      Options for the query execution.

      +
    +

    Returns Promise<ArrayCursor<T>>

  • + +
  • +

    Performs a database query using the given query and bindVars, then +returns a new ArrayCursor instance for the result set.

    +

    See the aql template string handler for a safer and easier +alternative to passing strings directly.

    +

    Note: When executing a query in a streaming transaction using the +step method, the resulting cursor will be bound to that transaction and +you do not need to use the step method to consume it.

    + +

    Example

    const db = new Database();
    const active = true;
    const Users = db.collection("_users");

    const cursor = await db.query(
    // A normal multi-line string
    `
    FOR u IN @@users
    FILTER u.authData.active == @active
    RETURN u.user
    `,
    { active: active, "@users": Users.name }
    ); +
    + +

    Example

    const db = new Database();
    const active = true;
    const Users = db.collection("_users");

    const cursor = await db.query(
    // An AQL literal created from a normal multi-line string
    aql.literal(`
    FOR u IN @@users
    FILTER u.authData.active == @active
    RETURN u.user
    `),
    { active: active, "@users": Users.name }
    ); +
    +
    +
    +

    Type Parameters

    +
      +
    • +

      T = any

    +
    +

    Parameters

    +
      +
    • +
      query: string | AqlLiteral
      +

      An AQL query string.

      +
    • +
    • +
      Optional bindVars: Record<string, any>
      +

      An object defining bind parameters for the query.

      +
    • +
    • +
      Optional options: QueryOptions
      +

      Options for the query execution.

      +
    +

    Returns Promise<ArrayCursor<T>>

+
+ +
    + +
  • +

    Fetches the available optimizer rules.

    + +

    Example

    const db = new Database();
    const rules = await db.queryRules();
    for (const rule of rules) {
    console.log(rule.name);
    } +
    +
    +

    Returns Promise<QueryOptimizerRule[]>

+
+ +
    + +
  • +

    Fetches the query tracking properties.

    + +

    Example

    const db = new Database();
    const tracking = await db.queryTracking();
    console.log(tracking.enabled); +
    +
    +

    Returns Promise<QueryTracking>

  • + +
  • +

    Modifies the query tracking properties.

    + +

    Example

    const db = new Database();
    // track up to 5 slow queries exceeding 5 seconds execution time
    await db.setQueryTracking({
    enabled: true,
    trackSlowQueries: true,
    maxSlowQueries: 5,
    slowQueryThreshold: 5
    }); +
    +
    +
    +

    Parameters

    +
    +

    Returns Promise<QueryTracking>

+
+ +
+
+ +
    + +
  • +

    Removes the ArangoDB user with the given username from the server.

    + +

    Example

    const db = new Database();
    await db.removeUser("steve");
    // The user "steve" has been removed +
    +
    +
    +

    Parameters

    +
      +
    • +
      username: string
      +

      Name of the ArangoDB user to remove.

      +
    +

    Returns Promise<ArangoApiResponse<Record<string, never>>>

+
+ +
    + +
  • +

    Renames the collection collectionName to newName.

    +

    Additionally removes any stored Collection instance for +collectionName from the Database instance's internal cache.

    +

    Note: Renaming collections may not be supported when ArangoDB is +running in a cluster configuration.

    +
    +
    +

    Parameters

    +
      +
    • +
      collectionName: string
      +

      Current name of the collection.

      +
    • +
    • +
      newName: string
      +

      The new name of the collection.

      +
    +

    Returns Promise<ArangoApiResponse<CollectionMetadata>>

+
+ +
    + +
  • +

    Renames the view viewName to newName.

    +

    Additionally removes any stored View instance for viewName from +the Database instance's internal cache.

    +

    Note: Renaming views may not be supported when ArangoDB is running in +a cluster configuration.

    +
    +
    +

    Parameters

    +
      +
    • +
      viewName: string
      +

      Current name of the view.

      +
    • +
    • +
      newName: string
      +

      The new name of the view.

      +
    +

    Returns Promise<ArangoApiResponse<ViewDescription>>

+
+ +
    + +
  • +

    Attempts to renew the authentication token passed to useBearerAuth +or returned and used by login. If a new authentication +token is issued, it will be used for future requests and returned.

    + +

    Example

    const db = new Database();
    await db.login("admin", "hunter2");
    // ... later ...
    const newToken = await db.renewAuthToken();
    if (!newToken) // no new token issued +
    +
    +

    Returns Promise<null | string>

+
+ +
    + +
  • +

    Replaces an existing service with a new service by completely removing the +old service and installing a new service at the same mount point.

    + +

    Example

    const db = new Database();
    // Using a node.js file stream as source
    const source = fs.createReadStream("./my-foxx-service.zip");
    const info = await db.replaceService("/hello", source); +
    + +

    Example

    const db = new Database();
    // Using a node.js Buffer as source
    const source = fs.readFileSync("./my-foxx-service.zip");
    const info = await db.replaceService("/hello", source); +
    + +

    Example

    const db = new Database();
    // Using a File (Blob) from a browser file input
    const element = document.getElementById("my-file-input");
    const source = element.files[0];
    const info = await db.replaceService("/hello", source); +
    +
    +
    +

    Parameters

    +
      +
    • +
      mount: string
      +

      The service's mount point, relative to the database.

      +
    • +
    • +
      source: string | Readable | Blob | Buffer
      +

      The service bundle to install.

      +
    • +
    • +
      options: ReplaceServiceOptions = {}
      +

      Options for replacing the service.

      +
    +

    Returns Promise<ServiceInfo>

+
+ +
    + +
  • +

    Replaces the configuration of the given service, discarding any existing +values for options not specified.

    +

    See also updateServiceConfiguration and +getServiceConfiguration.

    + +

    Example

    const db = new Database();
    const config = { currency: "USD", locale: "en-US" };
    const info = await db.replaceServiceConfiguration("/my-service", config);
    for (const [key, option] of Object.entries(info)) {
    console.log(`${option.title} (${key}): ${option.value}`);
    if (option.warning) console.warn(`Warning: ${option.warning}`);
    } +
    +
    +
    +

    Parameters

    +
      +
    • +
      mount: string
      +

      The service's mount point, relative to the database.

      +
    • +
    • +
      cfg: Record<string, any>
      +

      An object mapping configuration option names to values.

      +
    • +
    • +
      Optional minimal: false
      +

      If set to true, the result will only include each +configuration option's current value and warning (if any). +Otherwise it will include the full definition for each option.

      +
    +

    Returns Promise<Record<string, ServiceConfiguration & {
        warning?: string;
    }>>

  • + +
  • +

    Replaces the configuration of the given service, discarding any existing +values for options not specified.

    +

    See also updateServiceConfiguration and +getServiceConfiguration.

    + +

    Example

    const db = new Database();
    const config = { currency: "USD", locale: "en-US" };
    const info = await db.replaceServiceConfiguration("/my-service", config);
    for (const [key, value] of Object.entries(info.values)) {
    console.log(`${key}: ${value}`);
    if (info.warnings[key]) console.warn(`Warning: ${info.warnings[key]}`);
    } +
    +
    +
    +

    Parameters

    +
      +
    • +
      mount: string
      +

      The service's mount point, relative to the database.

      +
    • +
    • +
      cfg: Record<string, any>
      +

      An object mapping configuration option names to values.

      +
    • +
    • +
      minimal: true
      +

      If set to true, the result will only include each +configuration option's current value and warning (if any). +Otherwise it will include the full definition for each option.

      +
    +

    Returns Promise<{
        values: Record<string, any>;
        warnings: Record<string, string>;
    }>

+
+ +
    + +
  • +

    Replaces the dependencies of the given service, discarding any existing +mount points for dependencies not specified.

    +

    See also updateServiceDependencies and +getServiceDependencies.

    + +

    Example

    const db = new Database();
    const deps = { mailer: "/mailer-api", auth: "/remote-auth" };
    const info = await db.replaceServiceDependencies("/my-service", deps);
    for (const [key, dep] of Object.entries(info)) {
    console.log(`${dep.title} (${key}): ${dep.current}`);
    if (dep.warning) console.warn(`Warning: ${dep.warning}`);
    } +
    +
    +
    +

    Parameters

    +
      +
    • +
      mount: string
      +

      The service's mount point, relative to the database.

      +
    • +
    • +
      deps: Record<string, string>
    • +
    • +
      Optional minimal: false
      +

      If set to true, the result will only include each +dependency's current mount point. Otherwise it will include the full +definition for each dependency.

      +
    +

    Returns Promise<Record<string, Object>>

  • + +
  • +

    Replaces the dependencies of the given service, discarding any existing +mount points for dependencies not specified.

    +

    See also updateServiceDependencies and +getServiceDependencies.

    + +

    Example

    const db = new Database();
    const deps = { mailer: "/mailer-api", auth: "/remote-auth" };
    const info = await db.replaceServiceDependencies(
    "/my-service",
    deps,
    true
    );
    for (const [key, value] of Object.entries(info)) {
    console.log(`${key}: ${value}`);
    if (info.warnings[key]) console.warn(`Warning: ${info.warnings[key]}`);
    } +
    +
    +
    +

    Parameters

    +
      +
    • +
      mount: string
      +

      The service's mount point, relative to the database.

      +
    • +
    • +
      deps: Record<string, string>
    • +
    • +
      minimal: true
      +

      If set to true, the result will only include each +dependency's current mount point. Otherwise it will include the full +definition for each dependency.

      +
    +

    Returns Promise<{
        values: Record<string, string>;
        warnings: Record<string, string>;
    }>

+
+ +
    + +
  • +

    Replaces the ArangoDB user's option with the new options.

    + +

    Example

    const db = new Database();
    const user = await db.replaceUser("steve", { passwd: "", active: false });
    // The user "steve" has been set to inactive with an empty password +
    +
    +
    +

    Parameters

    +
      +
    • +
      username: string
      +

      Name of the ArangoDB user to modify.

      +
    • +
    • +
      options: UserOptions
      +

      New options to replace the user's existing options.

      +
    +

    Returns Promise<ArangoApiResponse<ArangoUser>>

+
+ +
    + +
  • +

    (Enteprise Edition only.) Restores a consistent local hot backup.

    +

    Returns the directory path of the restored backup.

    + +

    Example

    await db.restoreHotBackup("2023-09-19T15.38.21Z_example");
    // the backup has been restored +
    +
    +
    +

    Parameters

    +
      +
    • +
      id: string
      +

      The ID of the backup to restore.

      +
    +

    Returns Promise<string>

+
+ +
    + +
  • +

    Returns a new Route instance for the given path (relative to the +database) that can be used to perform arbitrary HTTP requests.

    + +

    Example

    const db = new Database();
    const myFoxxService = db.route("my-foxx-service");
    const response = await myFoxxService.post("users", {
    username: "admin",
    password: "hunter2"
    });
    // response.body is the result of
    // POST /_db/_system/my-foxx-service/users
    // with JSON request body '{"username": "admin", "password": "hunter2"}' +
    +
    +
    +

    Parameters

    +
      +
    • +
      Optional path: string
      +

      The database-relative URL of the route. Defaults to the +database API root.

      +
    • +
    • +
      Optional headers: Headers
      +

      Default headers that should be sent with each request to +the route.

      +
    +

    Returns Route

+
+ +
    + +
  • +

    Executes a service script and retrieves its result exposed as +module.exports (if any).

    + +

    Example

    const db = new Database();
    const result = await db.runServiceScript(
    "/my-service",
    "create-user",
    {
    username: "service_admin",
    password: "hunter2"
    }
    ); +
    +
    +
    +

    Parameters

    +
      +
    • +
      mount: string
      +

      The service's mount point, relative to the database.

      +
    • +
    • +
      name: string
      +

      Name of the service script to execute as defined in the +service manifest.

      +
    • +
    • +
      Optional params: any
      +

      Arbitrary value that will be exposed to the script as +argv[0] in the service context (e.g. module.context.argv[0]). +Must be serializable to JSON.

      +
    +

    Returns Promise<any>

+
+ +
    + +
  • +

    Runs the tests of a given service and returns the results using the +"default" reporter.

    + +

    Example

    const db = new Database();
    const testReport = await db.runServiceTests("/my-foxx"); +
    +
    +
    +

    Parameters

    +
      +
    • +
      mount: string
      +

      The service's mount point, relative to the database.

      +
    • +
    • +
      Optional options: {
          filter?: string;
          idiomatic?: false;
          reporter?: "default";
      }
      +

      Options for running the tests.

      +
      +
        +
      • +
        Optional filter?: string
        +

        If set, only tests with full names including this exact string will be +executed.

        +
      • +
      • +
        Optional idiomatic?: false
        +

        Whether the reporter should use "idiomatic" mode. Has no effect when +using the "default" or "suite" reporters.

        +
      • +
      • +
        Optional reporter?: "default"
    +

    Returns Promise<ServiceTestDefaultReport>

  • + +
  • +

    Runs the tests of a given service and returns the results using the +"suite" reporter, which groups the test result by test suite.

    + +

    Example

    const db = new Database();
    const suiteReport = await db.runServiceTests(
    "/my-foxx",
    { reporter: "suite" }
    ); +
    +
    +
    +

    Parameters

    +
      +
    • +
      mount: string
      +

      The service's mount point, relative to the database.

      +
    • +
    • +
      options: {
          filter?: string;
          idiomatic?: false;
          reporter: "suite";
      }
      +

      Options for running the tests.

      +
      +
        +
      • +
        Optional filter?: string
        +

        If set, only tests with full names including this exact string will be +executed.

        +
      • +
      • +
        Optional idiomatic?: false
        +

        Whether the reporter should use "idiomatic" mode. Has no effect when +using the "default" or "suite" reporters.

        +
      • +
      • +
        reporter: "suite"
    +

    Returns Promise<ServiceTestSuiteReport>

  • + +
  • +

    Runs the tests of a given service and returns the results using the +"stream" reporter, which represents the results as a sequence of tuples +representing events.

    + +

    Example

    const db = new Database();
    const streamEvents = await db.runServiceTests(
    "/my-foxx",
    { reporter: "stream" }
    ); +
    +
    +
    +

    Parameters

    +
      +
    • +
      mount: string
      +

      The service's mount point, relative to the database.

      +
    • +
    • +
      options: {
          filter?: string;
          idiomatic?: false;
          reporter: "stream";
      }
      +

      Options for running the tests.

      +
      +
        +
      • +
        Optional filter?: string
        +

        If set, only tests with full names including this exact string will be +executed.

        +
      • +
      • +
        Optional idiomatic?: false
        +

        Whether the reporter should use "idiomatic" mode. If set to true, +the results will be returned as a formatted string.

        +
      • +
      • +
        reporter: "stream"
    +

    Returns Promise<ServiceTestStreamReport>

  • + +
  • +

    Runs the tests of a given service and returns the results using the +"tap" reporter, which represents the results as an array of strings using +the "tap" format.

    + +

    Example

    const db = new Database();
    const tapLines = await db.runServiceTests(
    "/my-foxx",
    { reporter: "tap" }
    ); +
    +
    +
    +

    Parameters

    +
      +
    • +
      mount: string
      +

      The service's mount point, relative to the database.

      +
    • +
    • +
      options: {
          filter?: string;
          idiomatic?: false;
          reporter: "tap";
      }
      +

      Options for running the tests.

      +
      +
        +
      • +
        Optional filter?: string
        +

        If set, only tests with full names including this exact string will be +executed.

        +
      • +
      • +
        Optional idiomatic?: false
        +

        Whether the reporter should use "idiomatic" mode. If set to true, +the results will be returned as a formatted string.

        +
      • +
      • +
        reporter: "tap"
    +

    Returns Promise<ServiceTestTapReport>

  • + +
  • +

    Runs the tests of a given service and returns the results using the +"xunit" reporter, which represents the results as an XML document using +the JSONML exchange format.

    + +

    Example

    const db = new Database();
    const jsonML = await db.runServiceTests(
    "/my-foxx",
    { reporter: "xunit" }
    ); +
    +
    +
    +

    Parameters

    +
      +
    • +
      mount: string
      +

      The service's mount point, relative to the database.

      +
    • +
    • +
      options: {
          filter?: string;
          idiomatic?: false;
          reporter: "xunit";
      }
      +

      Options for running the tests.

      +
      +
        +
      • +
        Optional filter?: string
        +

        If set, only tests with full names including this exact string will be +executed.

        +
      • +
      • +
        Optional idiomatic?: false
        +

        Whether the reporter should use "idiomatic" mode. If set to true, +the results will be returned as a formatted string.

        +
      • +
      • +
        reporter: "xunit"
    +

    Returns Promise<ServiceTestXunitReport>

  • + +
  • +

    Runs the tests of a given service and returns the results as a string +using the "stream" reporter in "idiomatic" mode, which represents the +results as a line-delimited JSON stream of tuples representing events.

    + +

    Example

    const db = new Database();
    const streamReport = await db.runServiceTests(
    "/my-foxx",
    { reporter: "stream", idiomatic: true }
    ); +
    +
    +
    +

    Parameters

    +
      +
    • +
      mount: string
      +

      The service's mount point, relative to the database.

      +
    • +
    • +
      options: {
          filter?: string;
          idiomatic: true;
          reporter: "stream";
      }
      +

      Options for running the tests.

      +
      +
        +
      • +
        Optional filter?: string
        +

        If set, only tests with full names including this exact string will be +executed.

        +
      • +
      • +
        idiomatic: true
        +

        Whether the reporter should use "idiomatic" mode. If set to false, +the results will be returned as an array of tuples instead of a +string.

        +
      • +
      • +
        reporter: "stream"
    +

    Returns Promise<string>

  • + +
  • +

    Runs the tests of a given service and returns the results as a string +using the "tap" reporter in "idiomatic" mode, which represents the +results using the "tap" format.

    + +

    Example

    const db = new Database();
    const tapReport = await db.runServiceTests(
    "/my-foxx",
    { reporter: "tap", idiomatic: true }
    ); +
    +
    +
    +

    Parameters

    +
      +
    • +
      mount: string
      +

      The service's mount point, relative to the database.

      +
    • +
    • +
      options: {
          filter?: string;
          idiomatic: true;
          reporter: "tap";
      }
      +

      Options for running the tests.

      +
      +
        +
      • +
        Optional filter?: string
        +

        If set, only tests with full names including this exact string will be +executed.

        +
      • +
      • +
        idiomatic: true
        +

        Whether the reporter should use "idiomatic" mode. If set to false, +the results will be returned as an array of strings instead of a +single string.

        +
      • +
      • +
        reporter: "tap"
    +

    Returns Promise<string>

  • + +
  • +

    Runs the tests of a given service and returns the results as a string +using the "xunit" reporter in "idiomatic" mode, which represents the +results as an XML document.

    + +

    Example

    const db = new Database();
    const xml = await db.runServiceTests(
    "/my-foxx",
    { reporter: "xunit", idiomatic: true }
    ); +
    +
    +
    +

    Parameters

    +
      +
    • +
      mount: string
      +

      The service's mount point, relative to the database.

      +
    • +
    • +
      options: {
          filter?: string;
          idiomatic: true;
          reporter: "xunit";
      }
      +

      Options for running the tests.

      +
      +
        +
      • +
        Optional filter?: string
        +

        If set, only tests with full names including this exact string will be +executed.

        +
      • +
      • +
        idiomatic: true
        +

        Whether the reporter should use "idiomatic" mode. If set to false, +the results will be returned using the JSONML exchange format +instead of a string.

        +
      • +
      • +
        reporter: "xunit"
    +

    Returns Promise<string>

+
+ +
    + +
  • +

    Sets the server's log level for each of the given topics to the given level.

    +

    Any omitted topics will be left unchanged.

    + +

    Example

    await db.setLogLevel({ request: "debug" });
    // Debug information will now be logged for each request +
    +
    +
    +

    Parameters

    +
      +
    • +
      levels: Record<string, LogLevelSetting>
      +

      An object mapping topic names to log levels.

      +
    +

    Returns Promise<Record<string, LogLevelSetting>>

+
+ +
    + +
  • +

    Sets the limit for the number of values of the most recently received +server-reported queue times that can be accessed using +queueTime.

    +
    +
    +

    Parameters

    +
      +
    • +
      responseQueueTimeSamples: number
      +

      Number of values to maintain.

      +
    +

    Returns void

+
+ +
    + +
  • +

    Enables or disables development mode for the given service.

    + +

    Example

    const db = new Database();
    await db.setServiceDevelopmentMode("/my-service", true);
    // the service is now in development mode
    await db.setServiceDevelopmentMode("/my-service", false);
    // the service is now in production mode +
    +
    +
    +

    Parameters

    +
      +
    • +
      mount: string
      +

      The service's mount point, relative to the database.

      +
    • +
    • +
      enabled: boolean = true
      +

      Whether development mode should be enabled or disabled.

      +
    +

    Returns Promise<ServiceInfo>

+
+ +
    + +
  • +

    Sets the given ArangoDB user's access level for the database, or the +given collection in the given database.

    + +

    Example

    const db = new Database();
    await db.setUserAccessLevel("steve", { grant: "rw" });
    // The user "steve" now has read-write access to the current database. +
    + +

    Example

    const db = new Database();
    await db.setUserAccessLevel("steve", {
    database: "staging",
    grant: "rw"
    });
    // The user "steve" now has read-write access to the "staging" database. +
    + +

    Example

    const db = new Database();
    await db.setUserAccessLevel("steve", {
    collection: "pokemons",
    grant: "rw"
    });
    // The user "steve" now has read-write access to the "pokemons" collection
    // in the current database. +
    + +

    Example

    const db = new Database();
    await db.setUserAccessLevel("steve", {
    database: "staging",
    collection: "pokemons",
    grant: "rw"
    });
    // The user "steve" now has read-write access to the "pokemons" collection
    // in the "staging" database. +
    + +

    Example

    const db = new Database();
    const staging = db.database("staging");
    await db.setUserAccessLevel("steve", {
    database: staging,
    grant: "rw"
    });
    // The user "steve" now has read-write access to the "staging" database. +
    + +

    Example

    const db = new Database();
    const staging = db.database("staging");
    await db.setUserAccessLevel("steve", {
    collection: staging.collection("pokemons"),
    grant: "rw"
    });
    // The user "steve" now has read-write access to the "pokemons" collection
    // in database "staging". +
    +
    +
    +

    Parameters

    +
      +
    • +
      username: string
      +

      Name of the ArangoDB user to set the access level for.

      +
    • +
    • +
      __namedParameters: UserAccessLevelOptions & {
          grant: AccessLevel;
      }
    +

    Returns Promise<ArangoApiResponse<Record<string, AccessLevel>>>

+
+ +
    + +
  • +

    Attempts to initiate a clean shutdown of the server.

    +
    +

    Returns Promise<void>

+
+ +
    + +
  • +

    Retrives the server's current system time in milliseconds with microsecond +precision.

    +
    +

    Returns Promise<number>

+
+ +
    + +
  • +

    Returns a Transaction instance for an existing streaming +transaction with the given id.

    +

    See also beginTransaction.

    + +

    Example

    const trx1 = await db.beginTransaction(collections);
    const id = trx1.id;
    // later
    const trx2 = db.transaction(id);
    await trx2.commit(); +
    +
    +
    +

    Parameters

    +
      +
    • +
      transactionId: string
    +

    Returns Transaction

+
+ +
    + +
  • +

    Fetches all active transactions from the database and returns an array of +Transaction instances for those transactions.

    +

    See also listTransactions.

    + +

    Example

    const db = new Database();
    const transactions = await db.transactions();
    // transactions is an array of transactions +
    +
    +

    Returns Promise<Transaction[]>

+
+ +
    + +
  • +

    Completely removes a service from the database.

    + +

    Example

    const db = new Database();
    await db.uninstallService("/my-foxx"); +
    +
    +
    +

    Parameters

    +
      +
    • +
      mount: string
      +

      The service's mount point, relative to the database.

      +
    • +
    • +
      Optional options: UninstallServiceOptions
      +

      Options for uninstalling the service.

      +
    +

    Returns Promise<void>

+
+ +
    + +
  • +

    Updates the configuration of the given service while maintaining any +existing values for options not specified.

    +

    See also replaceServiceConfiguration and +getServiceConfiguration.

    + +

    Example

    const db = new Database();
    const config = { currency: "USD", locale: "en-US" };
    const info = await db.updateServiceConfiguration("/my-service", config);
    for (const [key, option] of Object.entries(info)) {
    console.log(`${option.title} (${key}): ${option.value}`);
    if (option.warning) console.warn(`Warning: ${option.warning}`);
    } +
    +
    +
    +

    Parameters

    +
      +
    • +
      mount: string
      +

      The service's mount point, relative to the database.

      +
    • +
    • +
      cfg: Record<string, any>
      +

      An object mapping configuration option names to values.

      +
    • +
    • +
      Optional minimal: false
      +

      If set to true, the result will only include each +configuration option's current value and warning (if any). +Otherwise it will include the full definition for each option.

      +
    +

    Returns Promise<Record<string, ServiceConfiguration & {
        warning?: string;
    }>>

  • + +
  • +

    Updates the configuration of the given service while maintaining any +existing values for options not specified.

    +

    See also replaceServiceConfiguration and +getServiceConfiguration.

    + +

    Example

    const db = new Database();
    const config = { currency: "USD", locale: "en-US" };
    const info = await db.updateServiceConfiguration("/my-service", config);
    for (const [key, value] of Object.entries(info.values)) {
    console.log(`${key}: ${value}`);
    if (info.warnings[key]) console.warn(`Warning: ${info.warnings[key]}`);
    } +
    +
    +
    +

    Parameters

    +
      +
    • +
      mount: string
      +

      The service's mount point, relative to the database.

      +
    • +
    • +
      cfg: Record<string, any>
      +

      An object mapping configuration option names to values.

      +
    • +
    • +
      minimal: true
      +

      If set to true, the result will only include each +configuration option's current value and warning (if any). +Otherwise it will include the full definition for each option.

      +
    +

    Returns Promise<{
        values: Record<string, any>;
        warnings: Record<string, string>;
    }>

+
+ +
    + +
  • +

    Updates the dependencies of the given service while maintaining any +existing mount points for dependencies not specified.

    +

    See also replaceServiceDependencies and +getServiceDependencies.

    + +

    Example

    const db = new Database();
    const deps = { mailer: "/mailer-api", auth: "/remote-auth" };
    const info = await db.updateServiceDependencies("/my-service", deps);
    for (const [key, dep] of Object.entries(info)) {
    console.log(`${dep.title} (${key}): ${dep.current}`);
    if (dep.warning) console.warn(`Warning: ${dep.warning}`);
    } +
    +
    +
    +

    Parameters

    +
      +
    • +
      mount: string
      +

      The service's mount point, relative to the database.

      +
    • +
    • +
      deps: Record<string, string>
    • +
    • +
      Optional minimal: false
      +

      If set to true, the result will only include each +dependency's current mount point. Otherwise it will include the full +definition for each dependency.

      +
    +

    Returns Promise<Record<string, Object>>

  • + +
  • +

    Updates the dependencies of the given service while maintaining any +existing mount points for dependencies not specified.

    +

    See also replaceServiceDependencies and +getServiceDependencies.

    + +

    Example

    const db = new Database();
    const deps = { mailer: "/mailer-api", auth: "/remote-auth" };
    const info = await db.updateServiceDependencies(
    "/my-service",
    deps,
    true
    );
    for (const [key, value] of Object.entries(info)) {
    console.log(`${key}: ${value}`);
    if (info.warnings[key]) console.warn(`Warning: ${info.warnings[key]}`);
    } +
    +
    +
    +

    Parameters

    +
      +
    • +
      mount: string
      +

      The service's mount point, relative to the database.

      +
    • +
    • +
      deps: Record<string, string>
    • +
    • +
      minimal: true
      +

      If set to true, the result will only include each +dependency's current mount point. Otherwise it will include the full +definition for each dependency.

      +
    +

    Returns Promise<{
        values: Record<string, string>;
        warnings: Record<string, string>;
    }>

+
+ +
    + +
  • +

    Sets the password of a given ArangoDB user to the new value.

    + +

    Example

    const db = new Database();
    const user = await db.updateUser("steve", "hunter2");
    // The user "steve" has received a new password +
    +
    +
    +

    Parameters

    +
      +
    • +
      username: string
      +

      Name of the ArangoDB user to change the password for.

      +
    • +
    • +
      passwd: string
      +

      New password for the ArangoDB user.

      +
    +

    Returns Promise<ArangoApiResponse<ArangoUser>>

  • + +
  • +

    Updates the ArangoDB user with the new options.

    + +

    Example

    const db = new Database();
    const user = await db.updateUser("steve", { active: false });
    // The user "steve" has been set to inactive +
    +
    +
    +

    Parameters

    +
      +
    • +
      username: string
      +

      Name of the ArangoDB user to modify.

      +
    • +
    • +
      options: Partial<UserOptions>
      +

      Options of the ArangoDB user to modify.

      +
    +

    Returns Promise<ArangoApiResponse<ArangoUser>>

+
+ +
    + +
  • +

    Replaces an existing service with a new service while retaining the old +service's configuration and dependencies.

    + +

    Example

    const db = new Database();
    // Using a node.js file stream as source
    const source = fs.createReadStream("./my-foxx-service.zip");
    const info = await db.upgradeService("/hello", source); +
    + +

    Example

    const db = new Database();
    // Using a node.js Buffer as source
    const source = fs.readFileSync("./my-foxx-service.zip");
    const info = await db.upgradeService("/hello", source); +
    + +

    Example

    const db = new Database();
    // Using a File (Blob) from a browser file input
    const element = document.getElementById("my-file-input");
    const source = element.files[0];
    const info = await db.upgradeService("/hello", source); +
    +
    +
    +

    Parameters

    +
      +
    • +
      mount: string
      +

      The service's mount point, relative to the database.

      +
    • +
    • +
      source: string | Readable | Blob | Buffer
      +

      The service bundle to install.

      +
    • +
    • +
      options: UpgradeServiceOptions = {}
      +

      Options for upgrading the service.

      +
    +

    Returns Promise<ServiceInfo>

+
+ +
    + +
  • +

    Updates the underlying connection's authorization header to use Basic +authentication with the given username and password, then returns +itself.

    + +

    Example

    const db = new Database();
    db.useBasicAuth("admin", "hunter2");
    // with the username "admin" and password "hunter2". +
    +
    +
    +

    Parameters

    +
      +
    • +
      username: string = "root"
      +

      The username to authenticate with.

      +
    • +
    • +
      password: string = ""
      +

      The password to authenticate with.

      +
    +

    Returns Database

+
+ +
    + +
  • +

    Updates the underlying connection's authorization header to use Bearer +authentication with the given authentication token, then returns itself.

    + +

    Example

    const db = new Database();
    db.useBearerAuth("keyboardcat");
    // The database instance now uses Bearer authentication. +
    +
    +
    +

    Parameters

    +
      +
    • +
      token: string
      +

      The token to authenticate with.

      +
    +

    Returns Database

+
+ +
    + +
  • +

    Fetches all databases accessible to the active user from the server and +returns an array of Database instances for those databases.

    +

    See also listUserDatabases and +databases.

    + +

    Example

    const db = new Database();
    const names = await db.userDatabases();
    // databases is an array of databases +
    +
    +

    Returns Promise<Database[]>

+
+ +
    + +
  • +

    Fetches version information from the ArangoDB server.

    + +

    Example

    const db = new Database();
    const version = await db.version();
    // the version object contains the ArangoDB version information.
    // license: "community" or "enterprise"
    // version: ArangoDB version number
    // server: description of the server +
    +
    +
    +

    Parameters

    +
      +
    • +
      Optional details: boolean
      +

      If set to true, additional information about the +ArangoDB server will be available as the details property.

      +
    +

    Returns Promise<VersionInfo>

+
+ +
    + +
  • +

    Returns a View instance for the given viewName.

    + +

    Example

    const db = new Database();
    const view = db.view("potatoes"); +
    +
    +
    +

    Parameters

    +
      +
    • +
      viewName: string
      +

      Name of the ArangoSearch or SearchAlias View.

      +
    +

    Returns View

+
+ +
    + +
  • +

    Fetches all Views from the database and returns an array of +View instances +for the Views.

    +

    See also listViews.

    + +

    Example

    const db = new Database();
    const views = await db.views();
    // views is an array of ArangoSearch View instances +
    +
    +

    Returns Promise<View[]>

+
+ +
    + +
  • +

    Performs a request against every known coordinator and returns when the +request has succeeded against every coordinator or the timeout is reached.

    +

    Note: This method is primarily intended to make database setup easier +in cluster scenarios and requires all coordinators to be known to arangojs +before the method is invoked. The method is not useful in single-server or +leader-follower replication scenarios.

    + +

    Example

    const db = new Database({ loadBalancingStrategy: "ROUND_ROBIN" });
    await system.acquireHostList();
    const analyzer = db.analyzer("my-analyzer");
    await analyzer.create();
    await db.waitForPropagation(
    { path: `/_api/analyzer/${encodeURIComponent(analyzer.name)}` },
    30000
    );
    // Analyzer has been propagated to all coordinators and can safely be used +
    +
    +
    +

    Parameters

    +
      +
    • +
      request: RequestOptions
      +

      Request to perform against each known coordinator.

      +
    • +
    • +
      Optional timeout: number
      +

      Maximum number of milliseconds to wait for propagation.

      +
    +

    Returns Promise<void>

+
+ +
    + +
  • +

    Begins and commits a transaction using the given callback. Individual +requests that are part of the transaction need to be wrapped in the step +function passed into the callback. If the promise returned by the callback +is rejected, the transaction will be aborted.

    +

    Collections can be specified as collection names (strings) or objects +implementing the ArangoCollection interface: Collection, +GraphVertexCollection, GraphEdgeCollection as +well as (in TypeScript) DocumentCollection and +EdgeCollection.

    + +

    Example

    const vertices = db.collection("vertices");
    const edges = db.collection("edges");
    await db.withTransaction(
    {
    read: ["vertices"],
    write: [edges] // collection instances can be passed directly
    },
    async (step) => {
    const start = await step(() => vertices.document("a"));
    const end = await step(() => vertices.document("b"));
    await step(() => edges.save({ _from: start._id, _to: end._id }));
    }
    ); +
    +
    +
    +

    Type Parameters

    +
      +
    • +

      T

    +
    +

    Parameters

    +
      +
    • +
      collections: TransactionCollections
      +

      Collections involved in the transaction.

      +
    • +
    • +
      callback: ((step: (<T>(callback: (() => Promise<T>)) => Promise<T>)) => Promise<T>)
      +

      Callback function executing the transaction steps.

      +
      +
        +
      • +
          +
        • (step: (<T>(callback: (() => Promise<T>)) => Promise<T>)): Promise<T>
        • +
        • +
          +

          Parameters

          +
            +
          • +
            step: (<T>(callback: (() => Promise<T>)) => Promise<T>)
            +
              +
            • +
                +
              • <T>(callback: (() => Promise<T>)): Promise<T>
              • +
              • +

                Executes the given function locally as a single step of the transaction.

                + +

                Example

                const db = new Database();
                const vertices = db.collection("vertices");
                const edges = db.collection("edges");
                const trx = await db.beginTransaction({ write: [vertices, edges] });

                // The following code will be part of the transaction
                const left = await trx.step(() => vertices.save({ label: "left" }));
                const right = await trx.step(() => vertices.save({ label: "right" }));

                // Results from preceding actions can be used normally
                await trx.step(() => edges.save({
                _from: left._id,
                _to: right._id,
                data: "potato"
                }));

                // Transaction must be committed for changes to take effected
                // Always call either trx.commit or trx.abort to end a transaction
                await trx.commit(); +
                + +

                Example

                // BAD! If the callback is an async function it must only use await once!
                await trx.step(async () => {
                await collection.save(data);
                await collection.save(moreData); // WRONG
                });

                // BAD! Callback function must use only one arangojs call!
                await trx.step(() => {
                return collection.save(data)
                .then(() => collection.save(moreData)); // WRONG
                });

                // BETTER: Wrap every arangojs method call that should be part of the
                // transaction in a separate `trx.step` call
                await trx.step(() => collection.save(data));
                await trx.step(() => collection.save(moreData)); +
                + +

                Example

                // BAD! If the callback is an async function it must not await before
                // calling an arangojs method!
                await trx.step(async () => {
                await doSomethingElse();
                return collection.save(data); // WRONG
                });

                // BAD! Any arangojs inside the callback must not happen inside a promise
                // method!
                await trx.step(() => {
                return doSomethingElse()
                .then(() => collection.save(data)); // WRONG
                });

                // BETTER: Perform any async logic needed outside the `trx.step` call
                await doSomethingElse();
                await trx.step(() => collection.save(data));

                // OKAY: You can perform async logic in the callback after the arangojs
                // method call as long as it does not involve additional arangojs method
                // calls, but this makes it easy to make mistakes later
                await trx.step(async () => {
                await collection.save(data);
                await doSomethingDifferent(); // no arangojs method calls allowed
                }); +
                + +

                Example

                // BAD! The callback should not use any functions that themselves use any
                // arangojs methods!
                async function saveSomeData() {
                await collection.save(data);
                await collection.save(moreData);
                }
                await trx.step(() => saveSomeData()); // WRONG

                // BETTER: Pass the transaction to functions that need to call arangojs
                // methods inside a transaction
                async function saveSomeData(trx) {
                await trx.step(() => collection.save(data));
                await trx.step(() => collection.save(moreData));
                }
                await saveSomeData(); // no `trx.step` call needed +
                + +

                Example

                // BAD! You must wait for the promise to resolve (or await on the
                // `trx.step` call) before calling `trx.step` again!
                trx.step(() => collection.save(data)); // WRONG
                await trx.step(() => collection.save(moreData));

                // BAD! The trx.step callback can not make multiple calls to async arangojs
                // methods, not even using Promise.all!
                await trx.step(() => Promise.all([ // WRONG
                collection.save(data),
                collection.save(moreData),
                ]));

                // BAD! Multiple `trx.step` calls can not run in parallel!
                await Promise.all([ // WRONG
                trx.step(() => collection.save(data)),
                trx.step(() => collection.save(moreData)),
                ]));

                // BETTER: Always call `trx.step` sequentially, one after the other
                await trx.step(() => collection.save(data));
                await trx.step(() => collection.save(moreData));

                // OKAY: The then callback can be used if async/await is not available
                trx.step(() => collection.save(data))
                .then(() => trx.step(() => collection.save(moreData))); +
                + +

                Example

                // BAD! The callback will return an empty promise that resolves before
                // the inner arangojs method call has even talked to ArangoDB!
                await trx.step(async () => {
                collection.save(data); // WRONG
                });

                // BETTER: Use an arrow function so you don't forget to return
                await trx.step(() => collection.save(data));

                // OKAY: Remember to always return when using a function body
                await trx.step(() => {
                return collection.save(data); // easy to forget!
                });

                // OKAY: You do not have to use arrow functions but it helps
                await trx.step(function () {
                return collection.save(data);
                }); +
                + +

                Example

                // BAD! You can not pass promises instead of a callback!
                await trx.step(collection.save(data)); // WRONG

                // BETTER: Wrap the code in a function and pass the function instead
                await trx.step(() => collection.save(data)); +
                + +

                Example

                // WORSE: Calls to non-async arangojs methods don't need to be performed
                // as part of a transaction
                const collection = await trx.step(() => db.collection("my-documents"));

                // BETTER: If an arangojs method is not async and doesn't return promises,
                // call it without `trx.step`
                const collection = db.collection("my-documents"); +
                +
                +
                +

                Type Parameters

                +
                  +
                • +

                  T

                  +

                  Type of the callback's returned promise.

                  +
                +
                +

                Parameters

                +
                  +
                • +
                  callback: (() => Promise<T>)
                  +

                  Callback function returning a promise.

                  +

                  Warning: The callback function should wrap a single call of an async +arangojs method (e.g. a method on a Collection object of a collection +that is involved in the transaction or the db.query method). +If the callback function is async, only the first promise-returning (or +async) method call will be executed as part of the transaction. See the +examples below for how to avoid common mistakes when using this method.

                  +

                  Note: Avoid defining the callback as an async function if possible +as arangojs will throw an error if the callback did not return a promise. +Async functions will return an empty promise by default, making it harder +to notice if you forgot to return something from the callback.

                  +

                  Note: Although almost anything can be wrapped in a callback and passed +to this method, that does not guarantee ArangoDB can actually do it in a +transaction. Refer to the ArangoDB documentation if you are unsure whether +a given operation can be executed as part of a transaction. Generally any +modification or retrieval of data is eligible but modifications of +collections or databases are not.

                  +
                  +
                    +
                  • +
                      +
                    • (): Promise<T>
                    • +
                    • +

                      Returns Promise<T>

                +

                Returns Promise<T>

          +

          Returns Promise<T>

    • +
    • +
      Optional options: TransactionOptions
      +

      Options for the transaction.

      +
    +

    Returns Promise<T>

  • + +
  • +

    Begins and commits a transaction using the given callback. Individual +requests that are part of the transaction need to be wrapped in the step +function passed into the callback. If the promise returned by the callback +is rejected, the transaction will be aborted.

    +

    Collections can be specified as collection names (strings) or objects +implementing the ArangoCollection interface: Collection, +GraphVertexCollection, GraphEdgeCollection as well as +(in TypeScript) DocumentCollection and EdgeCollection.

    + +

    Example

    const vertices = db.collection("vertices");
    const edges = db.collection("edges");
    await db.withTransaction(
    [
    "vertices",
    edges, // collection instances can be passed directly
    ],
    async (step) => {
    const start = await step(() => vertices.document("a"));
    const end = await step(() => vertices.document("b"));
    await step(() => edges.save({ _from: start._id, _to: end._id }));
    }
    ); +
    +
    +
    +

    Type Parameters

    +
      +
    • +

      T

    +
    +

    Parameters

    +
      +
    • +
      collections: (string | ArangoCollection)[]
      +

      Collections that can be read from and written to +during the transaction.

      +
    • +
    • +
      callback: ((step: (<T>(callback: (() => Promise<T>)) => Promise<T>)) => Promise<T>)
      +

      Callback function executing the transaction steps.

      +
      +
        +
      • +
          +
        • (step: (<T>(callback: (() => Promise<T>)) => Promise<T>)): Promise<T>
        • +
        • +
          +

          Parameters

          +
            +
          • +
            step: (<T>(callback: (() => Promise<T>)) => Promise<T>)
            +
              +
            • +
                +
              • <T>(callback: (() => Promise<T>)): Promise<T>
              • +
              • +

                Executes the given function locally as a single step of the transaction.

                + +

                Example

                const db = new Database();
                const vertices = db.collection("vertices");
                const edges = db.collection("edges");
                const trx = await db.beginTransaction({ write: [vertices, edges] });

                // The following code will be part of the transaction
                const left = await trx.step(() => vertices.save({ label: "left" }));
                const right = await trx.step(() => vertices.save({ label: "right" }));

                // Results from preceding actions can be used normally
                await trx.step(() => edges.save({
                _from: left._id,
                _to: right._id,
                data: "potato"
                }));

                // Transaction must be committed for changes to take effected
                // Always call either trx.commit or trx.abort to end a transaction
                await trx.commit(); +
                + +

                Example

                // BAD! If the callback is an async function it must only use await once!
                await trx.step(async () => {
                await collection.save(data);
                await collection.save(moreData); // WRONG
                });

                // BAD! Callback function must use only one arangojs call!
                await trx.step(() => {
                return collection.save(data)
                .then(() => collection.save(moreData)); // WRONG
                });

                // BETTER: Wrap every arangojs method call that should be part of the
                // transaction in a separate `trx.step` call
                await trx.step(() => collection.save(data));
                await trx.step(() => collection.save(moreData)); +
                + +

                Example

                // BAD! If the callback is an async function it must not await before
                // calling an arangojs method!
                await trx.step(async () => {
                await doSomethingElse();
                return collection.save(data); // WRONG
                });

                // BAD! Any arangojs inside the callback must not happen inside a promise
                // method!
                await trx.step(() => {
                return doSomethingElse()
                .then(() => collection.save(data)); // WRONG
                });

                // BETTER: Perform any async logic needed outside the `trx.step` call
                await doSomethingElse();
                await trx.step(() => collection.save(data));

                // OKAY: You can perform async logic in the callback after the arangojs
                // method call as long as it does not involve additional arangojs method
                // calls, but this makes it easy to make mistakes later
                await trx.step(async () => {
                await collection.save(data);
                await doSomethingDifferent(); // no arangojs method calls allowed
                }); +
                + +

                Example

                // BAD! The callback should not use any functions that themselves use any
                // arangojs methods!
                async function saveSomeData() {
                await collection.save(data);
                await collection.save(moreData);
                }
                await trx.step(() => saveSomeData()); // WRONG

                // BETTER: Pass the transaction to functions that need to call arangojs
                // methods inside a transaction
                async function saveSomeData(trx) {
                await trx.step(() => collection.save(data));
                await trx.step(() => collection.save(moreData));
                }
                await saveSomeData(); // no `trx.step` call needed +
                + +

                Example

                // BAD! You must wait for the promise to resolve (or await on the
                // `trx.step` call) before calling `trx.step` again!
                trx.step(() => collection.save(data)); // WRONG
                await trx.step(() => collection.save(moreData));

                // BAD! The trx.step callback can not make multiple calls to async arangojs
                // methods, not even using Promise.all!
                await trx.step(() => Promise.all([ // WRONG
                collection.save(data),
                collection.save(moreData),
                ]));

                // BAD! Multiple `trx.step` calls can not run in parallel!
                await Promise.all([ // WRONG
                trx.step(() => collection.save(data)),
                trx.step(() => collection.save(moreData)),
                ]));

                // BETTER: Always call `trx.step` sequentially, one after the other
                await trx.step(() => collection.save(data));
                await trx.step(() => collection.save(moreData));

                // OKAY: The then callback can be used if async/await is not available
                trx.step(() => collection.save(data))
                .then(() => trx.step(() => collection.save(moreData))); +
                + +

                Example

                // BAD! The callback will return an empty promise that resolves before
                // the inner arangojs method call has even talked to ArangoDB!
                await trx.step(async () => {
                collection.save(data); // WRONG
                });

                // BETTER: Use an arrow function so you don't forget to return
                await trx.step(() => collection.save(data));

                // OKAY: Remember to always return when using a function body
                await trx.step(() => {
                return collection.save(data); // easy to forget!
                });

                // OKAY: You do not have to use arrow functions but it helps
                await trx.step(function () {
                return collection.save(data);
                }); +
                + +

                Example

                // BAD! You can not pass promises instead of a callback!
                await trx.step(collection.save(data)); // WRONG

                // BETTER: Wrap the code in a function and pass the function instead
                await trx.step(() => collection.save(data)); +
                + +

                Example

                // WORSE: Calls to non-async arangojs methods don't need to be performed
                // as part of a transaction
                const collection = await trx.step(() => db.collection("my-documents"));

                // BETTER: If an arangojs method is not async and doesn't return promises,
                // call it without `trx.step`
                const collection = db.collection("my-documents"); +
                +
                +
                +

                Type Parameters

                +
                  +
                • +

                  T

                  +

                  Type of the callback's returned promise.

                  +
                +
                +

                Parameters

                +
                  +
                • +
                  callback: (() => Promise<T>)
                  +

                  Callback function returning a promise.

                  +

                  Warning: The callback function should wrap a single call of an async +arangojs method (e.g. a method on a Collection object of a collection +that is involved in the transaction or the db.query method). +If the callback function is async, only the first promise-returning (or +async) method call will be executed as part of the transaction. See the +examples below for how to avoid common mistakes when using this method.

                  +

                  Note: Avoid defining the callback as an async function if possible +as arangojs will throw an error if the callback did not return a promise. +Async functions will return an empty promise by default, making it harder +to notice if you forgot to return something from the callback.

                  +

                  Note: Although almost anything can be wrapped in a callback and passed +to this method, that does not guarantee ArangoDB can actually do it in a +transaction. Refer to the ArangoDB documentation if you are unsure whether +a given operation can be executed as part of a transaction. Generally any +modification or retrieval of data is eligible but modifications of +collections or databases are not.

                  +
                  +
                    +
                  • +
                      +
                    • (): Promise<T>
                    • +
                    • +

                      Returns Promise<T>

                +

                Returns Promise<T>

          +

          Returns Promise<T>

    • +
    • +
      Optional options: TransactionOptions
      +

      Options for the transaction.

      +
    +

    Returns Promise<T>

  • + +
  • +

    Begins and commits a transaction using the given callback. Individual +requests that are part of the transaction need to be wrapped in the step +function passed into the callback. If the promise returned by the callback +is rejected, the transaction will be aborted.

    +

    The Collection can be specified as a collection name (string) or an object +implementing the ArangoCollection interface: Collection, +GraphVertexCollection, GraphEdgeCollection as well as +(in TypeScript) DocumentCollection and EdgeCollection.

    + +

    Example

    const vertices = db.collection("vertices");
    const start = vertices.document("a");
    const end = vertices.document("b");
    const edges = db.collection("edges");
    await db.withTransaction(
    edges, // collection instances can be passed directly
    async (step) => {
    await step(() => edges.save({ _from: start._id, _to: end._id }));
    }
    ); +
    +
    +
    +

    Type Parameters

    +
      +
    • +

      T

    +
    +

    Parameters

    +
      +
    • +
      collection: string | ArangoCollection
      +

      A collection that can be read from and written to +during the transaction.

      +
    • +
    • +
      callback: ((step: (<T>(callback: (() => Promise<T>)) => Promise<T>)) => Promise<T>)
      +

      Callback function executing the transaction steps.

      +
      +
        +
      • +
          +
        • (step: (<T>(callback: (() => Promise<T>)) => Promise<T>)): Promise<T>
        • +
        • +
          +

          Parameters

          +
            +
          • +
            step: (<T>(callback: (() => Promise<T>)) => Promise<T>)
            +
              +
            • +
                +
              • <T>(callback: (() => Promise<T>)): Promise<T>
              • +
              • +

                Executes the given function locally as a single step of the transaction.

                + +

                Example

                const db = new Database();
                const vertices = db.collection("vertices");
                const edges = db.collection("edges");
                const trx = await db.beginTransaction({ write: [vertices, edges] });

                // The following code will be part of the transaction
                const left = await trx.step(() => vertices.save({ label: "left" }));
                const right = await trx.step(() => vertices.save({ label: "right" }));

                // Results from preceding actions can be used normally
                await trx.step(() => edges.save({
                _from: left._id,
                _to: right._id,
                data: "potato"
                }));

                // Transaction must be committed for changes to take effected
                // Always call either trx.commit or trx.abort to end a transaction
                await trx.commit(); +
                + +

                Example

                // BAD! If the callback is an async function it must only use await once!
                await trx.step(async () => {
                await collection.save(data);
                await collection.save(moreData); // WRONG
                });

                // BAD! Callback function must use only one arangojs call!
                await trx.step(() => {
                return collection.save(data)
                .then(() => collection.save(moreData)); // WRONG
                });

                // BETTER: Wrap every arangojs method call that should be part of the
                // transaction in a separate `trx.step` call
                await trx.step(() => collection.save(data));
                await trx.step(() => collection.save(moreData)); +
                + +

                Example

                // BAD! If the callback is an async function it must not await before
                // calling an arangojs method!
                await trx.step(async () => {
                await doSomethingElse();
                return collection.save(data); // WRONG
                });

                // BAD! Any arangojs inside the callback must not happen inside a promise
                // method!
                await trx.step(() => {
                return doSomethingElse()
                .then(() => collection.save(data)); // WRONG
                });

                // BETTER: Perform any async logic needed outside the `trx.step` call
                await doSomethingElse();
                await trx.step(() => collection.save(data));

                // OKAY: You can perform async logic in the callback after the arangojs
                // method call as long as it does not involve additional arangojs method
                // calls, but this makes it easy to make mistakes later
                await trx.step(async () => {
                await collection.save(data);
                await doSomethingDifferent(); // no arangojs method calls allowed
                }); +
                + +

                Example

                // BAD! The callback should not use any functions that themselves use any
                // arangojs methods!
                async function saveSomeData() {
                await collection.save(data);
                await collection.save(moreData);
                }
                await trx.step(() => saveSomeData()); // WRONG

                // BETTER: Pass the transaction to functions that need to call arangojs
                // methods inside a transaction
                async function saveSomeData(trx) {
                await trx.step(() => collection.save(data));
                await trx.step(() => collection.save(moreData));
                }
                await saveSomeData(); // no `trx.step` call needed +
                + +

                Example

                // BAD! You must wait for the promise to resolve (or await on the
                // `trx.step` call) before calling `trx.step` again!
                trx.step(() => collection.save(data)); // WRONG
                await trx.step(() => collection.save(moreData));

                // BAD! The trx.step callback can not make multiple calls to async arangojs
                // methods, not even using Promise.all!
                await trx.step(() => Promise.all([ // WRONG
                collection.save(data),
                collection.save(moreData),
                ]));

                // BAD! Multiple `trx.step` calls can not run in parallel!
                await Promise.all([ // WRONG
                trx.step(() => collection.save(data)),
                trx.step(() => collection.save(moreData)),
                ]));

                // BETTER: Always call `trx.step` sequentially, one after the other
                await trx.step(() => collection.save(data));
                await trx.step(() => collection.save(moreData));

                // OKAY: The then callback can be used if async/await is not available
                trx.step(() => collection.save(data))
                .then(() => trx.step(() => collection.save(moreData))); +
                + +

                Example

                // BAD! The callback will return an empty promise that resolves before
                // the inner arangojs method call has even talked to ArangoDB!
                await trx.step(async () => {
                collection.save(data); // WRONG
                });

                // BETTER: Use an arrow function so you don't forget to return
                await trx.step(() => collection.save(data));

                // OKAY: Remember to always return when using a function body
                await trx.step(() => {
                return collection.save(data); // easy to forget!
                });

                // OKAY: You do not have to use arrow functions but it helps
                await trx.step(function () {
                return collection.save(data);
                }); +
                + +

                Example

                // BAD! You can not pass promises instead of a callback!
                await trx.step(collection.save(data)); // WRONG

                // BETTER: Wrap the code in a function and pass the function instead
                await trx.step(() => collection.save(data)); +
                + +

                Example

                // WORSE: Calls to non-async arangojs methods don't need to be performed
                // as part of a transaction
                const collection = await trx.step(() => db.collection("my-documents"));

                // BETTER: If an arangojs method is not async and doesn't return promises,
                // call it without `trx.step`
                const collection = db.collection("my-documents"); +
                +
                +
                +

                Type Parameters

                +
                  +
                • +

                  T

                  +

                  Type of the callback's returned promise.

                  +
                +
                +

                Parameters

                +
                  +
                • +
                  callback: (() => Promise<T>)
                  +

                  Callback function returning a promise.

                  +

                  Warning: The callback function should wrap a single call of an async +arangojs method (e.g. a method on a Collection object of a collection +that is involved in the transaction or the db.query method). +If the callback function is async, only the first promise-returning (or +async) method call will be executed as part of the transaction. See the +examples below for how to avoid common mistakes when using this method.

                  +

                  Note: Avoid defining the callback as an async function if possible +as arangojs will throw an error if the callback did not return a promise. +Async functions will return an empty promise by default, making it harder +to notice if you forgot to return something from the callback.

                  +

                  Note: Although almost anything can be wrapped in a callback and passed +to this method, that does not guarantee ArangoDB can actually do it in a +transaction. Refer to the ArangoDB documentation if you are unsure whether +a given operation can be executed as part of a transaction. Generally any +modification or retrieval of data is eligible but modifications of +collections or databases are not.

                  +
                  +
                    +
                  • +
                      +
                    • (): Promise<T>
                    • +
                    • +

                      Returns Promise<T>

                +

                Returns Promise<T>

          +

          Returns Promise<T>

    • +
    • +
      Optional options: TransactionOptions
      +

      Options for the transaction.

      +
    +

    Returns Promise<T>

+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/classes/error.ArangoError.html b/8.8.0/classes/error.ArangoError.html new file mode 100644 index 000000000..b905a4148 --- /dev/null +++ b/8.8.0/classes/error.ArangoError.html @@ -0,0 +1,191 @@ +ArangoError | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Class ArangoError

+
+

Represents an error returned by ArangoDB.

+
+
+

Hierarchy

+
    +
  • Error +
      +
    • ArangoError
+
+
+
+ +
+
+

Properties

+
+ +
code: number
+

HTTP status code included in the server error response object.

+
+
+ +
errorNum: number
+

ArangoDB error code.

+

See ArangoDB error documentation.

+
+
+ +
name: string = "ArangoError"
+
+ +
response: any
+

Server response object.

+
+
+ +
prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)
+
+

Type declaration

+
+
+ +
stackTraceLimit: number
+
+

Methods

+
+ +
    + +
  • +

    Returns {
        code: number;
        error: boolean;
        errorMessage: string;
        errorNum: number;
    }

    +
      +
    • +
      code: number
    • +
    • +
      error: boolean
    • +
    • +
      errorMessage: string
    • +
    • +
      errorNum: number
+
+ +
    + +
  • +

    Create .stack property on a target object

    +
    +
    +

    Parameters

    +
      +
    • +
      targetObject: object
    • +
    • +
      Optional constructorOpt: Function
    +

    Returns void

+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/classes/error.HttpError.html b/8.8.0/classes/error.HttpError.html new file mode 100644 index 000000000..c4ab57b53 --- /dev/null +++ b/8.8.0/classes/error.HttpError.html @@ -0,0 +1,177 @@ +HttpError | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Class HttpError

+
+

Represents a plain HTTP error response.

+
+
+

Hierarchy

+
    +
  • Error +
      +
    • HttpError
+
+
+
+ +
+
+

Properties

+
+ +
code: number
+

HTTP status code of the server response.

+
+
+ +
name: string = "HttpError"
+
+ +
response: any
+

Server response object.

+
+
+ +
prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)
+
+

Type declaration

+
+
+ +
stackTraceLimit: number
+
+

Methods

+
+ +
    + +
  • +

    Returns {
        code: number;
        error: boolean;
    }

    +
      +
    • +
      code: number
    • +
    • +
      error: boolean
+
+ +
    + +
  • +

    Create .stack property on a target object

    +
    +
    +

    Parameters

    +
      +
    • +
      targetObject: object
    • +
    • +
      Optional constructorOpt: Function
    +

    Returns void

+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/classes/graph.Graph.html b/8.8.0/classes/graph.Graph.html new file mode 100644 index 000000000..a41b6f072 --- /dev/null +++ b/8.8.0/classes/graph.Graph.html @@ -0,0 +1,478 @@ +Graph | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Class Graph

+
+

Represents a graph in a Database.

+
+
+

Hierarchy

+
    +
  • Graph
+
+
+
+ +
+
+

Accessors

+
+ +
    +
  • get name(): string
  • +
  • +

    Name of the graph.

    +
    +

    Returns string

+
+

Methods

+
+ +
    + +
  • +

    Adds an edge definition to this graph.

    + +

    Example

    const db = new Database();
    const graph = db.graph("some-graph");
    await graph.addEdgeDefinition({
    collection: "edges",
    from: ["start-vertices"],
    to: ["end-vertices"],
    });
    // The edge definition has been added to the graph +
    +
    +
    +

    Parameters

    +
    +

    Returns Promise<GraphInfo>

+
+ +
    + +
  • +

    Adds the given collection to this graph as a vertex collection.

    + +

    Example

    const db = new Database();
    const graph = db.graph("some-graph");
    await graph.addVertexCollection("more-vertices");
    // The collection "more-vertices" has been added to the graph
    const extra = db.collection("extra-vertices");
    await graph.addVertexCollection(extra);
    // The collection "extra-vertices" has been added to the graph +
    +
    +
    +

    Parameters

    +
    +

    Returns Promise<GraphInfo>

+
+ +
    + +
  • +

    Creates a graph with the given edgeDefinitions and options for this +graph's name.

    + +

    Example

    const db = new Database();
    const graph = db.graph("some-graph");
    const info = await graph.create([
    {
    collection: "edges",
    from: ["start-vertices"],
    to: ["end-vertices"],
    },
    ]);
    // graph now exists +
    +
    +
    +

    Parameters

    +
    +

    Returns Promise<GraphInfo>

+
+ +
    + +
  • +

    Deletes the graph from the database.

    + +

    Example

    const db = new Database();
    const graph = db.graph("some-graph");
    await graph.drop();
    // the graph "some-graph" no longer exists +
    +
    +
    +

    Parameters

    +
      +
    • +
      dropCollections: boolean = false
      +

      If set to true, the collections associated with +the graph will also be deleted.

      +
    +

    Returns Promise<boolean>

+
+ +
    + +
  • +

    Returns a GraphEdgeCollection instance for the given collection +name representing the collection in this graph.

    + +

    Example

    const db = new Database();
    const graph = db.graph("some-graph");
    const info = await graph.create([
    {
    collection: "edges",
    from: ["start-vertices"],
    to: ["end-vertices"],
    },
    ]);
    const graphEdgeCollection = graph.edgeCollection("edges");
    // Access the underlying EdgeCollection API:
    const edgeCollection = graphEdgeCollection.collection; +
    +
    +
    +

    Type Parameters

    +
      +
    • +

      T extends Record<string, any> = any

      +

      Type to use for document data. Defaults to any.

      +
    +
    +

    Parameters

    +
    +

    Returns GraphEdgeCollection<T>

+
+ +
    + +
  • +

    Fetches all edge collections of this graph from the database and returns +an array of GraphEdgeCollection instances.

    +

    See also listEdgeCollections.

    + +

    Example

    const db = new Database();
    const graph = db.graph("some-graph");
    const info = await graph.create([
    {
    collection: "edges",
    from: ["start-vertices"],
    to: ["end-vertices"],
    },
    ]);
    const graphEdgeCollections = await graph.edgeCollections();
    for (const collection of graphEdgeCollection) {
    console.log(collection.name);
    // "edges"
    } +
    +
    +

    Returns Promise<GraphEdgeCollection<any>[]>

+
+ +
    + +
  • +

    Checks whether the graph exists.

    + +

    Example

    const db = new Database();
    const graph = db.graph("some-graph");
    const result = await graph.exists();
    // result indicates whether the graph exists +
    +
    +

    Returns Promise<boolean>

+
+ +
    + +
  • +

    Retrieves general information about the graph.

    + +

    Example

    const db = new Database();
    const graph = db.graph("some-graph");
    const data = await graph.get();
    // data contains general information about the graph +
    +
    +

    Returns Promise<GraphInfo>

+
+ +
    + +
  • +

    Fetches all edge collections of this graph from the database and returns +an array of their names.

    +

    See also edgeCollections.

    + +

    Example

    const db = new Database();
    const graph = db.graph("some-graph");
    const info = await graph.create([
    {
    collection: "edges",
    from: ["start-vertices"],
    to: ["end-vertices"],
    },
    ]);
    const edgeCollectionNames = await graph.listEdgeCollections();
    // ["edges"] +
    +
    +

    Returns Promise<string[]>

+
+ +
    + +
  • +

    Fetches all vertex collections of this graph from the database and returns +an array of their names.

    +

    See also vertexCollections.

    + +

    Example

    const db = new Database();
    const graph = db.graph("some-graph");
    const info = await graph.create([
    {
    collection: "edges",
    from: ["start-vertices"],
    to: ["end-vertices"],
    },
    ]);
    const vertexCollectionNames = await graph.listVertexCollections();
    // ["start-vertices", "end-vertices"] +
    +
    +

    Returns Promise<string[]>

+
+ +
    + +
  • +

    Removes the edge definition for the given edge collection from this graph.

    + +

    Example

    const db = new Database();
    const graph = db.graph("some-graph");
    const info = await graph.create([
    {
    collection: "edges",
    from: ["start-vertices"],
    to: ["end-vertices"],
    },
    ]);
    await graph.removeEdgeDefinition("edges");
    // The edge definition for "edges" has been replaced +
    +
    +
    +

    Parameters

    +
      +
    • +
      collection: string | ArangoCollection
      +

      Edge collection for which to remove the definition.

      +
    • +
    • +
      dropCollection: boolean = false
      +

      If set to true, the collection will also be +deleted from the database.

      +
    +

    Returns Promise<GraphInfo>

+
+ +
    + +
  • +

    Removes the given collection from this graph as a vertex collection.

    + +

    Example

    const db = new Database();
    const graph = db.graph("some-graph");
    const info = await graph.create([
    {
    collection: "edges",
    from: ["start-vertices"],
    to: ["end-vertices"],
    },
    ]);
    await graph.removeVertexCollection("start-vertices");
    // The collection "start-vertices" is no longer part of the graph. +
    +
    +
    +

    Parameters

    +
      +
    • +
      collection: string | ArangoCollection
      +

      Collection to remove from the graph.

      +
    • +
    • +
      dropCollection: boolean = false
      +

      If set to true, the collection will also be +deleted from the database.

      +
    +

    Returns Promise<GraphInfo>

+
+ +
    + +
  • +

    Replaces an edge definition in this graph. The existing edge definition +for the given edge collection will be overwritten.

    + +

    Example

    const db = new Database();
    const graph = db.graph("some-graph");
    const info = await graph.create([
    {
    collection: "edges",
    from: ["start-vertices"],
    to: ["end-vertices"],
    },
    ]);
    await graph.replaceEdgeDefinition({
    collection: "edges",
    from: ["start-vertices"],
    to: ["other-vertices"],
    });
    // The edge definition for "edges" has been replaced +
    +
    +
    +

    Parameters

    +
    +

    Returns Promise<GraphInfo>

  • + +
  • +

    Replaces an edge definition in this graph. The existing edge definition +for the given edge collection will be overwritten.

    + +

    Example

    const db = new Database();
    const graph = db.graph("some-graph");
    const info = await graph.create([
    {
    collection: "edges",
    from: ["start-vertices"],
    to: ["end-vertices"],
    },
    ]);
    await graph.replaceEdgeDefinition("edges", {
    collection: "edges",
    from: ["start-vertices"],
    to: ["other-vertices"],
    });
    // The edge definition for "edges" has been replaced +
    +
    +
    +

    Parameters

    +
    +

    Returns Promise<GraphInfo>

+
+ +
    + +
  • +

    Performs a traversal starting from the given startVertex and following +edges contained in this graph.

    +

    See also traversal.

    + +

    Deprecated

    Simple Queries have been deprecated in ArangoDB 3.4 and are +no longer supported in ArangoDB 3.12. They can be replaced with AQL queries.

    + +

    Example

    const db = new Database();
    const graph = db.graph("my-graph");
    const collection = graph.edgeCollection("edges").collection;
    await collection.import([
    ["_key", "_from", "_to"],
    ["x", "vertices/a", "vertices/b"],
    ["y", "vertices/b", "vertices/c"],
    ["z", "vertices/c", "vertices/d"],
    ]);
    const startVertex = "vertices/a";
    const cursor = await db.query(aql`
    FOR vertex IN OUTBOUND ${startVertex} GRAPH ${graph}
    RETURN vertex._key
    `);
    const result = await cursor.all();
    console.log(result); // ["a", "b", "c", "d"] +
    +
    +
    +

    Parameters

    +
      +
    • +
      startVertex: string
      +

      Document _id of a vertex in this graph.

      +
    • +
    • +
      Optional options: TraversalOptions
      +

      Options for performing the traversal.

      +
    +

    Returns Promise<any>

+
+ +
+
+ +
    + +
  • +

    Fetches all vertex collections of this graph from the database and returns +an array of GraphVertexCollection instances.

    +

    See also listVertexCollections.

    + +

    Example

    const db = new Database();
    const graph = db.graph("some-graph");
    const info = await graph.create([
    {
    collection: "edges",
    from: ["start-vertices"],
    to: ["end-vertices"],
    },
    ]);
    const vertexCollections = await graph.vertexCollections();
    for (const vertexCollection of vertexCollections) {
    console.log(vertexCollection.name);
    // "start-vertices"
    // "end-vertices"
    } +
    +
    +

    Returns Promise<GraphVertexCollection<any>[]>

+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/classes/graph.GraphEdgeCollection.html b/8.8.0/classes/graph.GraphEdgeCollection.html new file mode 100644 index 000000000..c15e08625 --- /dev/null +++ b/8.8.0/classes/graph.GraphEdgeCollection.html @@ -0,0 +1,330 @@ +GraphEdgeCollection | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Class GraphEdgeCollection<T>

+
+

Represents a EdgeCollection of edges in a Graph.

+
+
+

Type Parameters

+
    +
  • +

    T extends Record<string, any> = any

    +

    Type to use for document data. Defaults to any.

    +
+
+

Hierarchy

+
    +
  • GraphEdgeCollection
+
+

Implements

+
+
+
+
+ +
+
+

Accessors

+
+
+

Methods

+
+
+

Accessors

+
+ +
+
+ +
    +
  • get graph(): Graph
  • +
  • +

    The Graph instance this edge collection is bound to.

    +
    +

    Returns Graph

+
+ +
    +
  • get name(): string
  • +
  • +

    Name of the collection.

    +
    +

    Returns string

+
+

Methods

+
+ +
    + +
  • +

    Retrieves the edge matching the given key or id.

    +

    Throws an exception when passed a edge or _id from a different +collection, or if the edge does not exist.

    + +

    Example

    const graph = db.graph("some-graph");
    const collection = graph.edgeCollection("friends")
    try {
    const edge = await collection.edge("abc123");
    console.log(edge);
    } catch (e: any) {
    console.error("Could not find edge");
    } +
    + +

    Example

    const graph = db.graph("some-graph");
    const collection = graph.edgeCollection("friends")
    const edge = await collection.edge("abc123", { graceful: true });
    if (edge) {
    console.log(edge);
    } else {
    console.error("Edge does not exist");
    } +
    +
    +
    +

    Parameters

    +
      +
    • +
      selector: DocumentSelector
      +

      Document _key, _id or object with either of those +properties (e.g. a edge from this collection).

      +
    • +
    • +
      Optional options: GraphCollectionReadOptions
      +

      Options for retrieving the edge.

      +
    +

    Returns Promise<Edge<T>>

  • + +
  • +

    Retrieves the edge matching the given key or id.

    +

    Throws an exception when passed a edge or _id from a different +collection, or if the edge does not exist.

    + +

    Example

    const graph = db.graph("some-graph");
    const collection = graph.edgeCollection("friends")
    try {
    const edge = await collection.edge("abc123", false);
    console.log(edge);
    } catch (e: any) {
    console.error("Could not find edge");
    } +
    + +

    Example

    const graph = db.graph("some-graph");
    const collection = graph.edgeCollection("friends")
    const edge = await collection.edge("abc123", true);
    if (edge) {
    console.log(edge);
    } else {
    console.error("Edge does not exist");
    } +
    +
    +
    +

    Parameters

    +
      +
    • +
      selector: DocumentSelector
      +

      Document _key, _id or object with either of those +properties (e.g. a edge from this collection).

      +
    • +
    • +
      graceful: boolean
      +

      If set to true, null is returned instead of an +exception being thrown if the edge does not exist.

      +
    +

    Returns Promise<Edge<T>>

+
+ +
    + +
  • +

    Checks whether a edge matching the given key or id exists in this +collection.

    +

    Throws an exception when passed a edge or _id from a different +collection.

    + +

    Example

    const graph = db.graph("some-graph");
    const collection = graph.edgeCollection("friends")
    const exists = await collection.edgeExists("abc123");
    if (!exists) {
    console.log("Edge does not exist");
    } +
    +
    +
    +

    Parameters

    +
      +
    • +
      selector: DocumentSelector
      +

      Document _key, _id or object with either of those +properties (e.g. a edge from this collection).

      +
    +

    Returns Promise<boolean>

+
+ +
    + +
  • +

    Removes an existing edge from the collection.

    +

    Throws an exception when passed a edge or _id from a different +collection.

    + +

    Example

    const db = new Database();
    const collection = db.collection("friends");
    const doc = await collection.edge("musadir");
    await collection.remove(doc);
    // edge with key "musadir" deleted +
    +
    +
    +

    Parameters

    +
    +

    Returns Promise<DocumentMetadata & {
        old?: Edge<T>;
    }>

+
+ +
    + +
  • +

    Replaces an existing edge in the collection.

    +

    Throws an exception when passed a edge or _id from a different +collection.

    + +

    Example

    const db = new Database();
    const collection = db.collection("friends");
    await collection.save(
    {
    _key: "musadir",
    _from: "users/rana",
    _to: "users/mudasir",
    active: true,
    best: true
    }
    );
    const result = await collection.replace(
    "musadir",
    { active: false },
    { returnNew: true }
    );
    console.log(result.new.active, result.new.best); // false undefined +
    +
    +
    +

    Parameters

    +
    +

    Returns Promise<DocumentMetadata & {
        new?: Edge<T>;
        old?: Edge<T>;
    }>

+
+ +
    + +
  • +

    Inserts a new edge with the given data into the collection.

    + +

    Example

    const db = new Database();
    const collection = db.collection("friends");
    const result = await collection.save(
    { _from: "users/rana", _to: "users/mudasir", active: false },
    { returnNew: true }
    ); +
    +
    +
    +

    Parameters

    +
    +

    Returns Promise<DocumentMetadata & {
        new?: Edge<T>;
    }>

+
+ +
    + +
  • +

    Updates an existing edge in the collection.

    +

    Throws an exception when passed a edge or _id from a different +collection.

    + +

    Example

    const db = new Database();
    const collection = db.collection("friends");
    await collection.save(
    {
    _key: "musadir",
    _from: "users/rana",
    _to: "users/mudasir",
    active: true,
    best: true
    }
    );
    const result = await collection.update(
    "musadir",
    { active: false },
    { returnNew: true }
    );
    console.log(result.new.active, result.new.best); // false true +
    +
    +
    +

    Parameters

    +
    +

    Returns Promise<DocumentMetadata & {
        new?: Edge<T>;
        old?: Edge<T>;
    }>

+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/classes/graph.GraphVertexCollection.html b/8.8.0/classes/graph.GraphVertexCollection.html new file mode 100644 index 000000000..fe4051bb9 --- /dev/null +++ b/8.8.0/classes/graph.GraphVertexCollection.html @@ -0,0 +1,333 @@ +GraphVertexCollection | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Class GraphVertexCollection<T>

+
+

Represents a DocumentCollection of vertices in a Graph.

+
+
+

Type Parameters

+
    +
  • +

    T extends Record<string, any> = any

    +

    Type to use for document data. Defaults to any.

    +
+
+

Hierarchy

+
    +
  • GraphVertexCollection
+
+

Implements

+
+
+
+
+ +
+
+

Accessors

+
+
+

Methods

+
+
+

Accessors

+
+ +
+
+ +
    +
  • get graph(): Graph
  • +
  • +

    The Graph instance this vertex collection is bound to.

    +
    +

    Returns Graph

+
+ +
    +
  • get name(): string
  • +
  • +

    Name of the collection.

    +
    +

    Returns string

+
+

Methods

+
+ +
    + +
  • +

    Removes an existing vertex from the collection.

    +

    Throws an exception when passed a vertex or _id from a different +collection.

    + +

    Example

    const graph = db.graph("some-graph");
    const collection = graph.vertexCollection("vertices");
    await collection.remove("abc123");
    // document with key "abc123" deleted +
    + +

    Example

    const graph = db.graph("some-graph");
    const collection = graph.vertexCollection("vertices");
    const doc = await collection.vertex("abc123");
    await collection.remove(doc);
    // document with key "abc123" deleted +
    +
    +
    +

    Parameters

    +
    +

    Returns Promise<DocumentMetadata & {
        old?: Document<T>;
    }>

+
+ +
    + +
  • +

    Replaces an existing vertex in the collection.

    +

    Throws an exception when passed a vertex or _id from a different +collection.

    + +

    Example

    const graph = db.graph("some-graph");
    const collection = graph.collection("vertices");
    await collection.save({ _key: "a", color: "blue", count: 1 });
    const result = await collection.replace(
    "a",
    { color: "red" },
    { returnNew: true }
    );
    console.log(result.new.color, result.new.count); // "red" undefined +
    +
    +
    +

    Parameters

    +
    +

    Returns Promise<DocumentMetadata & {
        new?: Document<T>;
        old?: Document<T>;
    }>

+
+ +
    + +
  • +

    Inserts a new vertex with the given data into the collection.

    + +

    Example

    const graph = db.graph("some-graph");
    const collection = graph.vertexCollection("friends");
    const result = await collection.save(
    { _key: "a", color: "blue", count: 1 },
    { returnNew: true }
    );
    console.log(result.new.color, result.new.count); // "blue" 1 +
    +
    +
    +

    Parameters

    +
    +

    Returns Promise<DocumentMetadata & {
        new?: Document<T>;
    }>

+
+ +
    + +
  • +

    Updates an existing vertex in the collection.

    +

    Throws an exception when passed a vertex or _id from a different +collection.

    + +

    Example

    const graph = db.graph("some-graph");
    const collection = graph.collection("vertices");
    await collection.save({ _key: "a", color: "blue", count: 1 });
    const result = await collection.update(
    "a",
    { count: 2 },
    { returnNew: true }
    );
    console.log(result.new.color, result.new.count); // "blue" 2 +
    +
    +
    +

    Parameters

    +
    +

    Returns Promise<DocumentMetadata & {
        new?: Document<T>;
        old?: Document<T>;
    }>

+
+ +
    + +
  • +

    Retrieves the vertex matching the given key or id.

    +

    Throws an exception when passed a vertex or _id from a different +collection.

    + +

    Example

    const graph = db.graph("some-graph");
    const collection = graph.vertexCollection("vertices");
    try {
    const vertex = await collection.vertex("abc123");
    console.log(vertex);
    } catch (e: any) {
    console.error("Could not find vertex");
    } +
    + +

    Example

    const graph = db.graph("some-graph");
    const collection = graph.vertexCollection("vertices");
    const vertex = await collection.vertex("abc123", { graceful: true });
    if (vertex) {
    console.log(vertex);
    } else {
    console.error("Could not find vertex");
    } +
    +
    +
    +

    Parameters

    +
      +
    • +
      selector: DocumentSelector
      +

      Document _key, _id or object with either of those +properties (e.g. a vertex from this collection).

      +
    • +
    • +
      Optional options: GraphCollectionReadOptions
      +

      Options for retrieving the vertex.

      +
    +

    Returns Promise<Document<T>>

  • + +
  • +

    Retrieves the vertex matching the given key or id.

    +

    Throws an exception when passed a vertex or _id from a different +collection.

    + +

    Example

    const graph = db.graph("some-graph");
    const collection = graph.vertexCollection("vertices");
    try {
    const vertex = await collection.vertex("abc123", false);
    console.log(vertex);
    } catch (e: any) {
    console.error("Could not find vertex");
    } +
    + +

    Example

    const graph = db.graph("some-graph");
    const collection = graph.vertexCollection("vertices");
    const vertex = await collection.vertex("abc123", true);
    if (vertex) {
    console.log(vertex);
    } else {
    console.error("Could not find vertex");
    } +
    +
    +
    +

    Parameters

    +
      +
    • +
      selector: DocumentSelector
      +

      Document _key, _id or object with either of those +properties (e.g. a vertex from this collection).

      +
    • +
    • +
      graceful: boolean
      +

      If set to true, null is returned instead of an +exception being thrown if the vertex does not exist.

      +
    +

    Returns Promise<Document<T>>

+
+ +
    + +
  • +

    Checks whether a vertex matching the given key or id exists in this +collection.

    +

    Throws an exception when passed a vertex or _id from a different +collection.

    + +

    Example

    const graph = db.graph("some-graph");
    const collection = graph.vertexCollection("vertices");
    const exists = await collection.vertexExists("abc123");
    if (!exists) {
    console.log("Vertex does not exist");
    } +
    +
    +
    +

    Parameters

    +
      +
    • +
      selector: DocumentSelector
      +

      Document _key, _id or object with either of those +properties (e.g. a vertex from this collection).

      +
    +

    Returns Promise<boolean>

+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/classes/job.Job.html b/8.8.0/classes/job.Job.html new file mode 100644 index 000000000..5890b50b8 --- /dev/null +++ b/8.8.0/classes/job.Job.html @@ -0,0 +1,165 @@ +Job | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Class Job<T>

+
+

Represents an async job in a Database.

+
+
+

Type Parameters

+
    +
  • +

    T = any

+
+

Hierarchy

+
    +
  • Job
+
+
+
+ +
+
+

Accessors

+
+
+

Methods

+
+
+

Accessors

+
+ +
    +
  • get isLoaded(): boolean
  • +
  • +

    Whether the job's results have been loaded. If set to true, the job's +result can be accessed from result.

    +
    +

    Returns boolean

+
+ +
    +
  • get result(): undefined | T
  • +
  • +

    The job's result if it has been loaded or undefined otherwise.

    +
    +

    Returns undefined | T

+
+

Methods

+
+ +
    + +
  • +

    Cancels the job if it is still running. Note that it may take some time to +actually cancel the job.

    +
    +

    Returns Promise<void>

+
+ +
    + +
  • +

    Deletes the result if it has not already been retrieved or deleted.

    +
    +

    Returns Promise<void>

+
+ +
    + +
  • +

    Fetches the job's completion state.

    +

    Returns true if the job has completed, false otherwise.

    + +

    Example

    // poll for the job to complete
    while (!(await job.getCompleted())) {
    await timeout(1000);
    }
    // job result is now available and can be loaded
    await job.load();
    console.log(job.result); +
    +
    +

    Returns Promise<boolean>

+
+ +
    + +
  • +

    Loads the job's result from the database if it is not already loaded.

    + +

    Example

    // poll for the job to complete
    while (!job.isLoaded) {
    await timeout(1000);
    const result = await job.load();
    console.log(result);
    }
    // job result is now loaded and can also be accessed from job.result
    console.log(job.result); +
    +
    +

    Returns Promise<undefined | T>

+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/classes/route.Route.html b/8.8.0/classes/route.Route.html new file mode 100644 index 000000000..8ab81532b --- /dev/null +++ b/8.8.0/classes/route.Route.html @@ -0,0 +1,469 @@ +Route | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Class Route

+
+

Represents an arbitrary route relative to an ArangoDB database.

+
+
+

Hierarchy

+
    +
  • Route
+
+
+
+ +
+
+

Methods

+
+
+

Methods

+
+ +
    + +
  • +

    Performs a DELETE request against the given path relative to this route +and returns the server response.

    + +

    Example

    const db = new Database();
    const foxx = db.route("/my-foxx-service");
    const res = await foxx.delete("/users/admin"); +
    +
    +
    +

    Parameters

    +
      +
    • +
      path: string
      +

      Path relative to this route.

      +
    • +
    • +
      Optional qs: string | Params
      +

      Query string parameters for this request.

      +
    • +
    • +
      Optional headers: Headers
      +

      Additional headers to send with this request.

      +
    +

    Returns Promise<ArangojsResponse>

  • + +
  • +

    Performs a DELETE request against the given path relative to this route +and returns the server response.

    + +

    Example

    const db = new Database();
    const foxx = db.route("/my-foxx-service");
    const user = foxx.roue("/users/admin");
    const res = await user.delete(); +
    +
    +
    +

    Parameters

    +
      +
    • +
      Optional qs: Params
      +

      Query string parameters for this request.

      +
    • +
    • +
      Optional headers: Headers
      +

      Additional headers to send with this request.

      +
    +

    Returns Promise<ArangojsResponse>

+
+ +
    + +
  • +

    Performs a GET request against the given path relative to this route +and returns the server response.

    + +

    Example

    const db = new Database();
    const foxx = db.route("/my-foxx-service");
    const res = await foxx.get("/users", { offset: 10, limit: 5 }); +
    +
    +
    +

    Parameters

    +
      +
    • +
      path: string
      +

      Path relative to this route.

      +
    • +
    • +
      Optional qs: string | Params
      +

      Query string parameters for this request.

      +
    • +
    • +
      Optional headers: Headers
      +

      Additional headers to send with this request.

      +
    +

    Returns Promise<ArangojsResponse>

  • + +
  • +

    Performs a GET request against the given path relative to this route +and returns the server response.

    + +

    Example

    const db = new Database();
    const foxx = db.route("/my-foxx-service");
    const users = foxx.route("/users");
    const res = await users.get({ offset: 10, limit: 5 }); +
    +
    +
    +

    Parameters

    +
      +
    • +
      Optional qs: Params
      +

      Query string parameters for this request.

      +
    • +
    • +
      Optional headers: Headers
      +

      Additional headers to send with this request.

      +
    +

    Returns Promise<ArangojsResponse>

+
+ +
    + +
  • +

    Performs a HEAD request against the given path relative to this route +and returns the server response.

    + +

    Example

    const db = new Database();
    const foxx = db.route("/my-foxx-service");
    const res = await foxx.head("/users", { offset: 10, limit: 5 }); +
    +
    +
    +

    Parameters

    +
      +
    • +
      path: string
      +

      Path relative to this route.

      +
    • +
    • +
      Optional qs: string | Params
      +

      Query string parameters for this request.

      +
    • +
    • +
      Optional headers: Headers
      +

      Additional headers to send with this request.

      +
    +

    Returns Promise<ArangojsResponse>

  • + +
  • +

    Performs a HEAD request against the given path relative to this route +and returns the server response.

    + +

    Example

    const db = new Database();
    const foxx = db.route("/my-foxx-service");
    const users = foxx.route("/users");
    const res = await users.head({ offset: 10, limit: 5 }); +
    +
    +
    +

    Parameters

    +
      +
    • +
      Optional qs: Params
      +

      Query string parameters for this request.

      +
    • +
    • +
      Optional headers: Headers
      +

      Additional headers to send with this request.

      +
    +

    Returns Promise<ArangojsResponse>

+
+ +
    + +
  • +

    Performs a PATCH request against the given path relative to this route +and returns the server response.

    + +

    Example

    const db = new Database();
    const foxx = db.route("/my-foxx-service");
    const res = await foxx.patch("/users/admin", { password: "admin" }); +
    +
    +
    +

    Parameters

    +
      +
    • +
      path: string
      +

      Path relative to this route.

      +
    • +
    • +
      Optional body: any
      +

      Body of the request object.

      +
    • +
    • +
      Optional qs: string | Params
      +

      Query string parameters for this request.

      +
    • +
    • +
      Optional headers: Headers
      +

      Additional headers to send with this request.

      +
    +

    Returns Promise<ArangojsResponse>

  • + +
  • +

    Performs a PATCH request against the given path relative to this route +and returns the server response.

    +

    Note: body must not be a string.

    + +

    Example

    const db = new Database();
    const foxx = db.route("/my-foxx-service");
    const user = foxx.route("/users/admin")
    const res = await user.patch({ password: "admin" }); +
    +
    +
    +

    Parameters

    +
      +
    • +
      Optional body: any
      +

      Body of the request object. Must not be a string.

      +
    • +
    • +
      Optional qs: string | Params
      +

      Query string parameters for this request.

      +
    • +
    • +
      Optional headers: Headers
      +

      Additional headers to send with this request.

      +
    +

    Returns Promise<ArangojsResponse>

+
+ +
    + +
  • +

    Performs a POST request against the given path relative to this route +and returns the server response.

    + +

    Example

    const db = new Database();
    const foxx = db.route("/my-foxx-service");
    const res = await foxx.post("/users", {
    username: "admin",
    password: "hunter2"
    }); +
    +
    +
    +

    Parameters

    +
      +
    • +
      path: string
      +

      Path relative to this route.

      +
    • +
    • +
      Optional body: any
      +

      Body of the request object.

      +
    • +
    • +
      Optional qs: string | Params
      +

      Query string parameters for this request.

      +
    • +
    • +
      Optional headers: Headers
      +

      Additional headers to send with this request.

      +
    +

    Returns Promise<ArangojsResponse>

  • + +
  • +

    Performs a POST request against the given path relative to this route +and returns the server response.

    +

    Note: body must not be a string.

    + +

    Example

    const db = new Database();
    const foxx = db.route("/my-foxx-service");
    const users = foxx.route("/users");
    const res = await users.post({
    username: "admin",
    password: "hunter2"
    }); +
    +
    +
    +

    Parameters

    +
      +
    • +
      Optional body: any
      +

      Body of the request object. Must not be a string.

      +
    • +
    • +
      Optional qs: string | Params
      +

      Query string parameters for this request.

      +
    • +
    • +
      Optional headers: Headers
      +

      Additional headers to send with this request.

      +
    +

    Returns Promise<ArangojsResponse>

+
+ +
    + +
  • +

    Performs a PUT request against the given path relative to this route +and returns the server response.

    + +

    Example

    const db = new Database();
    const foxx = db.route("/my-foxx-service");
    const res = await foxx.put("/users/admin/password", { password: "admin" }); +
    +
    +
    +

    Parameters

    +
      +
    • +
      path: string
      +

      Path relative to this route.

      +
    • +
    • +
      Optional body: any
      +

      Body of the request object.

      +
    • +
    • +
      Optional qs: string | Params
      +

      Query string parameters for this request.

      +
    • +
    • +
      Optional headers: Headers
      +

      Additional headers to send with this request.

      +
    +

    Returns Promise<ArangojsResponse>

  • + +
  • +

    Performs a PUT request against the given path relative to this route +and returns the server response.

    +

    Note: body must not be a string.

    + +

    Example

    const db = new Database();
    const foxx = db.route("/my-foxx-service");
    const password = foxx.route("/users/admin/password");
    const res = await password.put({ password: "admin" }); +
    +
    +
    +

    Parameters

    +
      +
    • +
      Optional body: any
      +

      Body of the request object. Must not be a string.

      +
    • +
    • +
      Optional qs: string | Params
      +

      Query string parameters for this request.

      +
    • +
    • +
      Optional headers: Headers
      +

      Additional headers to send with this request.

      +
    +

    Returns Promise<ArangojsResponse>

+
+ +
    + +
  • +

    Performs an arbitrary HTTP request relative to this route and returns the +server response.

    + +

    Example

    const db = new Database();
    const foxx = db.route("/my-foxx-service");
    const res = await foxx.request({
    method: "POST",
    path: "/users",
    body: {
    username: "admin",
    password: "hunter2"
    }
    }); +
    +
    +
    +

    Parameters

    +
      +
    • +
      Optional options: RequestOptions
      +

      Options for performing the request.

      +
    +

    Returns Promise<ArangojsResponse>

+
+ +
    + +
  • +

    Creates a new route relative to this route that inherits any of its default +HTTP headers.

    + +

    Example

    const db = new Database();
    const foxx = db.route("/my-foxx-service");
    const users = foxx.route("/users"); +
    +
    +
    +

    Parameters

    +
      +
    • +
      path: string
      +

      Path relative to this route.

      +
    • +
    • +
      Optional headers: Headers
      +

      Additional headers that will be sent with each request.

      +
    +

    Returns Route

+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/classes/transaction.Transaction.html b/8.8.0/classes/transaction.Transaction.html new file mode 100644 index 000000000..4e55dfd39 --- /dev/null +++ b/8.8.0/classes/transaction.Transaction.html @@ -0,0 +1,238 @@ +Transaction | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Class Transaction

+
+

Represents a streaming transaction in a Database.

+
+
+

Hierarchy

+
    +
  • Transaction
+
+
+
+ +
+
+

Accessors

+
id +
+
+

Methods

+
+
+

Accessors

+
+ +
    +
  • get id(): string
  • +
  • +

    Unique identifier of this transaction.

    +

    See transaction.

    +
    +

    Returns string

+
+

Methods

+
+ +
    + +
  • +

    Attempts to abort the transaction to the databases.

    + +

    Example

    const db = new Database();
    const col = db.collection("some-collection");
    const trx = db.beginTransaction(col);
    await trx.step(() => col.save({ hello: "world" }));
    const result = await trx.abort();
    // result indicates the updated transaction status +
    +
    +
    +

    Parameters

    +
    +

    Returns Promise<TransactionStatus>

+
+ +
    + +
  • +

    Attempts to commit the transaction to the databases.

    + +

    Example

    const db = new Database();
    const col = db.collection("some-collection");
    const trx = db.beginTransaction(col);
    await trx.step(() => col.save({ hello: "world" }));
    const result = await trx.commit();
    // result indicates the updated transaction status +
    +
    +
    +

    Parameters

    +
    +

    Returns Promise<TransactionStatus>

+
+ +
    + +
  • +

    Checks whether the transaction exists.

    + +

    Example

    const db = new Database();
    const trx = db.transaction("some-transaction");
    const result = await trx.exists();
    // result indicates whether the transaction exists +
    +
    +

    Returns Promise<boolean>

+
+ +
    + +
  • +

    Retrieves general information about the transaction.

    + +

    Example

    const db = new Database();
    const col = db.collection("some-collection");
    const trx = db.beginTransaction(col);
    await trx.step(() => col.save({ hello: "world" }));
    const info = await trx.get();
    // the transaction exists +
    +
    +

    Returns Promise<TransactionStatus>

+
+ +
    + +
  • +

    Executes the given function locally as a single step of the transaction.

    + +

    Example

    const db = new Database();
    const vertices = db.collection("vertices");
    const edges = db.collection("edges");
    const trx = await db.beginTransaction({ write: [vertices, edges] });

    // The following code will be part of the transaction
    const left = await trx.step(() => vertices.save({ label: "left" }));
    const right = await trx.step(() => vertices.save({ label: "right" }));

    // Results from preceding actions can be used normally
    await trx.step(() => edges.save({
    _from: left._id,
    _to: right._id,
    data: "potato"
    }));

    // Transaction must be committed for changes to take effected
    // Always call either trx.commit or trx.abort to end a transaction
    await trx.commit(); +
    + +

    Example

    // BAD! If the callback is an async function it must only use await once!
    await trx.step(async () => {
    await collection.save(data);
    await collection.save(moreData); // WRONG
    });

    // BAD! Callback function must use only one arangojs call!
    await trx.step(() => {
    return collection.save(data)
    .then(() => collection.save(moreData)); // WRONG
    });

    // BETTER: Wrap every arangojs method call that should be part of the
    // transaction in a separate `trx.step` call
    await trx.step(() => collection.save(data));
    await trx.step(() => collection.save(moreData)); +
    + +

    Example

    // BAD! If the callback is an async function it must not await before
    // calling an arangojs method!
    await trx.step(async () => {
    await doSomethingElse();
    return collection.save(data); // WRONG
    });

    // BAD! Any arangojs inside the callback must not happen inside a promise
    // method!
    await trx.step(() => {
    return doSomethingElse()
    .then(() => collection.save(data)); // WRONG
    });

    // BETTER: Perform any async logic needed outside the `trx.step` call
    await doSomethingElse();
    await trx.step(() => collection.save(data));

    // OKAY: You can perform async logic in the callback after the arangojs
    // method call as long as it does not involve additional arangojs method
    // calls, but this makes it easy to make mistakes later
    await trx.step(async () => {
    await collection.save(data);
    await doSomethingDifferent(); // no arangojs method calls allowed
    }); +
    + +

    Example

    // BAD! The callback should not use any functions that themselves use any
    // arangojs methods!
    async function saveSomeData() {
    await collection.save(data);
    await collection.save(moreData);
    }
    await trx.step(() => saveSomeData()); // WRONG

    // BETTER: Pass the transaction to functions that need to call arangojs
    // methods inside a transaction
    async function saveSomeData(trx) {
    await trx.step(() => collection.save(data));
    await trx.step(() => collection.save(moreData));
    }
    await saveSomeData(); // no `trx.step` call needed +
    + +

    Example

    // BAD! You must wait for the promise to resolve (or await on the
    // `trx.step` call) before calling `trx.step` again!
    trx.step(() => collection.save(data)); // WRONG
    await trx.step(() => collection.save(moreData));

    // BAD! The trx.step callback can not make multiple calls to async arangojs
    // methods, not even using Promise.all!
    await trx.step(() => Promise.all([ // WRONG
    collection.save(data),
    collection.save(moreData),
    ]));

    // BAD! Multiple `trx.step` calls can not run in parallel!
    await Promise.all([ // WRONG
    trx.step(() => collection.save(data)),
    trx.step(() => collection.save(moreData)),
    ]));

    // BETTER: Always call `trx.step` sequentially, one after the other
    await trx.step(() => collection.save(data));
    await trx.step(() => collection.save(moreData));

    // OKAY: The then callback can be used if async/await is not available
    trx.step(() => collection.save(data))
    .then(() => trx.step(() => collection.save(moreData))); +
    + +

    Example

    // BAD! The callback will return an empty promise that resolves before
    // the inner arangojs method call has even talked to ArangoDB!
    await trx.step(async () => {
    collection.save(data); // WRONG
    });

    // BETTER: Use an arrow function so you don't forget to return
    await trx.step(() => collection.save(data));

    // OKAY: Remember to always return when using a function body
    await trx.step(() => {
    return collection.save(data); // easy to forget!
    });

    // OKAY: You do not have to use arrow functions but it helps
    await trx.step(function () {
    return collection.save(data);
    }); +
    + +

    Example

    // BAD! You can not pass promises instead of a callback!
    await trx.step(collection.save(data)); // WRONG

    // BETTER: Wrap the code in a function and pass the function instead
    await trx.step(() => collection.save(data)); +
    + +

    Example

    // WORSE: Calls to non-async arangojs methods don't need to be performed
    // as part of a transaction
    const collection = await trx.step(() => db.collection("my-documents"));

    // BETTER: If an arangojs method is not async and doesn't return promises,
    // call it without `trx.step`
    const collection = db.collection("my-documents"); +
    +
    +
    +

    Type Parameters

    +
      +
    • +

      T

      +

      Type of the callback's returned promise.

      +
    +
    +

    Parameters

    +
      +
    • +
      callback: (() => Promise<T>)
      +

      Callback function returning a promise.

      +

      Warning: The callback function should wrap a single call of an async +arangojs method (e.g. a method on a Collection object of a collection +that is involved in the transaction or the db.query method). +If the callback function is async, only the first promise-returning (or +async) method call will be executed as part of the transaction. See the +examples below for how to avoid common mistakes when using this method.

      +

      Note: Avoid defining the callback as an async function if possible +as arangojs will throw an error if the callback did not return a promise. +Async functions will return an empty promise by default, making it harder +to notice if you forgot to return something from the callback.

      +

      Note: Although almost anything can be wrapped in a callback and passed +to this method, that does not guarantee ArangoDB can actually do it in a +transaction. Refer to the ArangoDB documentation if you are unsure whether +a given operation can be executed as part of a transaction. Generally any +modification or retrieval of data is eligible but modifications of +collections or databases are not.

      +
      +
        +
      • +
          +
        • (): Promise<T>
        • +
        • +

          Returns Promise<T>

    +

    Returns Promise<T>

+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/classes/view.View.html b/8.8.0/classes/view.View.html new file mode 100644 index 000000000..02db32586 --- /dev/null +++ b/8.8.0/classes/view.View.html @@ -0,0 +1,257 @@ +View | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Class View

+
+

Represents a View in a Database.

+
+
+

Hierarchy

+
    +
  • View
+
+
+
+ +
+
+

Accessors

+
+ +
    +
  • get name(): string
  • +
  • +

    Name of the View.

    +
    +

    Returns string

+
+

Methods

+
+ +
+
+ +
    + +
  • +

    Deletes the View from the database.

    + +

    Example

    const db = new Database();
    const view = db.view("some-view");
    await view.drop();
    // the View "some-view" no longer exists +
    +
    +

    Returns Promise<boolean>

+
+ +
    + +
  • +

    Checks whether the View exists.

    + +

    Example

    const db = new Database();
    const view = db.view("some-view");
    const exists = await view.exists();
    console.log(exists); // indicates whether the View exists +
    +
    +

    Returns Promise<boolean>

+
+ +
    + +
  • +

    Retrieves general information about the View.

    + +

    Example

    const db = new Database();
    const view = db.view("some-view");
    const data = await view.get();
    // data contains general information about the View +
    +
    +

    Returns Promise<ArangoApiResponse<ViewDescription>>

+
+ +
    + +
  • +

    Retrieves the View's properties.

    + +

    Example

    const db = new Database();
    const view = db.view("some-view");
    const data = await view.properties();
    // data contains the View's properties +
    +
    +

    Returns Promise<ArangoApiResponse<ViewProperties>>

+
+ +
    + +
  • +

    Renames the View and updates the instance's name to newName.

    +

    Additionally removes the instance from the Database's internal +cache.

    +

    Note: Renaming Views may not be supported when ArangoDB is +running in a cluster configuration.

    + +

    Example

    const db = new Database();
    const view1 = db.view("some-view");
    await view1.rename("other-view");
    const view2 = db.view("some-view");
    const view3 = db.view("other-view");
    // Note all three View instances are different objects but
    // view1 and view3 represent the same ArangoDB view! +
    +
    +
    +

    Parameters

    +
      +
    • +
      newName: string
      +

      The new name of the View.

      +
    +

    Returns Promise<ArangoApiResponse<ViewDescription>>

+
+ +
+
+ +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/enums/collection.CollectionStatus.html b/8.8.0/enums/collection.CollectionStatus.html new file mode 100644 index 000000000..85e1e2272 --- /dev/null +++ b/8.8.0/enums/collection.CollectionStatus.html @@ -0,0 +1,112 @@ +CollectionStatus | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Enumeration CollectionStatus

+
+

Integer values indicating the collection loading status.

+
+
+
+
+ +
+
+

Enumeration Members

+
+
+

Enumeration Members

+
+ +
DELETED: 5
+
+ +
LOADED: 3
+
+ +
LOADING: 6
+
+ +
NEWBORN: 1
+
+ +
UNLOADED: 2
+
+ +
UNLOADING: 4
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/enums/collection.CollectionType.html b/8.8.0/enums/collection.CollectionType.html new file mode 100644 index 000000000..e1adfb367 --- /dev/null +++ b/8.8.0/enums/collection.CollectionType.html @@ -0,0 +1,84 @@ +CollectionType | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Enumeration CollectionType

+
+

Integer values indicating the collection type.

+
+
+
+
+ +
+
+

Enumeration Members

+
+
+

Enumeration Members

+
+ +
DOCUMENT_COLLECTION: 2
+
+ +
EDGE_COLLECTION: 3
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/enums/database.LogLevel.html b/8.8.0/enums/database.LogLevel.html new file mode 100644 index 000000000..3d7e950de --- /dev/null +++ b/8.8.0/enums/database.LogLevel.html @@ -0,0 +1,105 @@ +LogLevel | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Enumeration LogLevel

+
+

Numeric representation of the logging level of a log entry.

+
+
+
+
+ +
+
+

Enumeration Members

+
+
+

Enumeration Members

+
+ +
DEBUG: 4
+
+ +
ERROR: 1
+
+ +
FATAL: 0
+
+ +
INFO: 3
+
+ +
WARNING: 2
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/functions/analyzer.isArangoAnalyzer.html b/8.8.0/functions/analyzer.isArangoAnalyzer.html new file mode 100644 index 000000000..9ae0231c8 --- /dev/null +++ b/8.8.0/functions/analyzer.isArangoAnalyzer.html @@ -0,0 +1,113 @@ +isArangoAnalyzer | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Function isArangoAnalyzer

+
+
    + +
  • +

    Indicates whether the given value represents an Analyzer.

    +
    +
    +

    Parameters

    +
      +
    • +
      analyzer: any
      +

      A value that might be an Analyzer.

      +
    +

    Returns analyzer is Analyzer

+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/functions/aql.aql.html b/8.8.0/functions/aql.aql.html new file mode 100644 index 000000000..3d51f38ff --- /dev/null +++ b/8.8.0/functions/aql.aql.html @@ -0,0 +1,106 @@ +aql | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Function aql

+
+
    + +
  • +

    Template string handler (template tag) for AQL queries.

    +

    The aql tag can be used to write complex AQL queries as multi-line strings +without having to worry about bindVars and the distinction between +collections and regular parameters.

    +

    Tagged template strings will return an AqlQuery object with +query and bindVars attributes reflecting any interpolated values.

    +

    Any ArangoCollection instance used in a query string will +be recognized as a collection reference and generate an AQL collection bind +parameter instead of a regular AQL value bind parameter.

    +

    Note: you should always use the aql template tag when writing +dynamic AQL queries instead of using untagged (normal) template strings. +Untagged template strings will inline any interpolated values and return +a plain string as result. The aql template tag will only inline references +to the interpolated values and produce an AQL query object containing both +the query and the values. This prevents most injection attacks when using +untrusted values in dynamic queries.

    + +

    Example

    // Some user-supplied string that may be malicious
    const untrustedValue = req.body.email;

    // Without aql tag: BAD! DO NOT DO THIS!
    const badQuery = `
    FOR user IN users
    FILTER user.email == "${untrustedValue}"
    RETURN user
    `;
    // e.g. if untrustedValue is '" || user.admin == true || "':
    // Query:
    // FOR user IN users
    // FILTER user.email == "" || user.admin == true || ""
    // RETURN user

    // With the aql tag: GOOD! MUCH SAFER!
    const betterQuery = aql`
    FOR user IN users
    FILTER user.email == ${untrustedValue}
    RETURN user
    `;
    // Query:
    // FOR user IN users
    // FILTER user.email == @value0
    // RETURN user
    // Bind parameters:
    // value0 -> untrustedValue +
    + +

    Example

    const collection = db.collection("some-collection");
    const minValue = 23;
    const result = await db.query(aql`
    FOR d IN ${collection}
    FILTER d.num > ${minValue}
    RETURN d
    `);

    // Equivalent raw query object
    const result2 = await db.query({
    query: `
    FOR d IN @@collection
    FILTER d.num > @minValue
    RETURN d
    `,
    bindVars: {
    "@collection": collection.name,
    minValue: minValue
    }
    }); +
    + +

    Example

    const collection = db.collection("some-collection");
    const color = "green";
    const filter = aql`FILTER d.color == ${color}'`;
    const result = await db.query(aql`
    FOR d IN ${collection}
    ${filter}
    RETURN d
    `); +
    +
    +
    +

    Type Parameters

    +
      +
    • +

      T = any

    +
    +

    Parameters

    +
      +
    • +
      templateStrings: TemplateStringsArray
    • +
    • +
      Rest ...args: AqlValue[]
    +

    Returns GeneratedAqlQuery<T>

+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/functions/aql.isAqlLiteral.html b/8.8.0/functions/aql.isAqlLiteral.html new file mode 100644 index 000000000..5e3e2b740 --- /dev/null +++ b/8.8.0/functions/aql.isAqlLiteral.html @@ -0,0 +1,77 @@ +isAqlLiteral | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Function isAqlLiteral

+
+
    + +
  • +

    Indicates whether the given value is an AqlLiteral.

    +
    +
    +

    Parameters

    +
      +
    • +
      literal: any
      +

      A value that might be an AqlLiteral.

      +
    +

    Returns literal is AqlLiteral

+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/functions/aql.isAqlQuery.html b/8.8.0/functions/aql.isAqlQuery.html new file mode 100644 index 000000000..e1227536e --- /dev/null +++ b/8.8.0/functions/aql.isAqlQuery.html @@ -0,0 +1,77 @@ +isAqlQuery | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Function isAqlQuery

+
+
    + +
  • +

    Indicates whether the given value is an AqlQuery.

    +
    +
    +

    Parameters

    +
      +
    • +
      query: any
      +

      A value that might be an AqlQuery.

      +
    +

    Returns query is AqlQuery<any>

+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/functions/aql.join.html b/8.8.0/functions/aql.join.html new file mode 100644 index 000000000..012ab7eba --- /dev/null +++ b/8.8.0/functions/aql.join.html @@ -0,0 +1,94 @@ +join | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Function join

+
+
    + +
  • +

    Constructs AqlQuery objects from an array of arbitrary values.

    +

    Note: Nesting aql template strings is a much safer alternative +for most use cases. This low-level helper function only exists to +complement the aql tag when constructing complex queries from dynamic +arrays of query fragments.

    + +

    Example

    const users = db.collection("users");
    const filters = [];
    if (adminsOnly) filters.push(aql`FILTER user.admin`);
    if (activeOnly) filters.push(aql`FILTER user.active`);
    const result = await db.query(aql`
    FOR user IN ${users}
    ${join(filters)}
    RETURN user
    `); +
    + +

    Example

    const users = db.collection("users");
    const keys = ["jreyes", "ghermann"];

    // BAD! NEEDLESSLY COMPLEX!
    const docs = keys.map(key => aql`DOCUMENT(${users}, ${key}`));
    const result = await db.query(aql`
    FOR user IN [
    ${join(docs, ", ")}
    ]
    RETURN user
    `);
    // Query:
    // FOR user IN [
    // DOCUMENT(@@value0, @value1), DOCUMENT(@@value0, @value2)
    // ]
    // RETURN user
    // Bind parameters:
    // @value0 -> "users"
    // value1 -> "jreyes"
    // value2 -> "ghermann"

    // GOOD! MUCH SIMPLER!
    const result = await db.query(aql`
    FOR key IN ${keys}
    LET user = DOCUMENT(${users}, key)
    RETURN user
    `);
    // Query:
    // FOR user IN @value0
    // LET user = DOCUMENT(@@value1, key)
    // RETURN user
    // Bind parameters:
    // value0 -> ["jreyes", "ghermann"]
    // @value1 -> "users" +
    +
    +
    +

    Parameters

    +
      +
    • +
      values: AqlValue[]
      +

      Array of values to join. These values will behave exactly +like values interpolated in an aql template string.

      +
    • +
    • +
      sep: string = " "
      +

      Seperator to insert between values. This value will behave +exactly like a value passed to literal, i.e. it will be +inlined as-is, rather than being converted into a bind parameter.

      +
    +

    Returns GeneratedAqlQuery

+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/functions/aql.literal.html b/8.8.0/functions/aql.literal.html new file mode 100644 index 000000000..0d582e0e4 --- /dev/null +++ b/8.8.0/functions/aql.literal.html @@ -0,0 +1,91 @@ +literal | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Function literal

+
+
    + +
  • +

    Marks an arbitrary scalar value (i.e. a string, number or boolean) as +safe for being inlined directly into AQL queries when used in an aql +template string, rather than being converted into a bind parameter.

    +

    Note: Nesting aql template strings is a much safer alternative for +most use cases. This low-level helper function only exists to help with +rare edge cases where a trusted AQL query fragment must be read from a +string (e.g. when reading query fragments from JSON) and should only be +used as a last resort.

    + +

    Example

    // BAD! DO NOT DO THIS!
    const sortDirection = literal('ASC');

    // GOOD! DO THIS INSTEAD!
    const sortDirection = aql`ASC`; +
    + +

    Example

    // BAD! DO NOT DO THIS!
    const filterColor = literal('FILTER d.color == "green"');
    const result = await db.query(aql`
    FOR d IN some-collection
    ${filterColor}
    RETURN d
    `);

    // GOOD! DO THIS INSTEAD!
    const color = "green";
    const filterColor = aql`FILTER d.color === ${color}`;
    const result = await db.query(aql`
    FOR d IN some-collection
    ${filterColor}
    RETURN d
    `); +
    + +

    Example

    // WARNING: We explicitly trust the environment variable to be safe!
    const filter = literal(process.env.FILTER_STATEMENT);
    const users = await db.query(aql`
    FOR user IN users
    ${filter}
    RETURN user
    `); +
    +
    +
    +

    Parameters

    +
      +
    • +
      value: undefined | null | string | number | boolean | AqlLiteral
    +

    Returns AqlLiteral

+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/functions/collection.collectionToString.html b/8.8.0/functions/collection.collectionToString.html new file mode 100644 index 000000000..fa48a38e1 --- /dev/null +++ b/8.8.0/functions/collection.collectionToString.html @@ -0,0 +1,119 @@ +collectionToString | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Function collectionToString

+
+
    + +
  • +

    Coerces the given collection name or ArangoCollection object to +a string representing the collection name.

    +
    +
    +

    Parameters

    +
    +

    Returns string

+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/functions/collection.isArangoCollection.html b/8.8.0/functions/collection.isArangoCollection.html new file mode 100644 index 000000000..719149643 --- /dev/null +++ b/8.8.0/functions/collection.isArangoCollection.html @@ -0,0 +1,118 @@ +isArangoCollection | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Function isArangoCollection

+
+
    + +
  • +

    Indicates whether the given value represents an ArangoCollection.

    +
    +
    +

    Parameters

    +
      +
    • +
      collection: any
      +

      A value that might be a collection.

      +
    +

    Returns collection is ArangoCollection

+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/functions/database.isArangoDatabase.html b/8.8.0/functions/database.isArangoDatabase.html new file mode 100644 index 000000000..58892a77c --- /dev/null +++ b/8.8.0/functions/database.isArangoDatabase.html @@ -0,0 +1,133 @@ +isArangoDatabase | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Function isArangoDatabase

+
+
    + +
  • +

    Indicates whether the given value represents a Database.

    +
    +
    +

    Parameters

    +
      +
    • +
      database: any
      +

      A value that might be a database.

      +
    +

    Returns database is Database

+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/functions/error.isArangoError.html b/8.8.0/functions/error.isArangoError.html new file mode 100644 index 000000000..f9d7016ab --- /dev/null +++ b/8.8.0/functions/error.isArangoError.html @@ -0,0 +1,74 @@ +isArangoError | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Function isArangoError

+
+
    + +
  • +

    Indicates whether the given value represents an ArangoError.

    +
    +
    +

    Parameters

    +
      +
    • +
      error: any
      +

      A value that might be an ArangoError.

      +
    +

    Returns error is ArangoError

+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/functions/error.isSystemError.html b/8.8.0/functions/error.isSystemError.html new file mode 100644 index 000000000..d2cabb582 --- /dev/null +++ b/8.8.0/functions/error.isSystemError.html @@ -0,0 +1,72 @@ +isSystemError | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Function isSystemError

+
+
    + +
  • +

    Indicates whether the given value represents a Node.js SystemError.

    +
    +
    +

    Parameters

    +
      +
    • +
      err: any
    +

    Returns err is SystemError

+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/functions/graph.isArangoGraph.html b/8.8.0/functions/graph.isArangoGraph.html new file mode 100644 index 000000000..c0ebe2bab --- /dev/null +++ b/8.8.0/functions/graph.isArangoGraph.html @@ -0,0 +1,84 @@ +isArangoGraph | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Function isArangoGraph

+
+
    + +
  • +

    Indicates whether the given value represents a Graph.

    +
    +
    +

    Parameters

    +
      +
    • +
      graph: any
      +

      A value that might be a Graph.

      +
    +

    Returns graph is Graph

+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/functions/index.arangojs.html b/8.8.0/functions/index.arangojs.html new file mode 100644 index 000000000..8fb7c092e --- /dev/null +++ b/8.8.0/functions/index.arangojs.html @@ -0,0 +1,98 @@ +arangojs | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Function arangojs

+
+
    + +
  • +

    Creates a new Database instance with its own connection pool.

    +

    This is a wrapper function for the new Database.

    + +

    Example

    const db = arangojs({
    url: "http://127.0.0.1:8529",
    databaseName: "myDatabase",
    auth: { username: "admin", password: "hunter2" },
    }); +
    +
    +
    +

    Parameters

    +
      +
    • +
      Optional config: Config
      +

      An object with configuration options.

      +
    +

    Returns Database

  • + +
  • +

    Creates a new Database instance with its own connection pool.

    +

    This is a wrapper function for the new Database.

    + +

    Example

    const db = arangojs("http://127.0.0.1:8529", "myDatabase");
    db.useBasicAuth("admin", "hunter2"); +
    +
    +
    +

    Parameters

    +
      +
    • +
      url: string | string[]
      +

      Base URL of the ArangoDB server or list of server URLs. +Equivalent to the url option in Config.

      +
    • +
    • +
      Optional name: string
    +

    Returns Database

+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/functions/transaction.isArangoTransaction.html b/8.8.0/functions/transaction.isArangoTransaction.html new file mode 100644 index 000000000..88b800381 --- /dev/null +++ b/8.8.0/functions/transaction.isArangoTransaction.html @@ -0,0 +1,74 @@ +isArangoTransaction | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Function isArangoTransaction

+
+
    + +
  • +

    Indicates whether the given value represents a Transaction.

    +
    +
    +

    Parameters

    +
      +
    • +
      transaction: any
      +

      A value that might be a transaction.

      +
    +

    Returns transaction is Transaction

+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/functions/view.isArangoView.html b/8.8.0/functions/view.isArangoView.html new file mode 100644 index 000000000..1fd0334ac --- /dev/null +++ b/8.8.0/functions/view.isArangoView.html @@ -0,0 +1,96 @@ +isArangoView | arangojs - v8.8.0
+
+ +
+ +
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/index.html b/8.8.0/index.html new file mode 100644 index 000000000..94e7394c1 --- /dev/null +++ b/8.8.0/index.html @@ -0,0 +1,264 @@ +arangojs - v8.8.0
+
+ +
+
+
+
+

arangojs - v8.8.0

+
+ +

ArangoDB JavaScript Driver

+
+

The official ArangoDB JavaScript client for Node.js and the browser.

+

license - APACHE-2.0 +Continuous Integration

+

npm package status

+ + +

Links

+
+ + + +

Install

+
+ + +

With npm or yarn

+
+
npm install --save arangojs
## - or -
yarn add arangojs +
+ + +

For browsers

+
+

When using modern JavaScript tooling with a bundler and compiler (e.g. Babel), +arangojs can be installed using npm or yarn like any other dependency.

+

For use without a compiler, the npm release comes with a precompiled browser +build for evergreen browsers:

+
var arangojs = require("arangojs/web");
+
+

You can also use unpkg during development:

+
< !-- note the path includes the version number (e.g. 8.0.0) -- >
<script src="https://unpkg.com/arangojs@8.0.0/web.js"></script>
<script>
var db = new arangojs.Database();
// ...
</script> +
+

When loading the browser build with a script tag make sure to load the polyfill first:

+
<script src="https://cdnjs.cloudflare.com/ajax/libs/babel-polyfill/6.26.0/polyfill.js"></script>
<script src="https://unpkg.com/arangojs@8.0.0/web.js"></script> +
+ + +

Basic usage example

+
+

Modern JavaScript/TypeScript with async/await:

+
// TS: import { Database, aql } from "arangojs";
const { Database, aql } = require("arangojs");

const db = new Database();
const Pokemons = db.collection("my-pokemons");

async function main() {
try {
const pokemons = await db.query(aql`
FOR pokemon IN ${Pokemons}
FILTER pokemon.type == "fire"
RETURN pokemon
`);
console.log("My pokemons, let me show you them:");
for await (const pokemon of pokemons) {
console.log(pokemon.name);
}
} catch (err) {
console.error(err.message);
}
}

main(); +
+

Using a different database:

+
const db = new Database({
url: "http://127.0.0.1:8529",
databaseName: "pancakes",
auth: { username: "root", password: "hunter2" },
});

// The credentials can be swapped at any time
db.useBasicAuth("admin", "maplesyrup"); +
+

Old-school JavaScript with promises:

+
var arangojs = require("arangojs");
var Database = arangojs.Database;

var db = new Database();
var pokemons = db.collection("pokemons");

db.query({
query: "FOR p IN @@c FILTER p.type == 'fire' RETURN p",
bindVars: { "@c": "pokemons" },
})
.then(function (cursor) {
console.log("My pokemons, let me show you them:");
return cursor.forEach(function (pokemon) {
console.log(pokemon.name);
});
})
.catch(function (err) {
console.error(err.message);
}); +
+

Note: The examples throughout this documentation use async/await +and other modern language features like multi-line strings and template tags. +When developing for an environment without support for these language features, +substitute promises for await syntax as in the above example.

+ + +

Compatibility

+
+

The arangojs driver is compatible with the latest stable version of ArangoDB +available at the time of the driver release and remains compatible with the +two most recent Node.js LTS versions in accordance with the official +Node.js long-term support schedule. Versions +of ArangoDB that have reached their end of life +by the time of a driver release are explicitly not supported.

+

For a list of changes between recent versions of the driver, see the +CHANGELOG.

+

Note: arangojs is only intended to be used in Node.js or a browser to access +ArangoDB from outside the database. If you are looking for the ArangoDB +JavaScript API for Foxx or for accessing ArangoDB +from within the arangosh interactive shell, please refer to the documentation +of the @arangodb module +and the db object instead.

+ + +

Error responses

+
+

If arangojs encounters an API error, it will throw an ArangoError with +an errorNum property indicating the ArangoDB error code and the code +property indicating the HTTP status code from the response body.

+

For any other non-ArangoDB error responses (4xx/5xx status code), it will throw +an HttpError error with the status code indicated by the code property.

+

If the server response did not indicate an error but the response body could +not be parsed, a regular SyntaxError may be thrown instead.

+

In all of these cases the server response object will be exposed as the +response property on the error object.

+

If the request failed at a network level or the connection was closed without +receiving a response, the underlying system error will be thrown instead.

+ + +

Common issues

+
+ + +

Missing functions or unexpected server errors

+
+

Please make sure you are using the latest version of this driver and that the +version of the arangojs documentation you are reading matches that version.

+

Changes in the major version number of arangojs (e.g. 7.x.y -> 8.0.0) indicate +backwards-incompatible changes in the arangojs API that may require changes in +your code when upgrading your version of arangojs.

+

Additionally please ensure that your version of Node.js (or browser) and +ArangoDB are supported by the version of arangojs you are trying to use. See +the compatibility section for additional information.

+

Note: As of June 2018 ArangoDB 2.8 has reached its End of Life and is no +longer supported in arangojs 7 and later. If your code needs to work with +ArangoDB 2.8 you can continue using arangojs 6 and enable ArangoDB 2.8 +compatibility mode by setting the config option arangoVersion: 20800 to +enable the ArangoDB 2.8 compatibility mode in arangojs 6.

+

You can install an older version of arangojs using npm or yarn:

+
# for version 6.x.x
yarn add arangojs@6
# - or -
npm install --save arangojs@6 +
+ + +

No code intelligence when using require instead of import

+
+

If you are using require to import the arangojs module in JavaScript, the +default export might not be recognized as a function by the code intelligence +of common editors like Visual Studio Code, breaking auto-complete and other +useful features.

+

As a workaround, use the arangojs function exported by that module instead +of calling the module itself:

+
  const arangojs = require("arangojs");

- const db = arangojs({
+ const db = arangojs.arangojs({
url: ARANGODB_SERVER,
}); +
+

Alternatively you can use the Database class directly:

+
  const arangojs = require("arangojs");
+ const Database = arangojs.Database;

- const db = arangojs({
+ const db = new Database({
url: ARANGODB_SERVER,
}); +
+

Or using object destructuring:

+
- const arangojs = require("arangojs");
+ const { Database } = require("arangojs");

- const db = arangojs({
+ const db = new Database({
url: ARANGODB_SERVER,
}); +
+ + +

Error stack traces contain no useful information

+
+

Due to the async, queue-based behavior of arangojs, the stack traces generated +when an error occur rarely provide enough information to determine the location +in your own code where the request was initiated.

+

Using the precaptureStackTraces configuration option, arangojs will attempt +to always generate stack traces proactively when a request is performed, +allowing arangojs to provide more meaningful stack traces at the cost of an +impact to performance even when no error occurs.

+
  const { Database } = require("arangojs");

const db = new Database({
url: ARANGODB_SERVER,
+ precaptureStackTraces: true,
}); +
+

Note that arangojs will attempt to use Error.captureStackTrace if available +and fall back to generating a stack trace by throwing an error. In environments +that do not support the stack property on error objects, this option will +still impact performance but not result in any additional information becoming +available.

+ + +

Node.js ReferenceError: window is not defined

+
+

If you compile your Node project using a build tool like Webpack, you may need +to tell it to +target the correct environment:

+
// webpack.config.js
+ "target": "node", +
+

To support use in both browser and Node environments arangojs uses the +package.json browser field, +to substitute browser-specific implementations for certain modules. +Build tools like Webpack will respect this field when targetting a browser +environment and may need to be explicitly told you are targetting Node instead.

+ + +

Node.js with self-signed HTTPS certificates

+
+

If you need to support self-signed HTTPS certificates, you may have to add +your certificates to the agentOptions, e.g.:

+
  const { Database } = require("arangojs");

const db = new Database({
url: ARANGODB_SERVER,
+ agentOptions: {
+ ca: [
+ fs.readFileSync(".ssl/sub.class1.server.ca.pem"),
+ fs.readFileSync(".ssl/ca.pem")
+ ]
+ },
}); +
+

Although this is strongly discouraged, it's also possible to disable +HTTPS certificate validation entirely, but note this has +extremely dangerous security implications:

+
  const { Database } = require("arangojs");

const db = new Database({
url: ARANGODB_SERVER,
+ agentOptions: {
+ rejectUnauthorized: false
+ },
}); +
+

When using arangojs in the browser, self-signed HTTPS certificates need to +be trusted by the browser or use a trusted root certificate.

+ + +

Streaming transactions leak

+
+

When using the transaction.step method it is important to be aware of the +limitations of what a callback passed to this method is allowed to do.

+
const collection = db.collection(collectionName);
const trx = db.transaction(transactionId);

// WARNING: This code will not work as intended!
await trx.step(async () => {
await collection.save(doc1);
await collection.save(doc2); // Not part of the transaction!
});

// INSTEAD: Always perform a single operation per step:
await trx.step(() => collection.save(doc1));
await trx.step(() => collection.save(doc2)); +
+

Please refer to the documentation of this method for additional examples.

+ + +

Streaming transactions timeout in cluster

+
+

Example messages: transaction not found, transaction already expired.

+

Transactions have +different guarantees +in a cluster.

+

When using arangojs in a cluster with load balancing, you may need to adjust +the value of agentOptions.maxSockets to accommodate the number of transactions +you need to be able to run in parallel. The default value is likely to be too +low for most cluster scenarios involving frequent streaming transactions.

+

Note: When using a high value for agentOptions.maxSockets you may have +to adjust the maximum number of threads in the ArangoDB configuration using +the server.maximal-threads option +to support larger numbers of concurrent transactions on the server side.

+ + +

License

+
+

The Apache License, Version 2.0. For more information, see the accompanying +LICENSE file.

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/interfaces/aql.AqlLiteral.html b/8.8.0/interfaces/aql.AqlLiteral.html new file mode 100644 index 000000000..ab1463e67 --- /dev/null +++ b/8.8.0/interfaces/aql.AqlLiteral.html @@ -0,0 +1,73 @@ +AqlLiteral | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Interface AqlLiteral

+
+

An object representing a trusted AQL literal that will be inlined directly +when used in an AQL template or passed to AQL helper functions.

+

Arbitrary values can be converted to trusted AQL literals by passing them +to the literal helper function.

+
+
+

Hierarchy

+
    +
  • AqlLiteral
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/interfaces/aql.AqlQuery.html b/8.8.0/interfaces/aql.AqlQuery.html new file mode 100644 index 000000000..91d93aeda --- /dev/null +++ b/8.8.0/interfaces/aql.AqlQuery.html @@ -0,0 +1,107 @@ +AqlQuery | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Interface AqlQuery<T>

+
+

Generic AQL query object consisting of an AQL query string and its bind +parameters.

+
+
+

Type Parameters

+
    +
  • +

    T = any

+
+

Hierarchy

+
    +
  • AqlQuery
+
+
+
+ +
+
+

Properties

+
+
+

Properties

+
+ +
[type]?: any
+
+ +
bindVars: Record<string, any>
+

An object mapping AQL bind parameter names to their respective values.

+

Names of parameters representing collections are prefixed with an +at-symbol.

+
+
+ +
query: string
+

An AQL query string.

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/interfaces/collection.ArangoCollection.html b/8.8.0/interfaces/collection.ArangoCollection.html new file mode 100644 index 000000000..15a41b0c0 --- /dev/null +++ b/8.8.0/interfaces/collection.ArangoCollection.html @@ -0,0 +1,92 @@ +ArangoCollection | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Interface ArangoCollection

+
+

A marker interface identifying objects that can be used in AQL template +strings to create references to ArangoDB collections.

+

See aql.

+
+
+

Hierarchy

+
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
+
+

Properties

+
+ +
name: string
+

Name of the collection.

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/interfaces/collection.DocumentCollection.html b/8.8.0/interfaces/collection.DocumentCollection.html new file mode 100644 index 000000000..66ba35c47 --- /dev/null +++ b/8.8.0/interfaces/collection.DocumentCollection.html @@ -0,0 +1,1356 @@ +DocumentCollection | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Interface DocumentCollection<T>

+
+

Represents an document collection in a Database.

+

See EdgeCollection for a variant of this interface more suited for +edge collections.

+

When using TypeScript, collections can be cast to a specific document data +type to increase type safety.

+ +

Example

interface Person {
name: string;
}
const db = new Database();
const documents = db.collection("persons") as DocumentCollection<Person>; +
+
+
+

Type Parameters

+
    +
  • +

    T extends Record<string, any> = any

    +

    Type to use for document data. Defaults to any.

    +
+
+

Hierarchy

+
+
+
+
+ +
+
+

Properties

+
+ +
name: string
+

Name of the collection.

+
+
+

Methods

+
+ +
    + +
  • +

    Retrieves all documents in the collection.

    + +

    Deprecated

    Simple Queries have been deprecated in ArangoDB 3.4 and can be +replaced with AQL queries.

    + +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    // const cursor = await collection.all();
    const cursor = await db.query(aql`
    FOR doc IN ${collection}
    RETURN doc
    `); +
    +
    +
    +

    Parameters

    +
    +

    Returns Promise<ArrayCursor<Document<T>>>

+
+ +
    + +
  • +

    Retrieves a random document from the collection.

    + +

    Deprecated

    Simple Queries have been deprecated in ArangoDB 3.4 and can be +replaced with AQL queries.

    + +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    // const doc = await collection.any();
    const cursor = await db.query(aql`
    FOR doc IN ${collection}
    SORT RAND()
    LIMIT 1
    RETURN doc
    `);
    const doc = await cursor.next(); +
    +
    +

    Returns Promise<Document<T>>

+
+ +
    + +
  • +

    Retrieves all documents in the collection matching the given example.

    + +

    Deprecated

    Simple Queries have been deprecated in ArangoDB 3.4 and can be +replaced with AQL queries.

    + +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    // const cursor = await collection.byExample({ flavor: "strawberry" });
    const cursor = await db.query(aql`
    FOR doc IN ${collection}
    FILTER doc.flavor == "strawberry"
    RETURN doc
    `); +
    +
    +
    +

    Parameters

    +
    +

    Returns Promise<ArrayCursor<Document<T>>>

+
+ +
    + +
  • +

    Retrieves the collection checksum.

    + +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    const data = await collection.checksum();
    // data contains the collection's checksum +
    +
    +
    +

    Parameters

    +
    +

    Returns Promise<ArangoApiResponse<CollectionMetadata & {
        checksum: string;
        revision: string;
    }>>

+
+ +
    + +
  • +

    Triggers compaction for a collection.

    + +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    await collection.compact();
    // Background compaction is triggered on the collection +
    +
    +

    Returns Promise<ArangoApiResponse<Record<string, never>>>

+
+ +
+
+ +
    + +
  • +

    Creates a collection with the given options and the instance's name.

    +

    See also createCollection and +createEdgeCollection.

    +

    Note: When called on an EdgeCollection instance in TypeScript, +the type option must still be set to the correct CollectionType. +Otherwise this will result in the collection being created with the +default type (i.e. as a document collection).

    + +

    Example

    const db = new Database();
    const collection = db.collection("potatoes");
    await collection.create();
    // the document collection "potatoes" now exists +
    + +

    Example

    const db = new Database();
    const collection = db.collection("friends");
    await collection.create({ type: CollectionType.EDGE_COLLECTION });
    // the edge collection "friends" now exists +
    + +

    Example

    interface Friend {
    startDate: number;
    endDate?: number;
    }
    const db = new Database();
    const collection = db.collection("friends") as EdgeCollection<Friend>;
    // even in TypeScript you still need to indicate the collection type
    // if you want to create an edge collection
    await collection.create({ type: CollectionType.EDGE_COLLECTION });
    // the edge collection "friends" now exists +
    +
    +
    +

    Parameters

    +
    +

    Returns Promise<ArangoApiResponse<CollectionMetadata & CollectionProperties>>

+
+ +
    + +
  • +

    Retrieves the document matching the given key or id.

    +

    Throws an exception when passed a document or _id from a different +collection.

    + +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    try {
    const document = await collection.document("abc123");
    console.log(document);
    } catch (e: any) {
    console.error("Could not find document");
    } +
    + +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    const document = await collection.document("abc123", { graceful: true });
    if (document) {
    console.log(document);
    } else {
    console.error("Could not find document");
    } +
    +
    +
    +

    Parameters

    +
      +
    • +
      selector: DocumentSelector
      +

      Document _key, _id or object with either of those +properties (e.g. a document from this collection).

      +
    • +
    • +
      Optional options: CollectionReadOptions
      +

      Options for retrieving the document.

      +
    +

    Returns Promise<Document<T>>

  • + +
  • +

    Retrieves the document matching the given key or id.

    +

    Throws an exception when passed a document or _id from a different +collection.

    + +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    try {
    const document = await collection.document("abc123", false);
    console.log(document);
    } catch (e: any) {
    console.error("Could not find document");
    } +
    + +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    const document = await collection.document("abc123", true);
    if (document) {
    console.log(document);
    } else {
    console.error("Could not find document");
    } +
    +
    +
    +

    Parameters

    +
      +
    • +
      selector: DocumentSelector
      +

      Document _key, _id or object with either of those +properties (e.g. a document from this collection).

      +
    • +
    • +
      graceful: boolean
      +

      If set to true, null is returned instead of an +exception being thrown if the document does not exist.

      +
    +

    Returns Promise<Document<T>>

+
+ +
    + +
  • +

    Checks whether a document matching the given key or id exists in this +collection.

    +

    Throws an exception when passed a document or _id from a different +collection.

    + +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    const exists = await collection.documentExists("abc123");
    if (!exists) {
    console.log("Document does not exist");
    } +
    +
    +
    +

    Parameters

    +
    +

    Returns Promise<boolean>

+
+ +
    + +
  • +

    Derives a document _id from the given selector for this collection.

    +

    Throws an exception when passed a document or _id from a different +collection.

    + +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    const meta = await collection.save({ foo: "bar" }, { returnNew: true });
    const doc = meta.new;
    console.log(collection.documentId(meta)); // via meta._id
    console.log(collection.documentId(doc)); // via doc._id
    console.log(collection.documentId(meta._key)); // also works +
    + +

    Example

    const db = new Database();
    const collection1 = db.collection("some-collection");
    const collection2 = db.collection("other-collection");
    const meta = await collection1.save({ foo: "bar" });
    // Mixing collections is usually a mistake
    console.log(collection1.documentId(meta)); // ok: same collection
    console.log(collection2.documentId(meta)); // throws: wrong collection
    console.log(collection2.documentId(meta._id)); // also throws
    console.log(collection2.documentId(meta._key)); // ok but wrong collection +
    +
    +
    +

    Parameters

    +
      +
    • +
      selector: DocumentSelector
      +

      Document _key, _id or object with either of those +properties (e.g. a document from this collection).

      +
    +

    Returns string

+
+ +
    + +
  • +

    Retrieves the documents matching the given key or id values.

    +

    Throws an exception when passed a document or _id from a different +collection, or if the document does not exist.

    + +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    try {
    const documents = await collection.documents(["abc123", "xyz456"]);
    console.log(documents);
    } catch (e: any) {
    console.error("Could not find document");
    } +
    +
    +
    +

    Parameters

    +
      +
    • +
      selectors: (string | ObjectWithKey)[]
      +

      Array of document _key, _id or objects with either +of those properties (e.g. a document from this collection).

      +
    • +
    • +
      Optional options: CollectionBatchReadOptions
      +

      Options for retrieving the documents.

      +
    +

    Returns Promise<Document<T>[]>

+
+ +
    + +
  • +

    Deletes the collection from the database.

    + +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    await collection.drop();
    // The collection "some-collection" is now an ex-collection +
    +
    +
    +

    Parameters

    +
    +

    Returns Promise<ArangoApiResponse<Record<string, never>>>

+
+ +
    + +
  • +

    Deletes the index with the given name or id from the database.

    + +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    await collection.dropIndex("some-index");
    // The index "some-index" no longer exists +
    +
    +
    +

    Parameters

    +
      +
    • +
      selector: IndexSelector
      +

      Index name, id or object with either property.

      +
    +

    Returns Promise<ArangoApiResponse<{
        id: string;
    }>>

+
+ +
    + +
  • +

    Creates a persistent index on the collection if it does not already exist.

    + +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    // Create a unique index for looking up documents by username
    await collection.ensureIndex({
    type: "persistent",
    fields: ["username"],
    name: "unique-usernames",
    unique: true
    }); +
    +
    +
    +

    Parameters

    +
    +

    Returns Promise<ArangoApiResponse<GenericIndex & {
        cacheEnabled: boolean;
        deduplicate: boolean;
        estimates: boolean;
        fields: string[];
        storedValues?: string[];
        type: "persistent";
    } & {
        isNewlyCreated: boolean;
    }>>

  • + +
  • +

    Creates a TTL index on the collection if it does not already exist.

    + +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    // Expire documents with "createdAt" timestamp one day after creation
    await collection.ensureIndex({
    type: "ttl",
    fields: ["createdAt"],
    expireAfter: 60 * 60 * 24 // 24 hours
    }); +
    + +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    // Expire documents with "expiresAt" timestamp according to their value
    await collection.ensureIndex({
    type: "ttl",
    fields: ["expiresAt"],
    expireAfter: 0 // when attribute value is exceeded
    }); +
    +
    +
    +

    Parameters

    +
    +

    Returns Promise<ArangoApiResponse<GenericIndex & {
        expireAfter: number;
        fields: [string];
        selectivityEstimate: number;
        type: "ttl";
    } & {
        isNewlyCreated: boolean;
    }>>

  • + +
  • +

    Creates a multi-dimensional index on the collection if it does not already exist.

    + +

    Example

    const db = new Database();
    const collection = db.collection("some-points");
    // Create a multi-dimensional index for the attributes x, y and z
    await collection.ensureIndex({
    type: "mdi",
    fields: ["x", "y", "z"],
    fieldValueTypes: "double"
    }); +
    +
    
    +
    +
    +
    +

    Parameters

    +
    +

    Returns Promise<ArangoApiResponse<GenericIndex & {
        fieldValueTypes: "double";
        fields: string[];
        type: "mdi";
    } & {
        isNewlyCreated: boolean;
    }>>

  • + +
  • +

    Creates a fulltext index on the collection if it does not already exist.

    + +

    Deprecated

    Fulltext indexes have been deprecated in ArangoDB 3.10 and +should be replaced with ArangoSearch.

    + +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    // Create a fulltext index for tokens longer than or equal to 3 characters
    await collection.ensureIndex({
    type: "fulltext",
    fields: ["description"],
    minLength: 3
    }); +
    +
    +
    +

    Parameters

    +
    +

    Returns Promise<ArangoApiResponse<GenericIndex & {
        fields: [string];
        minLength: number;
        type: "fulltext";
    } & {
        isNewlyCreated: boolean;
    }>>

  • + +
  • +

    Creates a geo index on the collection if it does not already exist.

    + +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    // Create an index for GeoJSON data
    await collection.ensureIndex({
    type: "geo",
    fields: ["lngLat"],
    geoJson: true
    }); +
    +
    +
    +

    Parameters

    +
    +

    Returns Promise<ArangoApiResponse<GenericIndex & {
        bestIndexedLevel: number;
        fields: [string, string] | [string];
        geoJson: boolean;
        legacyPolygons: boolean;
        maxNumCoverCells: number;
        type: "geo";
        worstIndexedLevel: number;
    } & {
        isNewlyCreated: boolean;
    }>>

  • + +
  • +

    Creates a inverted index on the collection if it does not already exist.

    + +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    // Create an inverted index
    await collection.ensureIndex({
    type: "inverted",
    fields: ["a", { name: "b", analyzer: "text_en" }]
    }); +
    +
    +
    +

    Parameters

    +
    +

    Returns Promise<ArangoApiResponse<GenericIndex & {
        analyzer: string;
        cache?: boolean;
        cleanupIntervalStep: number;
        commitIntervalMsec: number;
        consolidationIntervalMsec: number;
        consolidationPolicy: Required<TierConsolidationPolicy>;
        features: AnalyzerFeature[];
        fields: {
            analyzer?: string;
            cache?: boolean;
            features?: AnalyzerFeature[];
            includeAllFields?: boolean;
            name: string;
            nested?: InvertedIndexNestedField[];
            searchField?: boolean;
            trackListPositions?: boolean;
        }[];
        includeAllFields: boolean;
        optimizeTopK: string[];
        parallelism: number;
        primaryKeyCache?: boolean;
        primarySort: {
            cache?: boolean;
            compression: Compression;
            fields: {
                direction: Direction;
                field: string;
            }[];
        };
        searchField: boolean;
        storedValues: {
            cache?: boolean;
            compression: Compression;
            fields: string[];
        }[];
        trackListPositions: boolean;
        type: "inverted";
        writeBufferActive: number;
        writeBufferIdle: number;
        writeBufferSizeMax: number;
    } & {
        isNewlyCreated: boolean;
    }>>

+
+ +
    + +
  • +

    Checks whether the collection exists.

    + +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    const result = await collection.exists();
    // result indicates whether the collection exists +
    +
    +

    Returns Promise<boolean>

+
+ +
    + +
  • +

    Retrieves statistics for a collection.

    + +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    const data = await collection.figures();
    // data contains the collection's figures +
    +
    +
    +

    Parameters

    +
      +
    • +
      Optional details: boolean
      +

      whether to return extended storage engine-specific details +to the figures, which may cause additional load and impact performance

      +
    +

    Returns Promise<ArangoApiResponse<CollectionMetadata & CollectionProperties & {
        count: number;
        figures: Record<string, any>;
    }>>

+
+ +
    + +
  • +

    Retrieves a single document in the collection matching the given example.

    + +

    Deprecated

    Simple Queries have been deprecated in ArangoDB 3.4 and can be +replaced with AQL queries.

    + +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    // const doc = await collection.firstExample({ flavor: "strawberry" });
    const cursor = await db.query(aql`
    FOR doc IN ${collection}
    FILTER doc.flavor == "strawberry"
    LIMIT 1
    RETURN doc
    `);
    const doc = await cursor.next(); +
    +
    +
    +

    Parameters

    +
      +
    • +
      example: Partial<DocumentData<T>>
      +

      An object representing an example for the document.

      +
    +

    Returns Promise<Document<T>>

+
+ +
    + +
  • +

    Performs a fulltext query in the given attribute on the collection.

    + +

    Deprecated

    Simple Queries have been deprecated in ArangoDB 3.4 and can be +replaced with AQL queries.

    + +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    // const cursor = await collection.fulltext("article", "needle");
    const cursor = await db.query(aql`
    FOR doc IN FULLTEXT(${collection}, "article", "needle")
    RETURN doc
    `); +
    +
    +
    +

    Parameters

    +
      +
    • +
      attribute: string
      +

      Name of the field to search.

      +
    • +
    • +
      query: string
      +

      Fulltext query string to search for.

      +
    • +
    • +
      Optional options: SimpleQueryFulltextOptions
      +

      Options for performing the fulltext query.

      +
    +

    Returns Promise<ArrayCursor<Document<T>>>

+
+ +
    + +
  • +

    Retrieves general information about the collection.

    + +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    const data = await collection.get();
    // data contains general information about the collection +
    +
    +

    Returns Promise<ArangoApiResponse<CollectionMetadata>>

+
+ +
    + +
  • +

    Retrieves the shardId of the shard responsible for the given document.

    + +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    const responsibleShard = await collection.getResponsibleShard(); +
    +
    +
    +

    Parameters

    +
      +
    • +
      document: Partial<Document<T>>
      +

      Document in the collection to look up the shardId of.

      +
    +

    Returns Promise<string>

+
+ +
    + +
  • +

    Bulk imports the given data into the collection.

    + +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    await collection.import(
    [
    { _key: "jcd", password: "bionicman" },
    { _key: "jreyes", password: "amigo" },
    { _key: "ghermann", password: "zeitgeist" }
    ]
    ); +
    +
    +
    +

    Parameters

    +
    +

    Returns Promise<CollectionImportResult>

  • + +
  • +

    Bulk imports the given data into the collection.

    + +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    await collection.import(
    [
    [ "_key", "password" ],
    [ "jcd", "bionicman" ],
    [ "jreyes", "amigo" ],
    [ "ghermann", "zeitgeist" ]
    ]
    ); +
    +
    +
    +

    Parameters

    +
      +
    • +
      data: any[][]
      +

      The data to import, as an array containing a single array of +attribute names followed by one or more arrays of attribute values for +each document.

      +
    • +
    • +
      Optional options: CollectionImportOptions
      +

      Options for importing the data.

      +
    +

    Returns Promise<CollectionImportResult>

  • + +
  • +

    Bulk imports the given data into the collection.

    +

    If type is omitted, data must contain one JSON array per line with +the first array providing the attribute names and all other arrays +providing attribute values for each document.

    +

    If type is set to "documents", data must contain one JSON document +per line.

    +

    If type is set to "list", data must contain a JSON array of +documents.

    +

    If type is set to "auto", data can be in either of the formats +supported by "documents" or "list".

    + +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    await collection.import(
    '{"_key":"jcd","password":"bionicman"}\r\n' +
    '{"_key":"jreyes","password":"amigo"}\r\n' +
    '{"_key":"ghermann","password":"zeitgeist"}\r\n',
    { type: "documents" } // or "auto"
    ); +
    + +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    await collection.import(
    '[{"_key":"jcd","password":"bionicman"},' +
    '{"_key":"jreyes","password":"amigo"},' +
    '{"_key":"ghermann","password":"zeitgeist"}]',
    { type: "list" } // or "auto"
    ); +
    + +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    await collection.import(
    '["_key","password"]\r\n' +
    '["jcd","bionicman"]\r\n' +
    '["jreyes","amigo"]\r\n' +
    '["ghermann","zeitgeist"]\r\n'
    ); +
    +
    +
    +

    Parameters

    +
      +
    • +
      data: string | Blob | Buffer
      +

      The data to import as a Buffer (Node), Blob (browser) or +string.

      +
    • +
    • +
      Optional options: CollectionImportOptions & {
          type?: "documents" | "list" | "auto";
      }
      +

      Options for importing the data.

      +
    +

    Returns Promise<CollectionImportResult>

+
+ +
    + +
  • +

    Returns an index description by name or id if it exists.

    + +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    const index = await collection.index("some-index"); +
    +
    +
    +

    Parameters

    +
      +
    • +
      selector: IndexSelector
      +

      Index name, id or object with either property.

      +
    +

    Returns Promise<Index>

+
+ +
    + +
  • +

    Returns a list of all index descriptions for the collection.

    + +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    const indexes = await collection.indexes(); +
    +
    +

    Returns Promise<Index[]>

+
+ +
    + +
  • +

    Retrieves a list of references for all documents in the collection.

    + +

    Deprecated

    Simple Queries have been deprecated in ArangoDB 3.4 and can be +replaced with AQL queries.

    + +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    // const ids = await collection.list("id");
    const ids = await db.query(aql`
    FOR doc IN ${collection}
    RETURN doc._id
    `); +
    + +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    // const keys = await collection.list("key");
    const keys = await db.query(aql`
    FOR doc IN ${collection}
    RETURN doc._key
    `); +
    + +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    // const paths = await collection.list("path");
    const paths = await db.query(aql`
    FOR doc IN ${collection}
    RETURN CONCAT("/_db/", CURRENT_DATABASE(), "/_api/document/", doc._id)
    `); +
    +
    +
    +

    Parameters

    +
    +

    Returns Promise<ArrayCursor<string>>

+
+ +
    + +
  • +

    (RocksDB only.) Instructs ArangoDB to load as many indexes of the +collection into memory as permitted by the memory limit.

    + +

    Example

    const db = new Database();
    const collection = db.collection("indexed-collection");
    await collection.loadIndexes();
    // the indexes are now loaded into memory +
    +
    +

    Returns Promise<boolean>

+
+ +
    + +
  • +

    Retrieves all documents matching the given document keys.

    + +

    Deprecated

    Simple Queries have been deprecated in ArangoDB 3.4 and can be +replaced with AQL queries.

    + +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    const keys = ["a", "b", "c"];
    // const docs = await collection.byKeys(keys);
    const cursor = await db.query(aql`
    FOR key IN ${keys}
    LET doc = DOCUMENT(${collection}, key)
    RETURN doc
    `);
    const docs = await cursor.all(); +
    +
    +
    +

    Parameters

    +
      +
    • +
      keys: string[]
      +

      An array of document keys to look up.

      +
    +

    Returns Promise<Document<T>[]>

+
+ +
+
+ +
    + +
  • +

    (RocksDB only.) Instructs ArangoDB to recalculate the collection's +document count to fix any inconsistencies.

    + +

    Example

    const db = new Database();
    const collection = db.collection("inconsistent-collection");
    const badData = await collection.count();
    // oh no, the collection count looks wrong -- fix it!
    await collection.recalculateCount();
    const goodData = await collection.count();
    // goodData contains the collection's improved count +
    +
    +

    Returns Promise<boolean>

+
+ +
    + +
  • +

    Removes an existing document from the collection.

    +

    Throws an exception when passed a document or _id from a different +collection.

    + +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    await collection.remove("abc123");
    // document with key "abc123" deleted +
    + +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    const doc = await collection.document("abc123");
    await collection.remove(doc);
    // document with key "abc123" deleted +
    +
    +
    +

    Parameters

    +
      +
    • +
      selector: DocumentSelector
      +

      Document _key, _id or object with either of those +properties (e.g. a document from this collection).

      +
    • +
    • +
      Optional options: CollectionRemoveOptions
      +

      Options for removing the document.

      +
    +

    Returns Promise<DocumentMetadata & {
        old?: Document<T>;
    }>

+
+ +
    + +
  • +

    Removes existing documents from the collection.

    +

    Throws an exception when passed any document or _id from a different +collection.

    + +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    await collection.removeAll(["abc123", "def456"]);
    // document with keys "abc123" and "def456" deleted +
    +
    +
    +

    Parameters

    +
      +
    • +
      selectors: (string | ObjectWithKey)[]
      +

      Documents _key, _id or objects with either of those +properties (e.g. documents from this collection).

      +
    • +
    • +
      Optional options: Omit<CollectionRemoveOptions, "ifMatch">
      +

      Options for removing the documents.

      +
    +

    Returns Promise<(DocumentOperationFailure | DocumentMetadata & {
        old?: Document<T>;
    })[]>

+
+ +
    + +
  • +

    Removes all documents in the collection matching the given example.

    + +

    Deprecated

    Simple Queries have been deprecated in ArangoDB 3.4 and can be +replaced with AQL queries.

    + +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    // const { deleted } = await collection.removeByExample({
    // flavor: "strawberry"
    // });
    const cursor = await db.query(aql`
    RETURN LENGTH(
    FOR doc IN ${collection}
    FILTER doc.flavor == "strawberry"
    REMOVE doc IN ${collection}
    RETURN 1
    )
    `);
    const deleted = await cursor.next(); +
    +
    +
    +

    Parameters

    +
    +

    Returns Promise<ArangoApiResponse<SimpleQueryRemoveByExampleResult>>

+
+ +
    + +
  • +

    Removes all documents matching the given document keys.

    + +

    Deprecated

    Simple Queries have been deprecated in ArangoDB 3.4 and can be +replaced with AQL queries.

    + +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    const keys = ["a", "b", "c"];
    // const { removed, ignored } = await collection.removeByKeys(keys);
    const cursor = await db.query(aql`
    FOR key IN ${keys}
    LET doc = DOCUMENT(${collection}, key)
    FILTER doc
    REMOVE doc IN ${collection}
    RETURN key
    `);
    const removed = await cursor.all();
    const ignored = keys.filter((key) => !removed.includes(key)); +
    +
    +
    +

    Parameters

    +
    +

    Returns Promise<ArangoApiResponse<SimpleQueryRemoveByKeysResult<T>>>

+
+ +
    + +
  • +

    Renames the collection and updates the instance's name to newName.

    +

    Additionally removes the instance from the Database's internal +cache.

    +

    Note: Renaming collections may not be supported when ArangoDB is +running in a cluster configuration.

    + +

    Example

    const db = new Database();
    const collection1 = db.collection("some-collection");
    await collection1.rename("other-collection");
    const collection2 = db.collection("some-collection");
    const collection3 = db.collection("other-collection");
    // Note all three collection instances are different objects but
    // collection1 and collection3 represent the same ArangoDB collection! +
    +
    +
    +

    Parameters

    +
      +
    • +
      newName: string
      +

      The new name of the collection.

      +
    +

    Returns Promise<ArangoApiResponse<CollectionMetadata>>

+
+ +
    + +
  • +

    Replaces an existing document in the collection.

    +

    Throws an exception when passed a document or _id from a different +collection.

    + +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    await collection.save({ _key: "a", color: "blue", count: 1 });
    const result = await collection.replace(
    "a",
    { color: "red" },
    { returnNew: true }
    );
    console.log(result.new.color, result.new.count); // "red" undefined +
    +
    +
    +

    Parameters

    +
      +
    • +
      selector: DocumentSelector
      +

      Document _key, _id or object with either of those +properties (e.g. a document from this collection).

      +
    • +
    • +
      newData: DocumentData<T>
      +

      The contents of the new document.

      +
    • +
    • +
      Optional options: CollectionReplaceOptions
      +

      Options for replacing the document.

      +
    +

    Returns Promise<DocumentMetadata & {
        _oldRev?: string;
    } & {
        new?: Document<T>;
        old?: Document<T>;
    }>

+
+ +
    + +
  • +

    Replaces existing documents in the collection, identified by the _key or +_id of each document.

    + +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    await collection.save({ _key: "a", color: "blue", count: 1 });
    await collection.save({ _key: "b", color: "green", count: 3 });
    const result = await collection.replaceAll(
    [
    { _key: "a", color: "red" },
    { _key: "b", color: "yellow", count: 2 }
    ],
    { returnNew: true }
    );
    console.log(result[0].new.color, result[0].new.count); // "red" undefined
    console.log(result[1].new.color, result[1].new.count); // "yellow" 2 +
    +
    +
    +

    Parameters

    +
      +
    • +
      newData: Object[]
      +

      The documents to replace.

      +
    • +
    • +
      Optional options: Omit<CollectionReplaceOptions, "ifMatch">
      +

      Options for replacing the documents.

      +
    +

    Returns Promise<(DocumentOperationFailure | DocumentMetadata & {
        _oldRev?: string;
    } & {
        new?: Document<T>;
        old?: Document<T>;
    })[]>

+
+ +
    + +
  • +

    Replaces all documents in the collection matching the given example.

    + +

    Deprecated

    Simple Queries have been deprecated in ArangoDB 3.4 and can be +replaced with AQL queries.

    + +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    const newValue = { flavor: "chocolate" };
    // const { replaced } = await collection.replaceByExample(
    // { flavor: "strawberry" },
    // newValue
    // );
    const cursor = await db.query(aql`
    RETURN LENGTH(
    FOR doc IN ${collection}
    FILTER doc.flavor == "strawberry"
    REPLACE doc WITH ${newValue} IN ${collection}
    RETURN 1
    )
    `);
    const replaced = await cursor.next(); +
    +
    +
    +

    Parameters

    +
    +

    Returns Promise<ArangoApiResponse<SimpleQueryReplaceByExampleResult>>

+
+ +
+
+ +
    + +
  • +

    Inserts a new document with the given data into the collection.

    + +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    const result = await collection.save(
    { _key: "a", color: "blue", count: 1 },
    { returnNew: true }
    );
    console.log(result.new.color, result.new.count); // "blue" 1 +
    +
    +
    +

    Parameters

    +
    +

    Returns Promise<DocumentMetadata & {
        _oldRev?: string;
    } & {
        new?: Document<T>;
        old?: Document<T>;
    }>

+
+ +
    + +
  • +

    Inserts new documents with the given data into the collection.

    + +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    const result = await collection.saveAll(
    [
    { _key: "a", color: "blue", count: 1 },
    { _key: "b", color: "red", count: 2 },
    ],
    { returnNew: true }
    );
    console.log(result[0].new.color, result[0].new.count); // "blue" 1
    console.log(result[1].new.color, result[1].new.count); // "red" 2 +
    +
    +
    +

    Parameters

    +
    +

    Returns Promise<(DocumentOperationFailure | DocumentMetadata & {
        _oldRev?: string;
    } & {
        new?: Document<T>;
        old?: Document<T>;
    })[]>

+
+ +
    + +
  • +

    Deletes all documents in the collection.

    + +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    await collection.truncate();
    // millions of documents cry out in terror and are suddenly silenced,
    // the collection "some-collection" is now empty +
    +
    +

    Returns Promise<ArangoApiResponse<CollectionMetadata>>

+
+ +
    + +
  • +

    Updates an existing document in the collection.

    +

    Throws an exception when passed a document or _id from a different +collection.

    + +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    await collection.save({ _key: "a", color: "blue", count: 1 });
    const result = await collection.update(
    "a",
    { count: 2 },
    { returnNew: true }
    );
    console.log(result.new.color, result.new.count); // "blue" 2 +
    +
    +
    +

    Parameters

    +
      +
    • +
      selector: DocumentSelector
      +

      Document _key, _id or object with either of those +properties (e.g. a document from this collection).

      +
    • +
    • +
      newData: Patch<DocumentData<T>>
      +

      The data for updating the document.

      +
    • +
    • +
      Optional options: CollectionUpdateOptions
      +

      Options for updating the document.

      +
    +

    Returns Promise<DocumentMetadata & {
        _oldRev?: string;
    } & {
        new?: Document<T>;
        old?: Document<T>;
    }>

+
+ +
    + +
  • +

    Updates existing documents in the collection, identified by the _key or +_id of each document.

    + +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    await collection.save({ _key: "a", color: "blue", count: 1 });
    await collection.save({ _key: "b", color: "green", count: 3 });
    const result = await collection.updateAll(
    [
    { _key: "a", count: 2 },
    { _key: "b", count: 4 }
    ],
    { returnNew: true }
    );
    console.log(result[0].new.color, result[0].new.count); // "blue" 2
    console.log(result[1].new.color, result[1].new.count); // "green" 4 +
    +
    +
    +

    Parameters

    +
      +
    • +
      newData: Object[]
      +

      The data for updating the documents.

      +
    • +
    • +
      Optional options: Omit<CollectionUpdateOptions, "ifMatch">
      +

      Options for updating the documents.

      +
    +

    Returns Promise<(DocumentOperationFailure | DocumentMetadata & {
        _oldRev?: string;
    } & {
        new?: Document<T>;
        old?: Document<T>;
    })[]>

+
+ +
    + +
  • +

    Updates all documents in the collection matching the given example.

    + +

    Deprecated

    Simple Queries have been deprecated in ArangoDB 3.4 and can be +replaced with AQL queries.

    + +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    const newData = { color: "red" };
    // const { updated } = await collection.updateByExample(
    // { flavor: "strawberry" },
    // newValue
    // );
    const cursor = await db.query(aql`
    RETURN LENGTH(
    FOR doc IN ${collection}
    FILTER doc.flavor == "strawberry"
    UPDATE doc WITH ${newValue} IN ${collection}
    RETURN 1
    )
    `);
    const updated = await cursor.next(); +
    +
    +
    +

    Parameters

    +
    +

    Returns Promise<ArangoApiResponse<SimpleQueryUpdateByExampleResult>>

+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/interfaces/collection.EdgeCollection.html b/8.8.0/interfaces/collection.EdgeCollection.html new file mode 100644 index 000000000..3304466ec --- /dev/null +++ b/8.8.0/interfaces/collection.EdgeCollection.html @@ -0,0 +1,1528 @@ +EdgeCollection | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Interface EdgeCollection<T>

+
+

Represents an edge collection in a Database.

+

See DocumentCollection for a more generic variant of this interface +more suited for regular document collections.

+

See also GraphEdgeCollection for the type representing an edge +collection in a Graph.

+

When using TypeScript, collections can be cast to a specific edge document +data type to increase type safety.

+ +

Example

interface Friend {
startDate: number;
endDate?: number;
}
const db = new Database();
const edges = db.collection("friends") as EdgeCollection<Friend>; +
+
+
+

Type Parameters

+
    +
  • +

    T extends Record<string, any> = any

    +

    Type to use for edge document data. Defaults to any.

    +
+
+

Hierarchy

+
+
+
+
+ +
+
+

Properties

+
+ +
name: string
+

Name of the collection.

+
+
+

Methods

+
+ +
    + +
  • +

    Retrieves all documents in the collection.

    + +

    Deprecated

    Simple Queries have been deprecated in ArangoDB 3.4 and can be +replaced with AQL queries.

    + +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    // const cursor = await collection.all();
    const cursor = await db.query(aql`
    FOR doc IN ${collection}
    RETURN doc
    `); +
    +
    +
    +

    Parameters

    +
    +

    Returns Promise<ArrayCursor<Edge<T>>>

+
+ +
    + +
  • +

    Retrieves a random document from the collection.

    + +

    Deprecated

    Simple Queries have been deprecated in ArangoDB 3.4 and can be +replaced with AQL queries.

    + +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    // const doc = await collection.any();
    const cursor = await db.query(aql`
    FOR doc IN ${collection}
    SORT RAND()
    LIMIT 1
    RETURN doc
    `);
    const doc = await cursor.next(); +
    +
    +

    Returns Promise<Edge<T>>

+
+ +
    + +
  • +

    Retrieves all documents in the collection matching the given example.

    + +

    Deprecated

    Simple Queries have been deprecated in ArangoDB 3.4 and can be +replaced with AQL queries.

    + +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    // const cursor = await collection.byExample({ flavor: "strawberry" });
    const cursor = await db.query(aql`
    FOR doc IN ${collection}
    FILTER doc.flavor == "strawberry"
    RETURN doc
    `); +
    +
    +
    +

    Parameters

    +
    +

    Returns Promise<ArrayCursor<Edge<T>>>

+
+ +
+
+ +
    + +
  • +

    Triggers compaction for a collection.

    + +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    await collection.compact();
    // Background compaction is triggered on the collection +
    +
    +

    Returns Promise<ArangoApiResponse<Record<string, never>>>

+
+ +
+
+ +
    + +
  • +

    Creates a collection with the given options and the instance's name.

    +

    See also createCollection and +createEdgeCollection.

    +

    Note: When called on an EdgeCollection instance in TypeScript, +the type option must still be set to the correct CollectionType. +Otherwise this will result in the collection being created with the +default type (i.e. as a document collection).

    + +

    Example

    const db = new Database();
    const collection = db.collection("potatoes");
    await collection.create();
    // the document collection "potatoes" now exists +
    + +

    Example

    const db = new Database();
    const collection = db.collection("friends");
    await collection.create({ type: CollectionType.EDGE_COLLECTION });
    // the edge collection "friends" now exists +
    + +

    Example

    interface Friend {
    startDate: number;
    endDate?: number;
    }
    const db = new Database();
    const collection = db.collection("friends") as EdgeCollection<Friend>;
    // even in TypeScript you still need to indicate the collection type
    // if you want to create an edge collection
    await collection.create({ type: CollectionType.EDGE_COLLECTION });
    // the edge collection "friends" now exists +
    +
    +
    +

    Parameters

    +
    +

    Returns Promise<ArangoApiResponse<CollectionMetadata & CollectionProperties>>

+
+ +
    + +
  • +

    Retrieves the document matching the given key or id.

    +

    Throws an exception when passed a document or _id from a different +collection, or if the document does not exist.

    + +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    try {
    const document = await collection.document("abc123");
    console.log(document);
    } catch (e: any) {
    console.error("Could not find document");
    } +
    + +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    const document = await collection.document("abc123", { graceful: true });
    if (document) {
    console.log(document);
    } else {
    console.error("Document does not exist");
    } +
    +
    +
    +

    Parameters

    +
      +
    • +
      selector: DocumentSelector
      +

      Document _key, _id or object with either of those +properties (e.g. a document from this collection).

      +
    • +
    • +
      Optional options: CollectionReadOptions
      +

      Options for retrieving the document.

      +
    +

    Returns Promise<Edge<T>>

  • + +
  • +

    Retrieves the document matching the given key or id.

    +

    Throws an exception when passed a document or _id from a different +collection, or if the document does not exist.

    + +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    try {
    const document = await collection.document("abc123", false);
    console.log(document);
    } catch (e: any) {
    console.error("Could not find document");
    } +
    + +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    const document = await collection.document("abc123", true);
    if (document) {
    console.log(document);
    } else {
    console.error("Document does not exist");
    } +
    +
    +
    +

    Parameters

    +
      +
    • +
      selector: DocumentSelector
      +

      Document _key, _id or object with either of those +properties (e.g. a document from this collection).

      +
    • +
    • +
      graceful: boolean
      +

      If set to true, null is returned instead of an +exception being thrown if the document does not exist.

      +
    +

    Returns Promise<Edge<T>>

+
+ +
    + +
  • +

    Checks whether a document matching the given key or id exists in this +collection.

    +

    Throws an exception when passed a document or _id from a different +collection.

    + +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    const exists = await collection.documentExists("abc123");
    if (!exists) {
    console.log("Document does not exist");
    } +
    +
    +
    +

    Parameters

    +
    +

    Returns Promise<boolean>

+
+ +
    + +
  • +

    Derives a document _id from the given selector for this collection.

    +

    Throws an exception when passed a document or _id from a different +collection.

    + +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    const meta = await collection.save({ foo: "bar" }, { returnNew: true });
    const doc = meta.new;
    console.log(collection.documentId(meta)); // via meta._id
    console.log(collection.documentId(doc)); // via doc._id
    console.log(collection.documentId(meta._key)); // also works +
    + +

    Example

    const db = new Database();
    const collection1 = db.collection("some-collection");
    const collection2 = db.collection("other-collection");
    const meta = await collection1.save({ foo: "bar" });
    // Mixing collections is usually a mistake
    console.log(collection1.documentId(meta)); // ok: same collection
    console.log(collection2.documentId(meta)); // throws: wrong collection
    console.log(collection2.documentId(meta._id)); // also throws
    console.log(collection2.documentId(meta._key)); // ok but wrong collection +
    +
    +
    +

    Parameters

    +
      +
    • +
      selector: DocumentSelector
      +

      Document _key, _id or object with either of those +properties (e.g. a document from this collection).

      +
    +

    Returns string

+
+ +
    + +
  • +

    Retrieves the documents matching the given key or id values.

    +

    Throws an exception when passed a document or _id from a different +collection, or if the document does not exist.

    + +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    try {
    const documents = await collection.documents(["abc123", "xyz456"]);
    console.log(documents);
    } catch (e: any) {
    console.error("Could not find document");
    } +
    +
    +
    +

    Parameters

    +
      +
    • +
      selectors: (string | ObjectWithKey)[]
      +

      Array of document _key, _id or objects with either +of those properties (e.g. a document from this collection).

      +
    • +
    • +
      Optional options: CollectionBatchReadOptions
      +

      Options for retrieving the documents.

      +
    +

    Returns Promise<Edge<T>[]>

+
+ +
    + +
  • +

    Deletes the collection from the database.

    + +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    await collection.drop();
    // The collection "some-collection" is now an ex-collection +
    +
    +
    +

    Parameters

    +
    +

    Returns Promise<ArangoApiResponse<Record<string, never>>>

+
+ +
    + +
  • +

    Deletes the index with the given name or id from the database.

    + +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    await collection.dropIndex("some-index");
    // The index "some-index" no longer exists +
    +
    +
    +

    Parameters

    +
      +
    • +
      selector: IndexSelector
      +

      Index name, id or object with either property.

      +
    +

    Returns Promise<ArangoApiResponse<{
        id: string;
    }>>

+
+ +
    + +
  • +

    Retrieves a list of all edges of the document matching the given +selector.

    +

    Throws an exception when passed a document or _id from a different +collection.

    + +

    Example

    const db = new Database();
    const collection = db.collection("edges");
    await collection.import([
    ["_key", "_from", "_to"],
    ["x", "vertices/a", "vertices/b"],
    ["y", "vertices/a", "vertices/c"],
    ["z", "vertices/d", "vertices/a"],
    ]);
    const edges = await collection.edges("vertices/a");
    console.log(edges.map((edge) => edge._key)); // ["x", "y", "z"] +
    +
    +
    +

    Parameters

    +
      +
    • +
      selector: DocumentSelector
      +

      Document _key, _id or object with either of those +properties (e.g. a document from this collection).

      +
    • +
    • +
      Optional options: CollectionEdgesOptions
      +

      Options for retrieving the edges.

      +
    +

    Returns Promise<ArangoApiResponse<CollectionEdgesResult<T>>>

+
+ +
    + +
  • +

    Creates a persistent index on the collection if it does not already exist.

    + +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    // Create a unique index for looking up documents by username
    await collection.ensureIndex({
    type: "persistent",
    fields: ["username"],
    name: "unique-usernames",
    unique: true
    }); +
    +
    +
    +

    Parameters

    +
    +

    Returns Promise<ArangoApiResponse<GenericIndex & {
        cacheEnabled: boolean;
        deduplicate: boolean;
        estimates: boolean;
        fields: string[];
        storedValues?: string[];
        type: "persistent";
    } & {
        isNewlyCreated: boolean;
    }>>

  • + +
  • +

    Creates a TTL index on the collection if it does not already exist.

    + +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    // Expire documents with "createdAt" timestamp one day after creation
    await collection.ensureIndex({
    type: "ttl",
    fields: ["createdAt"],
    expireAfter: 60 * 60 * 24 // 24 hours
    }); +
    + +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    // Expire documents with "expiresAt" timestamp according to their value
    await collection.ensureIndex({
    type: "ttl",
    fields: ["expiresAt"],
    expireAfter: 0 // when attribute value is exceeded
    }); +
    +
    +
    +

    Parameters

    +
    +

    Returns Promise<ArangoApiResponse<GenericIndex & {
        expireAfter: number;
        fields: [string];
        selectivityEstimate: number;
        type: "ttl";
    } & {
        isNewlyCreated: boolean;
    }>>

  • + +
  • +

    Creates a multi-dimensional index on the collection if it does not already exist.

    + +

    Example

    const db = new Database();
    const collection = db.collection("some-points");
    // Create a multi-dimensional index for the attributes x, y and z
    await collection.ensureIndex({
    type: "mdi",
    fields: ["x", "y", "z"],
    fieldValueTypes: "double"
    }); +
    +
    
    +
    +
    +
    +

    Parameters

    +
    +

    Returns Promise<ArangoApiResponse<GenericIndex & {
        fieldValueTypes: "double";
        fields: string[];
        type: "mdi";
    } & {
        isNewlyCreated: boolean;
    }>>

  • + +
  • +

    Creates a fulltext index on the collection if it does not already exist.

    + +

    Deprecated

    Fulltext indexes have been deprecated in ArangoDB 3.10 and +should be replaced with ArangoSearch.

    + +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    // Create a fulltext index for tokens longer than or equal to 3 characters
    await collection.ensureIndex({
    type: "fulltext",
    fields: ["description"],
    minLength: 3
    }); +
    +
    +
    +

    Parameters

    +
    +

    Returns Promise<ArangoApiResponse<GenericIndex & {
        fields: [string];
        minLength: number;
        type: "fulltext";
    } & {
        isNewlyCreated: boolean;
    }>>

  • + +
  • +

    Creates a geo index on the collection if it does not already exist.

    + +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    // Create an index for GeoJSON data
    await collection.ensureIndex({
    type: "geo",
    fields: ["lngLat"],
    geoJson: true
    }); +
    +
    +
    +

    Parameters

    +
    +

    Returns Promise<ArangoApiResponse<GenericIndex & {
        bestIndexedLevel: number;
        fields: [string, string] | [string];
        geoJson: boolean;
        legacyPolygons: boolean;
        maxNumCoverCells: number;
        type: "geo";
        worstIndexedLevel: number;
    } & {
        isNewlyCreated: boolean;
    }>>

  • + +
  • +

    Creates a inverted index on the collection if it does not already exist.

    + +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    // Create an inverted index
    await collection.ensureIndex({
    type: "inverted",
    fields: ["a", { name: "b", analyzer: "text_en" }]
    }); +
    +
    +
    +

    Parameters

    +
    +

    Returns Promise<ArangoApiResponse<GenericIndex & {
        analyzer: string;
        cache?: boolean;
        cleanupIntervalStep: number;
        commitIntervalMsec: number;
        consolidationIntervalMsec: number;
        consolidationPolicy: Required<TierConsolidationPolicy>;
        features: AnalyzerFeature[];
        fields: {
            analyzer?: string;
            cache?: boolean;
            features?: AnalyzerFeature[];
            includeAllFields?: boolean;
            name: string;
            nested?: InvertedIndexNestedField[];
            searchField?: boolean;
            trackListPositions?: boolean;
        }[];
        includeAllFields: boolean;
        optimizeTopK: string[];
        parallelism: number;
        primaryKeyCache?: boolean;
        primarySort: {
            cache?: boolean;
            compression: Compression;
            fields: {
                direction: Direction;
                field: string;
            }[];
        };
        searchField: boolean;
        storedValues: {
            cache?: boolean;
            compression: Compression;
            fields: string[];
        }[];
        trackListPositions: boolean;
        type: "inverted";
        writeBufferActive: number;
        writeBufferIdle: number;
        writeBufferSizeMax: number;
    } & {
        isNewlyCreated: boolean;
    }>>

+
+ +
    + +
  • +

    Checks whether the collection exists.

    + +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    const result = await collection.exists();
    // result indicates whether the collection exists +
    +
    +

    Returns Promise<boolean>

+
+ +
    + +
  • +

    Retrieves statistics for a collection.

    + +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    const data = await collection.figures();
    // data contains the collection's figures +
    +
    +
    +

    Parameters

    +
      +
    • +
      Optional details: boolean
      +

      whether to return extended storage engine-specific details +to the figures, which may cause additional load and impact performance

      +
    +

    Returns Promise<ArangoApiResponse<CollectionMetadata & CollectionProperties & {
        count: number;
        figures: Record<string, any>;
    }>>

+
+ +
    + +
  • +

    Retrieves a single document in the collection matching the given example.

    + +

    Deprecated

    Simple Queries have been deprecated in ArangoDB 3.4 and can be +replaced with AQL queries.

    + +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    // const doc = await collection.firstExample({ flavor: "strawberry" });
    const cursor = await db.query(aql`
    FOR doc IN ${collection}
    FILTER doc.flavor == "strawberry"
    LIMIT 1
    RETURN doc
    `);
    const doc = await cursor.next(); +
    +
    +
    +

    Parameters

    +
      +
    • +
      example: Partial<DocumentData<T>>
      +

      An object representing an example for the document.

      +
    +

    Returns Promise<Edge<T>>

+
+ +
    + +
  • +

    Performs a fulltext query in the given attribute on the collection.

    + +

    Deprecated

    Simple Queries have been deprecated in ArangoDB 3.4 and can be +replaced with AQL queries.

    + +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    // const cursor = await collection.fulltext("article", "needle");
    const cursor = await db.query(aql`
    FOR doc IN FULLTEXT(${collection}, "article", "needle")
    RETURN doc
    `); +
    +
    +
    +

    Parameters

    +
      +
    • +
      attribute: string
      +

      Name of the field to search.

      +
    • +
    • +
      query: string
      +

      Fulltext query string to search for.

      +
    • +
    • +
      Optional options: SimpleQueryFulltextOptions
      +

      Options for performing the fulltext query.

      +
    +

    Returns Promise<ArrayCursor<Edge<T>>>

+
+ +
+
+ +
    + +
  • +

    Retrieves the shardId of the shard responsible for the given document.

    + +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    const responsibleShard = await collection.getResponsibleShard(); +
    +
    +
    +

    Parameters

    +
      +
    • +
      document: Partial<Document<T>>
      +

      Document in the collection to look up the shardId of.

      +
    +

    Returns Promise<string>

+
+ +
    + +
  • +

    Bulk imports the given data into the collection.

    + +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    await collection.import(
    [
    { _key: "x", _from: "vertices/a", _to: "vertices/b", weight: 1 },
    { _key: "y", _from: "vertices/a", _to: "vertices/c", weight: 2 }
    ]
    ); +
    +
    +
    +

    Parameters

    +
    +

    Returns Promise<CollectionImportResult>

  • + +
  • +

    Bulk imports the given data into the collection.

    + +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    await collection.import(
    [
    [ "_key", "_from", "_to", "weight" ],
    [ "x", "vertices/a", "vertices/b", 1 ],
    [ "y", "vertices/a", "vertices/c", 2 ]
    ]
    ); +
    +
    +
    +

    Parameters

    +
      +
    • +
      data: any[][]
      +

      The data to import, as an array containing a single array of +attribute names followed by one or more arrays of attribute values for +each edge document.

      +
    • +
    • +
      Optional options: CollectionImportOptions
      +

      Options for importing the data.

      +
    +

    Returns Promise<CollectionImportResult>

  • + +
  • +

    Bulk imports the given data into the collection.

    +

    If type is omitted, data must contain one JSON array per line with +the first array providing the attribute names and all other arrays +providing attribute values for each edge document.

    +

    If type is set to "documents", data must contain one JSON document +per line.

    +

    If type is set to "list", data must contain a JSON array of +edge documents.

    +

    If type is set to "auto", data can be in either of the formats +supported by "documents" or "list".

    + +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    await collection.import(
    '{"_key":"x","_from":"vertices/a","_to":"vertices/b","weight":1}\r\n' +
    '{"_key":"y","_from":"vertices/a","_to":"vertices/c","weight":2}\r\n',
    { type: "documents" } // or "auto"
    ); +
    + +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    await collection.import(
    '[{"_key":"x","_from":"vertices/a","_to":"vertices/b","weight":1},' +
    '{"_key":"y","_from":"vertices/a","_to":"vertices/c","weight":2}]',
    { type: "list" } // or "auto"
    ); +
    + +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    await collection.import(
    '["_key","_from","_to","weight"]\r\n' +
    '["x","vertices/a","vertices/b",1]\r\n' +
    '["y","vertices/a","vertices/c",2]\r\n'
    ); +
    +
    +
    +

    Parameters

    +
      +
    • +
      data: string | Blob | Buffer
      +

      The data to import as a Buffer (Node), Blob (browser) or +string.

      +
    • +
    • +
      Optional options: CollectionImportOptions & {
          type?: "documents" | "list" | "auto";
      }
      +

      Options for importing the data.

      +
    +

    Returns Promise<CollectionImportResult>

+
+ +
    + +
  • +

    Retrieves a list of all incoming edges of the document matching the given +selector.

    +

    Throws an exception when passed a document or _id from a different +collection.

    + +

    Example

    const db = new Database();
    const collection = db.collection("edges");
    await collection.import([
    ["_key", "_from", "_to"],
    ["x", "vertices/a", "vertices/b"],
    ["y", "vertices/a", "vertices/c"],
    ["z", "vertices/d", "vertices/a"],
    ]);
    const edges = await collection.inEdges("vertices/a");
    console.log(edges.map((edge) => edge._key)); // ["z"] +
    +
    +
    +

    Parameters

    +
      +
    • +
      selector: DocumentSelector
      +

      Document _key, _id or object with either of those +properties (e.g. a document from this collection).

      +
    • +
    • +
      Optional options: CollectionEdgesOptions
      +

      Options for retrieving the edges.

      +
    +

    Returns Promise<ArangoApiResponse<CollectionEdgesResult<T>>>

+
+ +
    + +
  • +

    Returns an index description by name or id if it exists.

    + +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    const index = await collection.index("some-index"); +
    +
    +
    +

    Parameters

    +
      +
    • +
      selector: IndexSelector
      +

      Index name, id or object with either property.

      +
    +

    Returns Promise<Index>

+
+ +
    + +
  • +

    Returns a list of all index descriptions for the collection.

    + +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    const indexes = await collection.indexes(); +
    +
    +

    Returns Promise<Index[]>

+
+ +
    + +
  • +

    Retrieves a list of references for all documents in the collection.

    + +

    Deprecated

    Simple Queries have been deprecated in ArangoDB 3.4 and can be +replaced with AQL queries.

    + +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    // const ids = await collection.list("id");
    const ids = await db.query(aql`
    FOR doc IN ${collection}
    RETURN doc._id
    `); +
    + +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    // const keys = await collection.list("key");
    const keys = await db.query(aql`
    FOR doc IN ${collection}
    RETURN doc._key
    `); +
    + +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    // const paths = await collection.list("path");
    const paths = await db.query(aql`
    FOR doc IN ${collection}
    RETURN CONCAT("/_db/", CURRENT_DATABASE(), "/_api/document/", doc._id)
    `); +
    +
    +
    +

    Parameters

    +
    +

    Returns Promise<ArrayCursor<string>>

+
+ +
    + +
  • +

    (RocksDB only.) Instructs ArangoDB to load as many indexes of the +collection into memory as permitted by the memory limit.

    + +

    Example

    const db = new Database();
    const collection = db.collection("indexed-collection");
    await collection.loadIndexes();
    // the indexes are now loaded into memory +
    +
    +

    Returns Promise<boolean>

+
+ +
    + +
  • +

    Retrieves all documents matching the given document keys.

    + +

    Deprecated

    Simple Queries have been deprecated in ArangoDB 3.4 and can be +replaced with AQL queries.

    + +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    const keys = ["a", "b", "c"];
    // const docs = await collection.byKeys(keys);
    const cursor = await db.query(aql`
    FOR key IN ${keys}
    LET doc = DOCUMENT(${collection}, key)
    RETURN doc
    `);
    const docs = await cursor.all(); +
    +
    +
    +

    Parameters

    +
      +
    • +
      keys: string[]
      +

      An array of document keys to look up.

      +
    +

    Returns Promise<Edge<T>[]>

+
+ +
    + +
  • +

    Retrieves a list of all outgoing edges of the document matching the given +selector.

    +

    Throws an exception when passed a document or _id from a different +collection.

    + +

    Example

    const db = new Database();
    const collection = db.collection("edges");
    await collection.import([
    ["_key", "_from", "_to"],
    ["x", "vertices/a", "vertices/b"],
    ["y", "vertices/a", "vertices/c"],
    ["z", "vertices/d", "vertices/a"],
    ]);
    const edges = await collection.outEdges("vertices/a");
    console.log(edges.map((edge) => edge._key)); // ["x", "y"] +
    +
    +
    +

    Parameters

    +
      +
    • +
      selector: DocumentSelector
      +

      Document _key, _id or object with either of those +properties (e.g. a document from this collection).

      +
    • +
    • +
      Optional options: CollectionEdgesOptions
      +

      Options for retrieving the edges.

      +
    +

    Returns Promise<ArangoApiResponse<CollectionEdgesResult<T>>>

+
+ +
+
+ +
    + +
  • +

    (RocksDB only.) Instructs ArangoDB to recalculate the collection's +document count to fix any inconsistencies.

    + +

    Example

    const db = new Database();
    const collection = db.collection("inconsistent-collection");
    const badData = await collection.count();
    // oh no, the collection count looks wrong -- fix it!
    await collection.recalculateCount();
    const goodData = await collection.count();
    // goodData contains the collection's improved count +
    +
    +

    Returns Promise<boolean>

+
+ +
    + +
  • +

    Removes an existing document from the collection.

    +

    Throws an exception when passed a document or _id from a different +collection.

    + +

    Example

    const db = new Database();
    const collection = db.collection("friends");
    const doc = await collection.document("musadir");
    await collection.remove(doc);
    // document with key "musadir" deleted +
    +
    +
    +

    Parameters

    +
      +
    • +
      selector: DocumentSelector
      +

      Document _key, _id or object with either of those +properties (e.g. a document from this collection).

      +
    • +
    • +
      Optional options: CollectionRemoveOptions
      +

      Options for removing the document.

      +
    +

    Returns Promise<DocumentMetadata & {
        old?: Edge<T>;
    }>

+
+ +
+
+ +
+
+ +
    + +
  • +

    Removes all documents matching the given document keys.

    + +

    Deprecated

    Simple Queries have been deprecated in ArangoDB 3.4 and can be +replaced with AQL queries.

    + +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    const keys = ["a", "b", "c"];
    // const { removed, ignored } = await collection.removeByKeys(keys);
    const cursor = await db.query(aql`
    FOR key IN ${keys}
    LET doc = DOCUMENT(${collection}, key)
    FILTER doc
    REMOVE doc IN ${collection}
    RETURN key
    `);
    const removed = await cursor.all();
    const ignored = keys.filter((key) => !removed.includes(key)); +
    +
    +
    +

    Parameters

    +
    +

    Returns Promise<ArangoApiResponse<SimpleQueryRemoveByKeysResult<T>>>

+
+ +
    + +
  • +

    Renames the collection and updates the instance's name to newName.

    +

    Additionally removes the instance from the Database's internal +cache.

    +

    Note: Renaming collections may not be supported when ArangoDB is +running in a cluster configuration.

    + +

    Example

    const db = new Database();
    const collection1 = db.collection("some-collection");
    await collection1.rename("other-collection");
    const collection2 = db.collection("some-collection");
    const collection3 = db.collection("other-collection");
    // Note all three collection instances are different objects but
    // collection1 and collection3 represent the same ArangoDB collection! +
    +
    +
    +

    Parameters

    +
      +
    • +
      newName: string
      +

      The new name of the collection.

      +
    +

    Returns Promise<ArangoApiResponse<CollectionMetadata>>

+
+ +
    + +
  • +

    Replaces an existing document in the collection.

    +

    Throws an exception when passed a document or _id from a different +collection.

    + +

    Example

    const db = new Database();
    const collection = db.collection("friends");
    await collection.save(
    {
    _key: "musadir",
    _from: "users/rana",
    _to: "users/mudasir",
    active: true,
    best: true
    }
    );
    const result = await collection.replace(
    "musadir",
    { active: false },
    { returnNew: true }
    );
    console.log(result.new.active, result.new.best); // false undefined +
    +
    +
    +

    Parameters

    +
      +
    • +
      selector: DocumentSelector
      +

      Document _key, _id or object with either of those +properties (e.g. a document from this collection).

      +
    • +
    • +
      newData: DocumentData<T>
      +

      The contents of the new document.

      +
    • +
    • +
      Optional options: CollectionReplaceOptions
      +

      Options for replacing the document.

      +
    +

    Returns Promise<DocumentMetadata & {
        _oldRev?: string;
    } & {
        new?: Edge<T>;
        old?: Edge<T>;
    }>

+
+ +
    + +
  • +

    Replaces existing documents in the collection, identified by the _key or +_id of each document.

    + +

    Example

    const db = new Database();
    const collection = db.collection("friends");
    await collection.save(
    {
    _key: "musadir",
    _from: "users/rana",
    _to: "users/mudasir",
    active: true,
    best: true
    }
    );
    await collection.save(
    {
    _key: "salman",
    _from: "users/rana",
    _to: "users/salman",
    active: false,
    best: false
    }
    );
    const result = await collection.replaceAll(
    [
    { _key: "musadir", active: false },
    { _key: "salman", active: true, best: true }
    ],
    { returnNew: true }
    );
    console.log(result[0].new.active, result[0].new.best); // false undefined
    console.log(result[1].new.active, result[1].new.best); // true true +
    +
    +
    +

    Parameters

    +
      +
    • +
      newData: Object[]
      +

      The documents to replace.

      +
    • +
    • +
      Optional options: CollectionReplaceOptions
      +

      Options for replacing the documents.

      +
    +

    Returns Promise<(DocumentOperationFailure | DocumentMetadata & {
        _oldRev?: string;
    } & {
        new?: Edge<T>;
        old?: Edge<T>;
    })[]>

+
+ +
    + +
  • +

    Replaces all documents in the collection matching the given example.

    + +

    Deprecated

    Simple Queries have been deprecated in ArangoDB 3.4 and can be +replaced with AQL queries.

    + +

    Example

    const db = new Database();
    const collection = db.collection("some-collection");
    const newValue = { flavor: "chocolate" };
    // const { replaced } = await collection.replaceByExample(
    // { flavor: "strawberry" },
    // newValue
    // );
    const cursor = await db.query(aql`
    RETURN LENGTH(
    FOR doc IN ${collection}
    FILTER doc.flavor == "strawberry"
    REPLACE doc WITH ${newValue} IN ${collection}
    RETURN 1
    )
    `);
    const replaced = await cursor.next(); +
    +
    +
    +

    Parameters

    +
    +

    Returns Promise<ArangoApiResponse<SimpleQueryReplaceByExampleResult>>

+
+ +
+
+ +
    + +
  • +

    Inserts a new document with the given data into the collection.

    + +

    Example

    const db = new Database();
    const collection = db.collection("friends");
    const result = await collection.save(
    { _from: "users/rana", _to: "users/mudasir", active: false },
    { returnNew: true }
    ); +
    +
    +
    +

    Parameters

    +
    +

    Returns Promise<DocumentMetadata & {
        _oldRev?: string;
    } & {
        new?: Edge<T>;
        old?: Edge<T>;
    }>

+
+ +
    + +
  • +

    Inserts new documents with the given data into the collection.

    + +

    Example

    const db = new Database();
    const collection = db.collection("friends");
    const result = await collection.saveAll(
    [
    { _from: "users/rana", _to: "users/mudasir", active: false },
    { _from: "users/rana", _to: "users/salman", active: true }
    ],
    { returnNew: true }
    ); +
    +
    +
    +

    Parameters

    +
    +

    Returns Promise<(DocumentOperationFailure | DocumentMetadata & {
        _oldRev?: string;
    } & {
        new?: Edge<T>;
        old?: Edge<T>;
    })[]>

+
+ +
    + +
  • +

    Performs a traversal starting from the given startVertex and following +edges contained in this edge collection.

    +

    Throws an exception when passed a document or _id from a different +collection.

    +

    See also traversal.

    + +

    Deprecated

    Simple Queries have been deprecated in ArangoDB 3.4 and are +no longer supported in ArangoDB 3.12. They can be replaced with AQL queries.

    + +

    Example

    const db = new Database();
    const collection = db.collection("edges");
    await collection.import([
    ["_key", "_from", "_to"],
    ["x", "vertices/a", "vertices/b"],
    ["y", "vertices/b", "vertices/c"],
    ["z", "vertices/c", "vertices/d"],
    ]);
    const startVertex = "vertices/a";
    const cursor = await db.query(aql`
    FOR vertex IN OUTBOUND ${startVertex}
    RETURN vertex._key
    `);
    const result = await cursor.all();
    console.log(result); // ["a", "b", "c", "d"] +
    +
    +
    +

    Parameters

    +
      +
    • +
      startVertex: DocumentSelector
      +

      Document _key, _id or object with either of those +properties (e.g. a document from this collection).

      +
    • +
    • +
      Optional options: TraversalOptions
      +

      Options for performing the traversal.

      +
    +

    Returns Promise<any>

+
+ +
+
+ +
    + +
  • +

    Updates an existing document in the collection.

    +

    Throws an exception when passed a document or _id from a different +collection.

    + +

    Example

    const db = new Database();
    const collection = db.collection("friends");
    await collection.save(
    {
    _key: "musadir",
    _from: "users/rana",
    _to: "users/mudasir",
    active: true,
    best: true
    }
    );
    const result = await collection.update(
    "musadir",
    { active: false },
    { returnNew: true }
    );
    console.log(result.new.active, result.new.best); // false true +
    +
    +
    +

    Parameters

    +
      +
    • +
      selector: DocumentSelector
      +

      Document _key, _id or object with either of those +properties (e.g. a document from this collection).

      +
    • +
    • +
      newData: Patch<DocumentData<T>>
      +

      The data for updating the document.

      +
    • +
    • +
      Optional options: CollectionUpdateOptions
      +

      Options for updating the document.

      +
    +

    Returns Promise<DocumentMetadata & {
        _oldRev?: string;
    } & {
        new?: Edge<T>;
        old?: Edge<T>;
    }>

+
+ +
    + +
  • +

    Updates existing documents in the collection, identified by the _key or +_id of each document.

    +
    +
    +

    Parameters

    +
      +
    • +
      newData: Object[]
      +

      The data for updating the documents.

      +
    • +
    • +
      Optional options: CollectionUpdateOptions
      +

      Options for updating the documents.

      +
      const db = new Database();
      const collection = db.collection("friends");
      await collection.save(
      {
      _key: "musadir",
      _from: "users/rana",
      _to: "users/mudasir",
      active: true,
      best: true
      }
      );
      await collection.save(
      {
      _key: "salman",
      _from: "users/rana",
      _to: "users/salman",
      active: false,
      best: false
      }
      );
      const result = await collection.updateAll(
      [
      { _key: "musadir", active: false },
      { _key: "salman", active: true, best: true }
      ],
      { returnNew: true }
      );
      console.log(result[0].new.active, result[0].new.best); // false true
      console.log(result[1].new.active, result[1].new.best); // true true +
      +
    +

    Returns Promise<(DocumentOperationFailure | DocumentMetadata & {
        _oldRev?: string;
    } & {
        new?: Edge<T>;
        old?: Edge<T>;
    })[]>

+
+ +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/interfaces/cursor.CursorExtras.html b/8.8.0/interfaces/cursor.CursorExtras.html new file mode 100644 index 000000000..3590887c4 --- /dev/null +++ b/8.8.0/interfaces/cursor.CursorExtras.html @@ -0,0 +1,110 @@ +CursorExtras | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Interface CursorExtras

+
+

Additional information about the cursor.

+
+
+

Hierarchy

+
    +
  • CursorExtras
+
+
+
+ +
+
+

Properties

+
+
+

Properties

+
+ +
plan?: Record<string, any>
+

Query execution plan for the executed query.

+
+
+ +
profile?: Record<string, number>
+

Additional profiling information for the executed query.

+
+
+ +
stats?: CursorStats
+

Additional statistics about the query execution.

+
+
+ +
warnings: {
    code: number;
    message: string;
}[]
+

Warnings encountered while executing the query.

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/interfaces/cursor.CursorStats.html b/8.8.0/interfaces/cursor.CursorStats.html new file mode 100644 index 000000000..a73ea4e0f --- /dev/null +++ b/8.8.0/interfaces/cursor.CursorStats.html @@ -0,0 +1,202 @@ +CursorStats | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Interface CursorStats

+
+

Additional statics about the query execution of the cursor.

+
+
+

Hierarchy

+
    +
  • CursorStats
+
+
+
+ +
+
+

Properties

+
+ +
cacheHits: number
+

Total number of index entries read from in-memory caches for indexes of +type edge or persistent.

+
+
+ +
cacheMisses: number
+

Total number of cache read attempts for index entries that could not be +served from in-memory caches for indexes of type edge or persistent.

+
+
+ +
cursorsCreated: number
+

Total number of cursor objects created during query execution.

+
+
+ +
cursorsRearmed: number
+

Total number of times an existing cursor object was repurposed.

+
+
+ +
executionTime: number
+

Execution time of the query in seconds.

+
+
+ +
filtered: number
+

Total number of documents that were removed after executing a filter condition in a FilterNode.

+
+
+ +
fullCount?: number
+

Total number of documents that matched the search condition if the query’s final top-level LIMIT statement were not present.

+
+
+ +
httpRequests: number
+

Total number of cluster-internal HTTP requests performed.

+
+
+ +
nodes?: {
    calls: number;
    filter: number;
    id: number;
    items: number;
    runtime: number;
}[]
+

Runtime statistics per query execution node if profile was set to 2 or greater.

+
+
+ +
peakMemoryUsage: number
+

Maximum memory usage of the query while it was running.

+
+
+ +
scannedFull: number
+

Total number of documents iterated over when scanning a collection without an index.

+
+
+ +
scannedIndex: number
+

Total number of documents iterated over when scanning a collection using an index.

+
+
+ +
writesExecuted: number
+

Total number of data-modification operations successfully executed.

+
+
+ +
writesIgnored: number
+

Total number of data-modification operations that were unsuccessful, but have been ignored because of query option ignoreErrors.

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/interfaces/error.SystemError.html b/8.8.0/interfaces/error.SystemError.html new file mode 100644 index 000000000..ad93e576a --- /dev/null +++ b/8.8.0/interfaces/error.SystemError.html @@ -0,0 +1,97 @@ +SystemError | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Interface SystemError

+
+

Interface representing a Node.js SystemError.

+
+
+

Hierarchy

+
    +
  • Error +
      +
    • SystemError
+
+
+
+ +
+
+

Properties

+
+
+

Properties

+
+ +
code: string
+
+ +
errno: string | number
+
+ +
syscall: string
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/interfaces/view.ArangoSearchViewStoredValueOptions.html b/8.8.0/interfaces/view.ArangoSearchViewStoredValueOptions.html new file mode 100644 index 000000000..b322a120c --- /dev/null +++ b/8.8.0/interfaces/view.ArangoSearchViewStoredValueOptions.html @@ -0,0 +1,105 @@ +ArangoSearchViewStoredValueOptions | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Interface ArangoSearchViewStoredValueOptions

+
+

Options for creating a stored value in an ArangoSearch View.

+
+
+

Hierarchy

+
    +
  • ArangoSearchViewStoredValueOptions
+
+
+
+ +
+
+

Properties

+
+
+

Properties

+
+ +
cache?: boolean
+

(Enterprise Edition only.) If set to true, then stored values will +always be cached in memory.

+

Default: false

+
+
+ +
compression?: Compression
+

How the attribute values should be compressed.

+

Default: "lz4"

+
+
+ +
fields: string[]
+

Attribute paths for which values should be stored in the view index +in addition to those used for sorting via primarySort.

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/modules.html b/8.8.0/modules.html new file mode 100644 index 000000000..d59cf5763 --- /dev/null +++ b/8.8.0/modules.html @@ -0,0 +1,69 @@ +arangojs - v8.8.0
+
+ +
+
+
+
+

arangojs - v8.8.0

+
+
+

Index

+
+

Modules

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/modules/analyzer.html b/8.8.0/modules/analyzer.html new file mode 100644 index 000000000..9cfe11c12 --- /dev/null +++ b/8.8.0/modules/analyzer.html @@ -0,0 +1,162 @@ +analyzer | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Module analyzer

+
+
import type { Analyzer } from "arangojs/analyzer";
+
+

The "analyzer" module provides analyzer related types and interfaces +for TypeScript.

+
+
+
+
+
+

Index

+
+

Classes

+
+
+

Type Aliases

+
+
+

Functions

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/modules/aql.html b/8.8.0/modules/aql.html new file mode 100644 index 000000000..ab497d593 --- /dev/null +++ b/8.8.0/modules/aql.html @@ -0,0 +1,91 @@ +aql | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Module aql

+
+
import { aql } from "arangojs/aql";
+
+

The "aql" module provides the aql template string handler and +helper functions, as well as associated types and interfaces for TypeScript.

+

The aql function and namespace is also re-exported by the "index" module.

+
+
+
+
+
+

Index

+
+

Interfaces

+
+
+

Type Aliases

+
+
+

Functions

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/modules/collection.html b/8.8.0/modules/collection.html new file mode 100644 index 000000000..4a08a4938 --- /dev/null +++ b/8.8.0/modules/collection.html @@ -0,0 +1,175 @@ +collection | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Module collection

+
+
import type {
DocumentCollection,
EdgeCollection,
} from "arangojs/collection"; +
+

The "collection" module provides collection related types and interfaces +for TypeScript.

+
+
+
+
+
+

Index

+
+

Enumerations

+
+
+

Interfaces

+
+
+

Type Aliases

+
+
+

Functions

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/modules/connection.html b/8.8.0/modules/connection.html new file mode 100644 index 000000000..66e0a23b8 --- /dev/null +++ b/8.8.0/modules/connection.html @@ -0,0 +1,92 @@ +connection | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Module connection

+
+
import type { Config } from "arangojs/connection";
+
+

The "connection" module provides connection and configuration related types +for TypeScript.

+
+
+
+
+
+

Index

+
+

Type Aliases

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/modules/cursor.html b/8.8.0/modules/cursor.html new file mode 100644 index 000000000..e9c9f878e --- /dev/null +++ b/8.8.0/modules/cursor.html @@ -0,0 +1,78 @@ +cursor | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Module cursor

+
+
import type { ArrayCursor, BatchedArrayCursor } from "arangojs/cursor";
+
+

The "cursor" module provides cursor-related interfaces for TypeScript.

+
+
+
+
+
+

Index

+
+

Classes

+
+
+

Interfaces

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/modules/database.html b/8.8.0/modules/database.html new file mode 100644 index 000000000..6740f1dab --- /dev/null +++ b/8.8.0/modules/database.html @@ -0,0 +1,206 @@ +database | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Module database

+
+
import { Database } from "arangojs/database";
+
+

The "database" module provides the Database class and associated +types and interfaces for TypeScript.

+

The Database class is also re-exported by the "index" module.

+
+
+
+
+
+

Index

+
+

Enumerations

+
+
+

Classes

+
+
+

Type Aliases

+
+
+

Functions

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/modules/documents.html b/8.8.0/modules/documents.html new file mode 100644 index 000000000..ad4893bc0 --- /dev/null +++ b/8.8.0/modules/documents.html @@ -0,0 +1,87 @@ +documents | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Module documents

+
+
import type { Document, Edge } from "arangojs/documents";
+
+

The "documents" module provides document/edge related types for TypeScript.

+
+
+
+
+
+

Index

+
+

Type Aliases

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/modules/error.html b/8.8.0/modules/error.html new file mode 100644 index 000000000..83e37f161 --- /dev/null +++ b/8.8.0/modules/error.html @@ -0,0 +1,84 @@ +error | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Module error

+
+
import type { ArangoError, HttpError } from "arangojs/error";
+
+

The "error" module provides types and interfaces for TypeScript related +to arangojs error handling.

+
+
+
+
+
+

Index

+
+

Classes

+
+
+

Interfaces

+
+
+

Functions

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/modules/foxx_manifest.html b/8.8.0/modules/foxx_manifest.html new file mode 100644 index 000000000..dc520eba7 --- /dev/null +++ b/8.8.0/modules/foxx_manifest.html @@ -0,0 +1,77 @@ +foxx-manifest | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Module foxx-manifest

+
+
import type { FoxxManifest } from "arangojs/foxx-manifest";
+
+

The "foxx-manifest" module provides the Foxx manifest type for TypeScript.

+

Generated from JSON Schema +using json-schema-to-typescript.

+
+
+
+
+
+

Index

+
+

Type Aliases

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/modules/graph.html b/8.8.0/modules/graph.html new file mode 100644 index 000000000..d7a7ba7a0 --- /dev/null +++ b/8.8.0/modules/graph.html @@ -0,0 +1,104 @@ +graph | arangojs - v8.8.0
+
+ +
+ +
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/modules/index.html b/8.8.0/modules/index.html new file mode 100644 index 000000000..3862af4b9 --- /dev/null +++ b/8.8.0/modules/index.html @@ -0,0 +1,92 @@ +index | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Module index

+
+
import arangojs, { aql, Database } from "arangojs";
+
+

The "index" module is the default entry point when importing the arangojs +module or using the web build in the browser.

+

If you are just getting started, you probably want to use the +arangojs function, which is also the default export of this module, +or the Database class for which it is a wrapper.

+
+
+
+
+
+
+ +
+
+

References

+
+
+

Functions

+
+
+

References

+
+Re-exports Database
+
+Re-exports aql
+
+Renames and re-exports arangojs
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/modules/indexes.html b/8.8.0/modules/indexes.html new file mode 100644 index 000000000..a1af96207 --- /dev/null +++ b/8.8.0/modules/indexes.html @@ -0,0 +1,113 @@ +indexes | arangojs - v8.8.0
+
+ +
+ +
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/modules/job.html b/8.8.0/modules/job.html new file mode 100644 index 000000000..6ee858e82 --- /dev/null +++ b/8.8.0/modules/job.html @@ -0,0 +1,64 @@ +job | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Module job

+
+
+
+
+

Index

+
+

Classes

+
Job +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/modules/route.html b/8.8.0/modules/route.html new file mode 100644 index 000000000..2e8c3380f --- /dev/null +++ b/8.8.0/modules/route.html @@ -0,0 +1,69 @@ +route | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Module route

+
+
import type { Route } from "arangojs/route";
+
+

The "route" module provides route related types and interfaces for TypeScript.

+
+
+
+
+
+

Index

+
+

Classes

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/modules/transaction.html b/8.8.0/modules/transaction.html new file mode 100644 index 000000000..13c26b08b --- /dev/null +++ b/8.8.0/modules/transaction.html @@ -0,0 +1,84 @@ +transaction | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Module transaction

+
+
import type { Transaction } from "arangojs/transaction";
+
+

The "transaction" module provides transaction related types and interfaces +for TypeScript.

+
+
+
+
+
+

Index

+
+

Classes

+
+
+

Type Aliases

+
+
+

Functions

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/modules/view.html b/8.8.0/modules/view.html new file mode 100644 index 000000000..dd1f55e82 --- /dev/null +++ b/8.8.0/modules/view.html @@ -0,0 +1,130 @@ +view | arangojs - v8.8.0
+
+ +
+
+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/analyzer.AnalyzerDescription.html b/8.8.0/types/analyzer.AnalyzerDescription.html new file mode 100644 index 000000000..2cd8da4b2 --- /dev/null +++ b/8.8.0/types/analyzer.AnalyzerDescription.html @@ -0,0 +1,102 @@ +AnalyzerDescription | arangojs - v8.8.0
+
+ +
+
+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/analyzer.AnalyzerFeature.html b/8.8.0/types/analyzer.AnalyzerFeature.html new file mode 100644 index 000000000..831f7b362 --- /dev/null +++ b/8.8.0/types/analyzer.AnalyzerFeature.html @@ -0,0 +1,102 @@ +AnalyzerFeature | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias AnalyzerFeature

+
AnalyzerFeature: "frequency" | "norm" | "position" | "offset"
+

Name of a feature enabled for an Analyzer.

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/analyzer.AqlAnalyzerDescription.html b/8.8.0/types/analyzer.AqlAnalyzerDescription.html new file mode 100644 index 000000000..b0e3b7205 --- /dev/null +++ b/8.8.0/types/analyzer.AqlAnalyzerDescription.html @@ -0,0 +1,102 @@ +AqlAnalyzerDescription | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias AqlAnalyzerDescription

+
AqlAnalyzerDescription: GenericAnalyzerDescription & {
    properties: {
        batchSize: number;
        collapsePositions: boolean;
        keepNull: boolean;
        memoryLimit: number;
        queryString: string;
        returnType: "string" | "number" | "bool";
    };
    type: "aql";
}
+

An object describing an AQL Analyzer

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/analyzer.ClassificationAnalyzerDescription.html b/8.8.0/types/analyzer.ClassificationAnalyzerDescription.html new file mode 100644 index 000000000..34695ba01 --- /dev/null +++ b/8.8.0/types/analyzer.ClassificationAnalyzerDescription.html @@ -0,0 +1,102 @@ +ClassificationAnalyzerDescription | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias ClassificationAnalyzerDescription

+
ClassificationAnalyzerDescription: GenericAnalyzerDescription & {
    properties: {
        model_location: string;
        threshold: number;
        top_k: number;
    };
    type: "classification";
}
+

(Enterprise Edition only.) An object describing a Classification Analyzer

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/analyzer.CollationAnalyzerDescription.html b/8.8.0/types/analyzer.CollationAnalyzerDescription.html new file mode 100644 index 000000000..a4f5e3319 --- /dev/null +++ b/8.8.0/types/analyzer.CollationAnalyzerDescription.html @@ -0,0 +1,102 @@ +CollationAnalyzerDescription | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias CollationAnalyzerDescription

+
CollationAnalyzerDescription: GenericAnalyzerDescription & {
    properties: {
        locale: string;
    };
    type: "collation";
}
+

An object describing a Collation Analyzer

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/analyzer.CreateAnalyzerOptions.html b/8.8.0/types/analyzer.CreateAnalyzerOptions.html new file mode 100644 index 000000000..2004059f1 --- /dev/null +++ b/8.8.0/types/analyzer.CreateAnalyzerOptions.html @@ -0,0 +1,102 @@ +CreateAnalyzerOptions | arangojs - v8.8.0
+
+ +
+
+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/analyzer.CreateAqlAnalyzerOptions.html b/8.8.0/types/analyzer.CreateAqlAnalyzerOptions.html new file mode 100644 index 000000000..a10208d20 --- /dev/null +++ b/8.8.0/types/analyzer.CreateAqlAnalyzerOptions.html @@ -0,0 +1,148 @@ +CreateAqlAnalyzerOptions | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias CreateAqlAnalyzerOptions

+
CreateAqlAnalyzerOptions: {
    features?: AnalyzerFeature[];
    properties: {
        batchSize?: number;
        collapsePositions?: boolean;
        keepNull?: boolean;
        memoryLimit?: number;
        queryString: string;
        returnType?: "string" | "number" | "bool";
    };
    type: "aql";
}
+

Options for creating an AQL Analyzer

+
+
+

Type declaration

+
    +
  • +
    Optional features?: AnalyzerFeature[]
    +

    Features to enable for this Analyzer.

    +
  • +
  • +
    properties: {
        batchSize?: number;
        collapsePositions?: boolean;
        keepNull?: boolean;
        memoryLimit?: number;
        queryString: string;
        returnType?: "string" | "number" | "bool";
    }
    +

    Additional properties for the Analyzer.

    +
    +
      +
    • +
      Optional batchSize?: number
      +

      Number between 1 and 1000 that determines the batch size for reading +data from the query.

      +

      Default: 1

      +
    • +
    • +
      Optional collapsePositions?: boolean
      +

      If set to true, the position is set to 0 for all members of the query result array.

      +

      Default: false

      +
    • +
    • +
      Optional keepNull?: boolean
      +

      If set to false, null values will be discarded from the View index.

      +

      Default: true

      +
    • +
    • +
      Optional memoryLimit?: number
      +

      Memory limit for query execution in bytes.

      +

      Default: 1048576 (1 MiB)

      +
    • +
    • +
      queryString: string
      +

      AQL query to be executed.

      +
    • +
    • +
      Optional returnType?: "string" | "number" | "bool"
      +

      Data type of the returned tokens.

      +

      Default: "string"

      +
  • +
  • +
    type: "aql"
    +

    Type of the Analyzer.

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/analyzer.CreateClassificationAnalyzerOptions.html b/8.8.0/types/analyzer.CreateClassificationAnalyzerOptions.html new file mode 100644 index 000000000..6cd7a1aba --- /dev/null +++ b/8.8.0/types/analyzer.CreateClassificationAnalyzerOptions.html @@ -0,0 +1,132 @@ +CreateClassificationAnalyzerOptions | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias CreateClassificationAnalyzerOptions

+
CreateClassificationAnalyzerOptions: {
    features?: AnalyzerFeature[];
    properties: {
        model_location: string;
        threshold?: number;
        top_k?: number;
    };
    type: "classification";
}
+

(Enterprise Edition only.) Options for creating a Classification Analyzer

+
+
+

Type declaration

+
    +
  • +
    Optional features?: AnalyzerFeature[]
    +

    Features to enable for this Analyzer.

    +
  • +
  • +
    properties: {
        model_location: string;
        threshold?: number;
        top_k?: number;
    }
    +

    Additional properties for the Analyzer.

    +
    +
      +
    • +
      model_location: string
      +

      On-disk path to the trained fastText supervised model.

      +
    • +
    • +
      Optional threshold?: number
      +

      Probability threshold for which a label will be assigned to an input.

      +

      Default: 0.99

      +
    • +
    • +
      Optional top_k?: number
      +

      Number of class labels that will be produced per input.

      +

      Default: 1

      +
  • +
  • +
    type: "classification"
    +

    Type of the Analyzer.

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/analyzer.CreateCollationAnalyzerOptions.html b/8.8.0/types/analyzer.CreateCollationAnalyzerOptions.html new file mode 100644 index 000000000..ffe26ae03 --- /dev/null +++ b/8.8.0/types/analyzer.CreateCollationAnalyzerOptions.html @@ -0,0 +1,123 @@ +CreateCollationAnalyzerOptions | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias CreateCollationAnalyzerOptions

+
CreateCollationAnalyzerOptions: {
    features?: AnalyzerFeature[];
    properties: {
        locale: string;
    };
    type: "collation";
}
+

Options for creating a Collation Analyzer

+
+
+

Type declaration

+
    +
  • +
    Optional features?: AnalyzerFeature[]
    +

    Features to enable for this Analyzer.

    +
  • +
  • +
    properties: {
        locale: string;
    }
    +

    Additional properties for the Analyzer.

    +
    +
      +
    • +
      locale: string
      +

      Text locale.

      +

      Format: language[_COUNTRY][.encoding][@variant]

      +
  • +
  • +
    type: "collation"
    +

    Type of the Analyzer.

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/analyzer.CreateDelimiterAnalyzerOptions.html b/8.8.0/types/analyzer.CreateDelimiterAnalyzerOptions.html new file mode 100644 index 000000000..34919f338 --- /dev/null +++ b/8.8.0/types/analyzer.CreateDelimiterAnalyzerOptions.html @@ -0,0 +1,119 @@ +CreateDelimiterAnalyzerOptions | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias CreateDelimiterAnalyzerOptions

+
CreateDelimiterAnalyzerOptions: {
    features?: AnalyzerFeature[];
    properties: string | {
        delimiter: string;
    };
    type: "delimiter";
}
+

Options for creating a Delimiter Analyzer.

+
+
+

Type declaration

+
    +
  • +
    Optional features?: AnalyzerFeature[]
    +

    Features to enable for this Analyzer.

    +
  • +
  • +
    properties: string | {
        delimiter: string;
    }
    +

    Additional properties for the Analyzer.

    +

    The value will be used as delimiter to split text into tokens as specified +in RFC 4180, without starting new records on newlines.

    +
  • +
  • +
    type: "delimiter"
    +

    Type of the Analyzer.

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/analyzer.CreateGeoJsonAnalyzerOptions.html b/8.8.0/types/analyzer.CreateGeoJsonAnalyzerOptions.html new file mode 100644 index 000000000..ef4c1596d --- /dev/null +++ b/8.8.0/types/analyzer.CreateGeoJsonAnalyzerOptions.html @@ -0,0 +1,138 @@ +CreateGeoJsonAnalyzerOptions | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias CreateGeoJsonAnalyzerOptions

+
CreateGeoJsonAnalyzerOptions: {
    features?: AnalyzerFeature[];
    properties: {
        options?: {
            maxCells?: number;
            maxLevel?: number;
            minLevel?: number;
        };
        type?: "shape" | "centroid" | "point";
    };
    type: "geojson";
}
+

Options for creating a GeoJSON Analyzer

+
+
+

Type declaration

+
    +
  • +
    Optional features?: AnalyzerFeature[]
    +

    Features to enable for this Analyzer.

    +
  • +
  • +
    properties: {
        options?: {
            maxCells?: number;
            maxLevel?: number;
            minLevel?: number;
        };
        type?: "shape" | "centroid" | "point";
    }
    +

    Additional properties for the Analyzer.

    +
    +
      +
    • +
      Optional options?: {
          maxCells?: number;
          maxLevel?: number;
          minLevel?: number;
      }
      +

      Options for fine-tuning geo queries.

      +

      Default: { maxCells: 20, minLevel: 4, maxLevel: 23 }

      +
      +
        +
      • +
        Optional maxCells?: number
      • +
      • +
        Optional maxLevel?: number
      • +
      • +
        Optional minLevel?: number
    • +
    • +
      Optional type?: "shape" | "centroid" | "point"
      +

      If set to "centroid", only the centroid of the input geometry will be +computed and indexed.

      +

      If set to "point" only GeoJSON objects of type Point will be indexed and +all other geometry types will be ignored.

      +

      Default: "shape"

      +
  • +
  • +
    type: "geojson"
    +

    Type of the Analyzer.

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/analyzer.CreateGeoPointAnalyzerOptions.html b/8.8.0/types/analyzer.CreateGeoPointAnalyzerOptions.html new file mode 100644 index 000000000..c695d4537 --- /dev/null +++ b/8.8.0/types/analyzer.CreateGeoPointAnalyzerOptions.html @@ -0,0 +1,140 @@ +CreateGeoPointAnalyzerOptions | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias CreateGeoPointAnalyzerOptions

+
CreateGeoPointAnalyzerOptions: {
    features?: AnalyzerFeature[];
    properties: {
        latitude?: string[];
        longitude?: string[];
        options?: {
            maxLevel?: number;
            minCells?: number;
            minLevel?: number;
        };
    };
    type: "geopoint";
}
+

Options for creating a GeoPoint Analyzer

+
+
+

Type declaration

+
    +
  • +
    Optional features?: AnalyzerFeature[]
    +

    Features to enable for this Analyzer.

    +
  • +
  • +
    properties: {
        latitude?: string[];
        longitude?: string[];
        options?: {
            maxLevel?: number;
            minCells?: number;
            minLevel?: number;
        };
    }
    +

    Additional properties for the Analyzer.

    +
    +
      +
    • +
      Optional latitude?: string[]
      +

      Attribute paths of the latitude value relative to the field for which the +Analyzer is defined in the View.

      +
    • +
    • +
      Optional longitude?: string[]
      +

      Attribute paths of the longitude value relative to the field for which the +Analyzer is defined in the View.

      +
    • +
    • +
      Optional options?: {
          maxLevel?: number;
          minCells?: number;
          minLevel?: number;
      }
      +

      Options for fine-tuning geo queries.

      +

      Default: { maxCells: 20, minLevel: 4, maxLevel: 23 }

      +
      +
        +
      • +
        Optional maxLevel?: number
      • +
      • +
        Optional minCells?: number
      • +
      • +
        Optional minLevel?: number
  • +
  • +
    type: "geopoint"
    +

    Type of the Analyzer.

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/analyzer.CreateGeoS2AnalyzerOptions.html b/8.8.0/types/analyzer.CreateGeoS2AnalyzerOptions.html new file mode 100644 index 000000000..5f70f6cbb --- /dev/null +++ b/8.8.0/types/analyzer.CreateGeoS2AnalyzerOptions.html @@ -0,0 +1,148 @@ +CreateGeoS2AnalyzerOptions | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias CreateGeoS2AnalyzerOptions

+
CreateGeoS2AnalyzerOptions: {
    features?: AnalyzerFeature[];
    properties: {
        format?: "latLngDouble" | "latLngInt" | "s2Point";
        options?: {
            maxCells?: number;
            maxLevel?: number;
            minLevel?: number;
        };
        type?: "shape" | "centroid" | "point";
    };
    type: "geo_s2";
}
+

(Enterprise Edition only.) Options for creating a Geo S2 Analyzer

+
+
+

Type declaration

+
    +
  • +
    Optional features?: AnalyzerFeature[]
    +

    Features to enable for this Analyzer.

    +
  • +
  • +
    properties: {
        format?: "latLngDouble" | "latLngInt" | "s2Point";
        options?: {
            maxCells?: number;
            maxLevel?: number;
            minLevel?: number;
        };
        type?: "shape" | "centroid" | "point";
    }
    +

    Additional properties for the Analyzer.

    +
    +
      +
    • +
      Optional format?: "latLngDouble" | "latLngInt" | "s2Point"
      +

      If set to "latLngDouble", each latitude and longitude value is stored +as an 8-byte floating-point value (16 bytes per coordinate pair).

      +

      If set to "latLngInt", each latitude and longitude value is stored as +a 4-byte integer value (8 bytes per coordinate pair).

      +

      If set to "s2Point", each longitude-latitude pair is stored in the +native format of Google S2 (24 bytes per coordinate pair).

      +

      Default: "latLngDouble"

      +
    • +
    • +
      Optional options?: {
          maxCells?: number;
          maxLevel?: number;
          minLevel?: number;
      }
      +

      Options for fine-tuning geo queries.

      +

      Default: { maxCells: 20, minLevel: 4, maxLevel: 23 }

      +
      +
        +
      • +
        Optional maxCells?: number
      • +
      • +
        Optional maxLevel?: number
      • +
      • +
        Optional minLevel?: number
    • +
    • +
      Optional type?: "shape" | "centroid" | "point"
      +

      If set to "centroid", only the centroid of the input geometry will be +computed and indexed.

      +

      If set to "point" only GeoJSON objects of type Point will be indexed and +all other geometry types will be ignored.

      +

      Default: "shape"

      +
  • +
  • +
    type: "geo_s2"
    +

    Type of the Analyzer.

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/analyzer.CreateIdentityAnalyzerOptions.html b/8.8.0/types/analyzer.CreateIdentityAnalyzerOptions.html new file mode 100644 index 000000000..bd9f51e26 --- /dev/null +++ b/8.8.0/types/analyzer.CreateIdentityAnalyzerOptions.html @@ -0,0 +1,118 @@ +CreateIdentityAnalyzerOptions | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias CreateIdentityAnalyzerOptions

+
CreateIdentityAnalyzerOptions: {
    features?: AnalyzerFeature[];
    properties?: Record<string, never>;
    type: "identity";
}
+

Options for creating an Identity Analyzer.

+
+
+

Type declaration

+
    +
  • +
    Optional features?: AnalyzerFeature[]
    +

    Features to enable for this Analyzer.

    +
  • +
  • +
    Optional properties?: Record<string, never>
    +

    Additional properties for the Analyzer.

    +

    The identity Analyzer does not take additional properties.

    +
  • +
  • +
    type: "identity"
    +

    Type of the Analyzer.

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/analyzer.CreateMinHashAnalyzerOptions.html b/8.8.0/types/analyzer.CreateMinHashAnalyzerOptions.html new file mode 100644 index 000000000..97f5a5c2c --- /dev/null +++ b/8.8.0/types/analyzer.CreateMinHashAnalyzerOptions.html @@ -0,0 +1,126 @@ +CreateMinHashAnalyzerOptions | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias CreateMinHashAnalyzerOptions

+
CreateMinHashAnalyzerOptions: {
    features?: AnalyzerFeature[];
    properties: {
        analyzer: Omit<CreateAnalyzerOptions, "features">;
        numHashes: number;
    };
    type: "minhash";
}
+

(Enterprise Edition only.) Options for creating a MinHash Analyzer

+
+
+

Type declaration

+
    +
  • +
    Optional features?: AnalyzerFeature[]
    +

    Features to enable for this Analyzer.

    +
  • +
  • +
    properties: {
        analyzer: Omit<CreateAnalyzerOptions, "features">;
        numHashes: number;
    }
    +

    Additional properties for the Analyzer.

    +
    +
      +
    • +
      analyzer: Omit<CreateAnalyzerOptions, "features">
      +

      An Analyzer definition-like object with type and properties attributes.

      +
    • +
    • +
      numHashes: number
      +

      Size of the MinHash signature.

      +
  • +
  • +
    type: "minhash"
    +

    Type of the Analyzer.

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/analyzer.CreateMultiDelimiterAnalyzerOptions.html b/8.8.0/types/analyzer.CreateMultiDelimiterAnalyzerOptions.html new file mode 100644 index 000000000..45002c75e --- /dev/null +++ b/8.8.0/types/analyzer.CreateMultiDelimiterAnalyzerOptions.html @@ -0,0 +1,122 @@ +CreateMultiDelimiterAnalyzerOptions | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias CreateMultiDelimiterAnalyzerOptions

+
CreateMultiDelimiterAnalyzerOptions: {
    features?: AnalyzerFeature[];
    properties: {
        delimiters: string[];
    };
    type: "multi_delimiter";
}
+

Options for creating a Multi-Delimiter Analyzer.

+
+
+

Type declaration

+
    +
  • +
    Optional features?: AnalyzerFeature[]
    +

    Features to enable for this Analyzer.

    +
  • +
  • +
    properties: {
        delimiters: string[];
    }
    +

    Additional properties for the Analyzer.

    +

    The value will be used as delimiter to split text into tokens as specified +in RFC 4180, without starting new records on newlines.

    +
    +
      +
    • +
      delimiters: string[]
  • +
  • +
    type: "multi_delimiter"
    +

    Type of the Analyzer.

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/analyzer.CreateNearestNeighborsAnalyzerOptions.html b/8.8.0/types/analyzer.CreateNearestNeighborsAnalyzerOptions.html new file mode 100644 index 000000000..1a38f4075 --- /dev/null +++ b/8.8.0/types/analyzer.CreateNearestNeighborsAnalyzerOptions.html @@ -0,0 +1,127 @@ +CreateNearestNeighborsAnalyzerOptions | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias CreateNearestNeighborsAnalyzerOptions

+
CreateNearestNeighborsAnalyzerOptions: {
    features?: AnalyzerFeature[];
    properties: {
        model_location: string;
        top_k?: number;
    };
    type: "nearest_neighbors";
}
+

(Enterprise Edition only.) Options for creating a NearestNeighbors Analyzer.

+
+
+

Type declaration

+
    +
  • +
    Optional features?: AnalyzerFeature[]
    +

    Features to enable for this Analyzer.

    +
  • +
  • +
    properties: {
        model_location: string;
        top_k?: number;
    }
    +

    Additional properties for the Analyzer.

    +
    +
      +
    • +
      model_location: string
      +

      On-disk path to the trained fastText supervised model.

      +
    • +
    • +
      Optional top_k?: number
      +

      Number of class labels that will be produced per input.

      +

      Default: 1

      +
  • +
  • +
    type: "nearest_neighbors"
    +

    Type of the Analyzer.

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/analyzer.CreateNgramAnalyzerOptions.html b/8.8.0/types/analyzer.CreateNgramAnalyzerOptions.html new file mode 100644 index 000000000..8cf713d45 --- /dev/null +++ b/8.8.0/types/analyzer.CreateNgramAnalyzerOptions.html @@ -0,0 +1,130 @@ +CreateNgramAnalyzerOptions | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias CreateNgramAnalyzerOptions

+
CreateNgramAnalyzerOptions: {
    features?: AnalyzerFeature[];
    properties: {
        max: number;
        min: number;
        preserveOriginal: boolean;
    };
    type: "ngram";
}
+

Options for creating an Ngram Analyzer.

+
+
+

Type declaration

+
    +
  • +
    Optional features?: AnalyzerFeature[]
    +

    Features to enable for this Analyzer.

    +
  • +
  • +
    properties: {
        max: number;
        min: number;
        preserveOriginal: boolean;
    }
    +

    Additional properties for the Analyzer.

    +
    +
      +
    • +
      max: number
      +

      Maximum n-gram length.

      +
    • +
    • +
      min: number
      +

      Minimum n-gram length.

      +
    • +
    • +
      preserveOriginal: boolean
      +

      Output the original value as well.

      +
  • +
  • +
    type: "ngram"
    +

    Type of the Analyzer.

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/analyzer.CreateNormAnalyzerOptions.html b/8.8.0/types/analyzer.CreateNormAnalyzerOptions.html new file mode 100644 index 000000000..b37e9a285 --- /dev/null +++ b/8.8.0/types/analyzer.CreateNormAnalyzerOptions.html @@ -0,0 +1,133 @@ +CreateNormAnalyzerOptions | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias CreateNormAnalyzerOptions

+
CreateNormAnalyzerOptions: {
    features?: AnalyzerFeature[];
    properties: {
        accent?: boolean;
        case?: "lower" | "none" | "upper";
        locale: string;
    };
    type: "norm";
}
+

Options for creating a Norm Analyzer.

+
+
+

Type declaration

+
    +
  • +
    Optional features?: AnalyzerFeature[]
    +

    Features to enable for this Analyzer.

    +
  • +
  • +
    properties: {
        accent?: boolean;
        case?: "lower" | "none" | "upper";
        locale: string;
    }
    +

    Additional properties for the Analyzer.

    +
    +
      +
    • +
      Optional accent?: boolean
      +

      Preserve accents in returned words.

      +

      Default: false

      +
    • +
    • +
      Optional case?: "lower" | "none" | "upper"
      +

      Case conversion.

      +

      Default: "lower"

      +
    • +
    • +
      locale: string
      +

      Text locale.

      +

      Format: language[_COUNTRY][.encoding][@variant]

      +
  • +
  • +
    type: "norm"
    +

    Type of the Analyzer.

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/analyzer.CreatePipelineAnalyzerOptions.html b/8.8.0/types/analyzer.CreatePipelineAnalyzerOptions.html new file mode 100644 index 000000000..b7ba21aa4 --- /dev/null +++ b/8.8.0/types/analyzer.CreatePipelineAnalyzerOptions.html @@ -0,0 +1,122 @@ +CreatePipelineAnalyzerOptions | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias CreatePipelineAnalyzerOptions

+
CreatePipelineAnalyzerOptions: {
    features?: AnalyzerFeature[];
    properties: {
        pipeline: Omit<CreateAnalyzerOptions, "features">[];
    };
    type: "pipeline";
}
+

Options for creating a Pipeline Analyzer

+
+
+

Type declaration

+
    +
  • +
    Optional features?: AnalyzerFeature[]
    +

    Features to enable for this Analyzer.

    +
  • +
  • +
    properties: {
        pipeline: Omit<CreateAnalyzerOptions, "features">[];
    }
    +

    Additional properties for the Analyzer.

    +
    +
      +
    • +
      pipeline: Omit<CreateAnalyzerOptions, "features">[]
      +

      Definitions for Analyzers to chain in this Pipeline Analyzer.

      +
  • +
  • +
    type: "pipeline"
    +

    Type of the Analyzer.

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/analyzer.CreateSegmentationAnalyzerOptions.html b/8.8.0/types/analyzer.CreateSegmentationAnalyzerOptions.html new file mode 100644 index 000000000..e2215b2bf --- /dev/null +++ b/8.8.0/types/analyzer.CreateSegmentationAnalyzerOptions.html @@ -0,0 +1,128 @@ +CreateSegmentationAnalyzerOptions | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias CreateSegmentationAnalyzerOptions

+
CreateSegmentationAnalyzerOptions: {
    features?: AnalyzerFeature[];
    properties: {
        break?: "all" | "alpha" | "graphic";
        case?: "lower" | "upper" | "none";
    };
    type: "segmentation";
}
+

Options for creating a Segmentation Analyzer

+
+
+

Type declaration

+
    +
  • +
    Optional features?: AnalyzerFeature[]
    +

    Features to enable for this Analyzer.

    +
  • +
  • +
    properties: {
        break?: "all" | "alpha" | "graphic";
        case?: "lower" | "upper" | "none";
    }
    +

    Additional properties for the Analyzer.

    +
    +
      +
    • +
      Optional break?: "all" | "alpha" | "graphic"
      +

      Which tokens should be returned.

      +

      Default: "alpha"

      +
    • +
    • +
      Optional case?: "lower" | "upper" | "none"
      +

      What case all returned tokens should be converted to if applicable.

      +

      Default: "none"

      +
  • +
  • +
    type: "segmentation"
    +

    Type of the Analyzer.

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/analyzer.CreateStemAnalyzerOptions.html b/8.8.0/types/analyzer.CreateStemAnalyzerOptions.html new file mode 100644 index 000000000..8ae385fe4 --- /dev/null +++ b/8.8.0/types/analyzer.CreateStemAnalyzerOptions.html @@ -0,0 +1,122 @@ +CreateStemAnalyzerOptions | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias CreateStemAnalyzerOptions

+
CreateStemAnalyzerOptions: {
    features?: AnalyzerFeature[];
    properties: {
        locale: string;
    };
    type: "stem";
}
+

Options for creating a Stem Analyzer.

+
+
+

Type declaration

+
    +
  • +
    Optional features?: AnalyzerFeature[]
    +

    Features to enable for this Analyzer.

    +
  • +
  • +
    properties: {
        locale: string;
    }
    +

    Additional properties for the Analyzer.

    +

    The value defines the text locale.

    +

    Format: language[_COUNTRY][.encoding][@variant]

    +
    +
      +
    • +
      locale: string
  • +
  • +
    type: "stem"
    +

    Type of the Analyzer.

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/analyzer.CreateStopwordsAnalyzerOptions.html b/8.8.0/types/analyzer.CreateStopwordsAnalyzerOptions.html new file mode 100644 index 000000000..af8982015 --- /dev/null +++ b/8.8.0/types/analyzer.CreateStopwordsAnalyzerOptions.html @@ -0,0 +1,127 @@ +CreateStopwordsAnalyzerOptions | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias CreateStopwordsAnalyzerOptions

+
CreateStopwordsAnalyzerOptions: {
    features?: AnalyzerFeature[];
    properties: {
        hex?: boolean;
        stopwords: string[];
    };
    type: "stopwords";
}
+

Options for creating a Stopwords Analyzer

+
+
+

Type declaration

+
    +
  • +
    Optional features?: AnalyzerFeature[]
    +

    Features to enable for this Analyzer.

    +
  • +
  • +
    properties: {
        hex?: boolean;
        stopwords: string[];
    }
    +

    Additional properties for the Analyzer.

    +
    +
      +
    • +
      Optional hex?: boolean
      +

      Whether stopword values should be interpreted as hex-encoded strings.

      +

      Default: false

      +
    • +
    • +
      stopwords: string[]
      +

      Array of strings that describe the tokens to be discarded.

      +
  • +
  • +
    type: "stopwords"
    +

    Type of the Analyzer.

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/analyzer.CreateTextAnalyzerOptions.html b/8.8.0/types/analyzer.CreateTextAnalyzerOptions.html new file mode 100644 index 000000000..b21d4cff4 --- /dev/null +++ b/8.8.0/types/analyzer.CreateTextAnalyzerOptions.html @@ -0,0 +1,161 @@ +CreateTextAnalyzerOptions | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias CreateTextAnalyzerOptions

+
CreateTextAnalyzerOptions: {
    features?: AnalyzerFeature[];
    properties: {
        accent?: boolean;
        case?: "lower" | "none" | "upper";
        edgeNgram?: {
            max?: number;
            min?: number;
            preserveOriginal?: boolean;
        };
        locale: string;
        stemming?: boolean;
        stopwords?: string[];
        stopwordsPath?: string;
    };
    type: "text";
}
+

Options for creating a Text Analyzer.

+
+
+

Type declaration

+
    +
  • +
    Optional features?: AnalyzerFeature[]
    +

    Features to enable for this Analyzer.

    +
  • +
  • +
    properties: {
        accent?: boolean;
        case?: "lower" | "none" | "upper";
        edgeNgram?: {
            max?: number;
            min?: number;
            preserveOriginal?: boolean;
        };
        locale: string;
        stemming?: boolean;
        stopwords?: string[];
        stopwordsPath?: string;
    }
    +

    Additional properties for the Analyzer.

    +
    +
      +
    • +
      Optional accent?: boolean
      +

      Preserve accents in returned words.

      +

      Default: false

      +
    • +
    • +
      Optional case?: "lower" | "none" | "upper"
      +

      Case conversion.

      +

      Default: "lower"

      +
    • +
    • +
      Optional edgeNgram?: {
          max?: number;
          min?: number;
          preserveOriginal?: boolean;
      }
      +

      If present, then edge n-grams are generated for each token (word).

      +
      +
        +
      • +
        Optional max?: number
      • +
      • +
        Optional min?: number
      • +
      • +
        Optional preserveOriginal?: boolean
    • +
    • +
      locale: string
      +

      Text locale.

      +

      Format: language[_COUNTRY][.encoding][@variant]

      +
    • +
    • +
      Optional stemming?: boolean
      +

      Apply stemming on returned words.

      +

      Default: true

      +
    • +
    • +
      Optional stopwords?: string[]
      +

      Words to omit from result.

      +

      Defaults to the words loaded from the file at stopwordsPath.

      +
    • +
    • +
      Optional stopwordsPath?: string
      +

      Path with a language sub-directory containing files with words to omit.

      +

      Defaults to the path specified in the server-side environment variable +IRESEARCH_TEXT_STOPWORD_PATH or the current working directory of the +ArangoDB process.

      +
  • +
  • +
    type: "text"
    +

    Type of the Analyzer.

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/analyzer.CreateWildcardAnalyzerOptions.html b/8.8.0/types/analyzer.CreateWildcardAnalyzerOptions.html new file mode 100644 index 000000000..b285a3a6e --- /dev/null +++ b/8.8.0/types/analyzer.CreateWildcardAnalyzerOptions.html @@ -0,0 +1,126 @@ +CreateWildcardAnalyzerOptions | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias CreateWildcardAnalyzerOptions

+
CreateWildcardAnalyzerOptions: {
    features?: AnalyzerFeature[];
    properties: {
        analyzer?: Omit<CreateAnalyzerOptions, "features">;
        ngramSize: string;
    };
    type: "wildcard";
}
+

Options for creating a Wildcard Analyzer.

+
+
+

Type declaration

+
    +
  • +
    Optional features?: AnalyzerFeature[]
    +

    Features to enable for this Analyzer.

    +
  • +
  • +
    properties: {
        analyzer?: Omit<CreateAnalyzerOptions, "features">;
        ngramSize: string;
    }
    +

    Additional properties for the Analyzer.

    +
    +
      +
    • +
      Optional analyzer?: Omit<CreateAnalyzerOptions, "features">
      +

      An Analyzer definition-like object with type and properties attributes.

      +
    • +
    • +
      ngramSize: string
      +

      N-gram length. Must be a positive integer greater than or equal to 2.

      +
  • +
  • +
    type: "wildcard"
    +

    Type of the Analyzer.

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/analyzer.DelimiterAnalyzerDescription.html b/8.8.0/types/analyzer.DelimiterAnalyzerDescription.html new file mode 100644 index 000000000..abff265c4 --- /dev/null +++ b/8.8.0/types/analyzer.DelimiterAnalyzerDescription.html @@ -0,0 +1,102 @@ +DelimiterAnalyzerDescription | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias DelimiterAnalyzerDescription

+
DelimiterAnalyzerDescription: GenericAnalyzerDescription & {
    properties: {
        delimiter: string;
    };
    type: "delimiter";
}
+

An object describing a Delimiter Analyzer.

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/analyzer.GenericAnalyzerDescription.html b/8.8.0/types/analyzer.GenericAnalyzerDescription.html new file mode 100644 index 000000000..1abbde505 --- /dev/null +++ b/8.8.0/types/analyzer.GenericAnalyzerDescription.html @@ -0,0 +1,113 @@ +GenericAnalyzerDescription | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias GenericAnalyzerDescription

+
GenericAnalyzerDescription: {
    features: AnalyzerFeature[];
    name: string;
}
+

Shared attributes of all Analyzer descriptions.

+
+
+

Type declaration

+
    +
  • +
    features: AnalyzerFeature[]
    +

    Features enabled for this Analyzer.

    +
  • +
  • +
    name: string
    +

    A unique name for this Analyzer.

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/analyzer.GeoJsonAnalyzerDescription.html b/8.8.0/types/analyzer.GeoJsonAnalyzerDescription.html new file mode 100644 index 000000000..4a0e4b597 --- /dev/null +++ b/8.8.0/types/analyzer.GeoJsonAnalyzerDescription.html @@ -0,0 +1,102 @@ +GeoJsonAnalyzerDescription | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias GeoJsonAnalyzerDescription

+
GeoJsonAnalyzerDescription: GenericAnalyzerDescription & {
    properties: {
        description: {
            maxCells: number;
            maxLevel: number;
            minLevel: number;
        };
        type: "shape" | "centroid" | "point";
    };
    type: "geojson";
}
+

An object describing a GeoJSON Analyzer

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/analyzer.GeoPointAnalyzerDescription.html b/8.8.0/types/analyzer.GeoPointAnalyzerDescription.html new file mode 100644 index 000000000..cbd492907 --- /dev/null +++ b/8.8.0/types/analyzer.GeoPointAnalyzerDescription.html @@ -0,0 +1,102 @@ +GeoPointAnalyzerDescription | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias GeoPointAnalyzerDescription

+
GeoPointAnalyzerDescription: GenericAnalyzerDescription & {
    properties: {
        description: {
            maxLevel: number;
            minCells: number;
            minLevel: number;
        };
        latitude: string[];
        longitude: string[];
    };
    type: "geopoint";
}
+

An object describing a GeoPoint Analyzer

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/analyzer.GeoS2AnalyzerDescription.html b/8.8.0/types/analyzer.GeoS2AnalyzerDescription.html new file mode 100644 index 000000000..d013b3b60 --- /dev/null +++ b/8.8.0/types/analyzer.GeoS2AnalyzerDescription.html @@ -0,0 +1,102 @@ +GeoS2AnalyzerDescription | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias GeoS2AnalyzerDescription

+
GeoS2AnalyzerDescription: GenericAnalyzerDescription & {
    properties: {
        description: {
            maxCells: number;
            maxLevel: number;
            minLevel: number;
        };
        format: "latLngDouble" | "latLngInt" | "s2Point";
        type: "shape" | "centroid" | "point";
    };
    type: "geo_s2";
}
+

(Enterprise Edition only.) An object describing a GeoS2 Analyzer

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/analyzer.IdentityAnalyzerDescription.html b/8.8.0/types/analyzer.IdentityAnalyzerDescription.html new file mode 100644 index 000000000..1512369ee --- /dev/null +++ b/8.8.0/types/analyzer.IdentityAnalyzerDescription.html @@ -0,0 +1,102 @@ +IdentityAnalyzerDescription | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias IdentityAnalyzerDescription

+
IdentityAnalyzerDescription: GenericAnalyzerDescription & {
    properties: Record<string, never>;
    type: "identity";
}
+

An object describing an Identity Analyzer.

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/analyzer.MinHashAnalyzerDescription.html b/8.8.0/types/analyzer.MinHashAnalyzerDescription.html new file mode 100644 index 000000000..f0e51b0a9 --- /dev/null +++ b/8.8.0/types/analyzer.MinHashAnalyzerDescription.html @@ -0,0 +1,102 @@ +MinHashAnalyzerDescription | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias MinHashAnalyzerDescription

+
MinHashAnalyzerDescription: GenericAnalyzerDescription & {
    properties: {
        analyzer: Omit<AnalyzerDescription, "name" | "features">;
        numHashes: number;
    };
    type: "minhash";
}
+

(Enterprise Edition only.) An object describing a MinHash Analyzer

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/analyzer.MultiDelimiterAnalyzerDescription.html b/8.8.0/types/analyzer.MultiDelimiterAnalyzerDescription.html new file mode 100644 index 000000000..42f6418f7 --- /dev/null +++ b/8.8.0/types/analyzer.MultiDelimiterAnalyzerDescription.html @@ -0,0 +1,102 @@ +MultiDelimiterAnalyzerDescription | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias MultiDelimiterAnalyzerDescription

+
MultiDelimiterAnalyzerDescription: GenericAnalyzerDescription & {
    properties: {
        delimiters: string[];
    };
    type: "multi_delimiter";
}
+

An object describing a Multi Delimiter Analyzer.

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/analyzer.NearestNeighborsAnalyzerDescription.html b/8.8.0/types/analyzer.NearestNeighborsAnalyzerDescription.html new file mode 100644 index 000000000..34ee41ac9 --- /dev/null +++ b/8.8.0/types/analyzer.NearestNeighborsAnalyzerDescription.html @@ -0,0 +1,102 @@ +NearestNeighborsAnalyzerDescription | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias NearestNeighborsAnalyzerDescription

+
NearestNeighborsAnalyzerDescription: GenericAnalyzerDescription & {
    properties: {
        model_location: string;
        top_k: number;
    };
    type: "nearest_neighbors";
}
+

(Enterprise Edition only.) An object describing a NearestNeighbors Analyzer

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/analyzer.NgramAnalyzerDescription.html b/8.8.0/types/analyzer.NgramAnalyzerDescription.html new file mode 100644 index 000000000..bbe7bee1a --- /dev/null +++ b/8.8.0/types/analyzer.NgramAnalyzerDescription.html @@ -0,0 +1,102 @@ +NgramAnalyzerDescription | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias NgramAnalyzerDescription

+
NgramAnalyzerDescription: GenericAnalyzerDescription & {
    properties: {
        max: number;
        min: number;
        preserveOriginal: boolean;
    };
    type: "ngram";
}
+

An object describing an Ngram Analyzer.

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/analyzer.NormAnalyzerDescription.html b/8.8.0/types/analyzer.NormAnalyzerDescription.html new file mode 100644 index 000000000..8f717ec73 --- /dev/null +++ b/8.8.0/types/analyzer.NormAnalyzerDescription.html @@ -0,0 +1,102 @@ +NormAnalyzerDescription | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias NormAnalyzerDescription

+
NormAnalyzerDescription: GenericAnalyzerDescription & {
    properties: {
        accent: boolean;
        case: "lower" | "none" | "upper";
        locale: string;
    };
    type: "norm";
}
+

An object describing a Norm Analyzer.

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/analyzer.PipelineAnalyzerDescription.html b/8.8.0/types/analyzer.PipelineAnalyzerDescription.html new file mode 100644 index 000000000..9a486217f --- /dev/null +++ b/8.8.0/types/analyzer.PipelineAnalyzerDescription.html @@ -0,0 +1,102 @@ +PipelineAnalyzerDescription | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias PipelineAnalyzerDescription

+
PipelineAnalyzerDescription: GenericAnalyzerDescription & {
    properties: {
        pipeline: Omit<AnalyzerDescription, "name" | "features">[];
    };
    type: "pipeline";
}
+

An object describing a Pipeline Analyzer

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/analyzer.SegmentationAnalyzerDescription.html b/8.8.0/types/analyzer.SegmentationAnalyzerDescription.html new file mode 100644 index 000000000..b0cc45011 --- /dev/null +++ b/8.8.0/types/analyzer.SegmentationAnalyzerDescription.html @@ -0,0 +1,102 @@ +SegmentationAnalyzerDescription | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias SegmentationAnalyzerDescription

+
SegmentationAnalyzerDescription: GenericAnalyzerDescription & {
    properties: {
        break: "all" | "alpha" | "graphic";
        case: "lower" | "upper" | "none";
    };
    type: "segmentation";
}
+

An object describing a Segmentation Analyzer

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/analyzer.StemAnalyzerDescription.html b/8.8.0/types/analyzer.StemAnalyzerDescription.html new file mode 100644 index 000000000..f47c82706 --- /dev/null +++ b/8.8.0/types/analyzer.StemAnalyzerDescription.html @@ -0,0 +1,102 @@ +StemAnalyzerDescription | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias StemAnalyzerDescription

+
StemAnalyzerDescription: GenericAnalyzerDescription & {
    properties: {
        locale: string;
    };
    type: "stem";
}
+

An object describing a Stem Analyzer.

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/analyzer.StopwordsAnalyzerDescription.html b/8.8.0/types/analyzer.StopwordsAnalyzerDescription.html new file mode 100644 index 000000000..564734bf8 --- /dev/null +++ b/8.8.0/types/analyzer.StopwordsAnalyzerDescription.html @@ -0,0 +1,102 @@ +StopwordsAnalyzerDescription | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias StopwordsAnalyzerDescription

+
StopwordsAnalyzerDescription: GenericAnalyzerDescription & {
    properties: {
        hex: boolean;
        stopwords: string[];
    };
    type: "stopwords";
}
+

An object describing a Stopwords Analyzer

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/analyzer.TextAnalyzerDescription.html b/8.8.0/types/analyzer.TextAnalyzerDescription.html new file mode 100644 index 000000000..941e1314c --- /dev/null +++ b/8.8.0/types/analyzer.TextAnalyzerDescription.html @@ -0,0 +1,102 @@ +TextAnalyzerDescription | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias TextAnalyzerDescription

+
TextAnalyzerDescription: GenericAnalyzerDescription & {
    properties: {
        accent: boolean;
        case: "lower" | "none" | "upper";
        edgeNgram: {
            max: number;
            min: number;
            preserveOriginal: boolean;
        };
        locale: string;
        stemming: boolean;
        stopwords: string[];
        stopwordsPath: string;
    };
    type: "text";
}
+

An object describing a Text Analyzer.

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/analyzer.WildcardAnalyzerDescription.html b/8.8.0/types/analyzer.WildcardAnalyzerDescription.html new file mode 100644 index 000000000..f14ad6c9b --- /dev/null +++ b/8.8.0/types/analyzer.WildcardAnalyzerDescription.html @@ -0,0 +1,102 @@ +WildcardAnalyzerDescription | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias WildcardAnalyzerDescription

+
WildcardAnalyzerDescription: GenericAnalyzerDescription & {
    properties: {
        analyzer?: Omit<AnalyzerDescription, "name" | "features">;
        ngramSize: number;
    };
    type: "wildcard";
}
+

An object describing a Wildcard Analyzer

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/aql.AqlValue.html b/8.8.0/types/aql.AqlValue.html new file mode 100644 index 000000000..4decfe5a1 --- /dev/null +++ b/8.8.0/types/aql.AqlValue.html @@ -0,0 +1,67 @@ +AqlValue | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias AqlValue

+
AqlValue: ArangoCollection | View | Graph | GeneratedAqlQuery | AqlLiteral | string | number | boolean | null | undefined | Record<string, any> | any[]
+

A value that can be used in an AQL template string or passed to an AQL +helper function.

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/collection.CollectionBatchReadOptions.html b/8.8.0/types/collection.CollectionBatchReadOptions.html new file mode 100644 index 000000000..d46180583 --- /dev/null +++ b/8.8.0/types/collection.CollectionBatchReadOptions.html @@ -0,0 +1,116 @@ +CollectionBatchReadOptions | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias CollectionBatchReadOptions

+
CollectionBatchReadOptions: {
    allowDirtyRead?: boolean;
}
+

Options for retrieving multiple documents from a collection.

+
+
+

Type declaration

+
    +
  • +
    Optional allowDirtyRead?: boolean
    +

    If set to true, the request will explicitly permit ArangoDB to return a +potentially dirty or stale result and arangojs will load balance the +request without distinguishing between leaders and followers.

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/collection.CollectionChecksumOptions.html b/8.8.0/types/collection.CollectionChecksumOptions.html new file mode 100644 index 000000000..3cd9000b2 --- /dev/null +++ b/8.8.0/types/collection.CollectionChecksumOptions.html @@ -0,0 +1,122 @@ +CollectionChecksumOptions | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias CollectionChecksumOptions

+
CollectionChecksumOptions: {
    withData?: boolean;
    withRevisions?: boolean;
}
+

Options for retrieving a collection checksum.

+
+
+

Type declaration

+
    +
  • +
    Optional withData?: boolean
    +

    If set to true, document data will be included in the calculation +of the checksum.

    +

    Default: false

    +
  • +
  • +
    Optional withRevisions?: boolean
    +

    If set to true, revision IDs will be included in the calculation +of the checksum.

    +

    Default: false

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/collection.CollectionDropOptions.html b/8.8.0/types/collection.CollectionDropOptions.html new file mode 100644 index 000000000..469303f9b --- /dev/null +++ b/8.8.0/types/collection.CollectionDropOptions.html @@ -0,0 +1,117 @@ +CollectionDropOptions | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias CollectionDropOptions

+
CollectionDropOptions: {
    isSystem?: boolean;
}
+

Options for dropping collections.

+
+
+

Type declaration

+
    +
  • +
    Optional isSystem?: boolean
    +

    Whether the collection is a system collection. If the collection is a +system collection, this option must be set to true or ArangoDB will +refuse to drop the collection.

    +

    Default: false

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/collection.CollectionEdgesOptions.html b/8.8.0/types/collection.CollectionEdgesOptions.html new file mode 100644 index 000000000..00de02cfc --- /dev/null +++ b/8.8.0/types/collection.CollectionEdgesOptions.html @@ -0,0 +1,116 @@ +CollectionEdgesOptions | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias CollectionEdgesOptions

+
CollectionEdgesOptions: {
    allowDirtyRead?: boolean;
}
+

Options for retrieving a document's edges from a collection.

+
+
+

Type declaration

+
    +
  • +
    Optional allowDirtyRead?: boolean
    +

    If set to true, the request will explicitly permit ArangoDB to return a +potentially dirty or stale result and arangojs will load balance the +request without distinguishing between leaders and followers.

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/collection.CollectionEdgesResult.html b/8.8.0/types/collection.CollectionEdgesResult.html new file mode 100644 index 000000000..4d74af0d4 --- /dev/null +++ b/8.8.0/types/collection.CollectionEdgesResult.html @@ -0,0 +1,124 @@ +CollectionEdgesResult | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias CollectionEdgesResult<T>

+
CollectionEdgesResult<T>: {
    edges: Edge<T>[];
    stats: {
        filtered: number;
        scannedIndex: number;
    };
}
+

Result of retrieving edges in a collection.

+
+
+

Type Parameters

+
    +
  • +

    T extends Record<string, any> = any

+
+

Type declaration

+
    +
  • +
    edges: Edge<T>[]
  • +
  • +
    stats: {
        filtered: number;
        scannedIndex: number;
    }
    +
      +
    • +
      filtered: number
    • +
    • +
      scannedIndex: number
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/collection.CollectionImportOptions.html b/8.8.0/types/collection.CollectionImportOptions.html new file mode 100644 index 000000000..035a6b7c7 --- /dev/null +++ b/8.8.0/types/collection.CollectionImportOptions.html @@ -0,0 +1,148 @@ +CollectionImportOptions | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias CollectionImportOptions

+
CollectionImportOptions: {
    complete?: boolean;
    details?: boolean;
    fromPrefix?: string;
    onDuplicate?: "error" | "update" | "replace" | "ignore";
    overwrite?: boolean;
    toPrefix?: string;
    waitForSync?: boolean;
}
+

Options for bulk importing documents into a collection.

+
+
+

Type declaration

+
    +
  • +
    Optional complete?: boolean
    +

    If set to true, the import will abort if any error occurs.

    +
  • +
  • +
    Optional details?: boolean
    +

    Whether the response should contain additional details about documents +that could not be imported.

    +
  • +
  • +
    Optional fromPrefix?: string
    +

    (Edge collections only.) Prefix to prepend to _from attribute values.

    +
  • +
  • +
    Optional onDuplicate?: "error" | "update" | "replace" | "ignore"
    +

    Controls behavior when a unique constraint is violated on the document key.

    +
      +
    • "error": the document will not be imported.
    • +
    • "update: the document will be merged into the existing document.
    • +
    • "replace": the document will replace the existing document.
    • +
    • "ignore": the document will not be imported and the unique constraint +error will be ignored.
    • +
    +

    Default: "error"

    +
  • +
  • +
    Optional overwrite?: boolean
    +

    If set to true, the collection is truncated before the data is imported.

    +

    Default: false

    +
  • +
  • +
    Optional toPrefix?: string
    +

    (Edge collections only.) Prefix to prepend to _to attribute values.

    +
  • +
  • +
    Optional waitForSync?: boolean
    +

    Whether to wait for the documents to have been synced to disk.

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/collection.CollectionImportResult.html b/8.8.0/types/collection.CollectionImportResult.html new file mode 100644 index 000000000..302498999 --- /dev/null +++ b/8.8.0/types/collection.CollectionImportResult.html @@ -0,0 +1,138 @@ +CollectionImportResult | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias CollectionImportResult

+
CollectionImportResult: {
    created: number;
    details?: string[];
    empty: number;
    error: false;
    errors: number;
    ignored: number;
    updated: number;
}
+

Result of a collection bulk import.

+
+
+

Type declaration

+
    +
  • +
    created: number
    +

    Number of new documents imported.

    +
  • +
  • +
    Optional details?: string[]
    +

    Additional details about any errors encountered during the import.

    +
  • +
  • +
    empty: number
    +

    Number of empty documents.

    +
  • +
  • +
    error: false
    +

    Whether the import failed.

    +
  • +
  • +
    errors: number
    +

    Number of documents that failed with an error.

    +
  • +
  • +
    ignored: number
    +

    Number of documents that failed with an error that is ignored.

    +
  • +
  • +
    updated: number
    +

    Number of documents updated.

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/collection.CollectionInsertOptions.html b/8.8.0/types/collection.CollectionInsertOptions.html new file mode 100644 index 000000000..1600cb8c0 --- /dev/null +++ b/8.8.0/types/collection.CollectionInsertOptions.html @@ -0,0 +1,155 @@ +CollectionInsertOptions | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias CollectionInsertOptions

+
CollectionInsertOptions: {
    mergeObjects?: boolean;
    overwriteMode?: "ignore" | "update" | "replace" | "conflict";
    refillIndexCaches?: boolean;
    returnNew?: boolean;
    returnOld?: boolean;
    silent?: boolean;
    waitForSync?: boolean;
}
+

Options for inserting a new document into a collection.

+
+
+

Type declaration

+
    +
  • +
    Optional mergeObjects?: boolean
    +

    If set to false, object properties that already exist in the old +document will be overwritten rather than merged when an existing document +with the same _key or _id is updated. This does not affect arrays.

    +

    Default: true

    +
  • +
  • +
    Optional overwriteMode?: "ignore" | "update" | "replace" | "conflict"
    +

    Defines what should happen if a document with the same _key or _id +already exists, instead of throwing an exception.

    +

    Default: `"conflict"

    +
  • +
  • +
    Optional refillIndexCaches?: boolean
    +

    If set to true, new entries will be added to in-memory index caches if +document insertions affect the edge index or cache-enabled persistent +indexes.

    +

    Default: false

    +
  • +
  • +
    Optional returnNew?: boolean
    +

    If set to true, the complete new document will be returned as the new +property on the result object. Has no effect if silent is set to true.

    +

    Default: false

    +
  • +
  • +
    Optional returnOld?: boolean
    +

    If set to true, the complete old document will be returned as the old +property on the result object. Has no effect if silent is set to true. +This option is only available when overwriteMode is set to "update" or +"replace".

    +

    Default: false

    +
  • +
  • +
    Optional silent?: boolean
    +

    If set to true, no data will be returned by the server. This option can +be used to reduce network traffic.

    +

    Default: false

    +
  • +
  • +
    Optional waitForSync?: boolean
    +

    If set to true, data will be synchronized to disk before returning.

    +

    Default: false

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/collection.CollectionKeyOptions.html b/8.8.0/types/collection.CollectionKeyOptions.html new file mode 100644 index 000000000..3750863ae --- /dev/null +++ b/8.8.0/types/collection.CollectionKeyOptions.html @@ -0,0 +1,128 @@ +CollectionKeyOptions | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias CollectionKeyOptions

+
CollectionKeyOptions: {
    allowUserKeys?: boolean;
    increment?: number;
    offset?: number;
    type?: KeyGenerator;
}
+

An object defining the collection's key generation.

+
+
+

Type declaration

+
    +
  • +
    Optional allowUserKeys?: boolean
    +

    Unless set to false, documents can be created with a user-specified +_key attribute.

    +

    Default: true

    +
  • +
  • +
    Optional increment?: number
    +

    (Autoincrement only.) How many steps to increment the key each time.

    +
  • +
  • +
    Optional offset?: number
    +

    (Autoincrement only.) Initial offset for the key.

    +
  • +
  • +
    Optional type?: KeyGenerator
    +

    Type of key generator to use.

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/collection.CollectionKeyProperties.html b/8.8.0/types/collection.CollectionKeyProperties.html new file mode 100644 index 000000000..d5271780d --- /dev/null +++ b/8.8.0/types/collection.CollectionKeyProperties.html @@ -0,0 +1,130 @@ +CollectionKeyProperties | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias CollectionKeyProperties

+
CollectionKeyProperties: {
    allowUserKeys: boolean;
    increment?: number;
    lastValue: number;
    offset?: number;
    type: KeyGenerator;
}
+

An object defining the collection's key generation.

+
+
+

Type declaration

+
    +
  • +
    allowUserKeys: boolean
    +

    Whether documents can be created with a user-specified _key attribute.

    +
  • +
  • +
    Optional increment?: number
    +

    (Autoincrement only.) How many steps to increment the key each time.

    +
  • +
  • +
    lastValue: number
    +

    Most recent key that has been generated.

    +
  • +
  • +
    Optional offset?: number
    +

    (Autoincrement only.) Initial offset for the key.

    +
  • +
  • +
    type: KeyGenerator
    +

    Type of key generator to use.

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/collection.CollectionMetadata.html b/8.8.0/types/collection.CollectionMetadata.html new file mode 100644 index 000000000..c5e4abf21 --- /dev/null +++ b/8.8.0/types/collection.CollectionMetadata.html @@ -0,0 +1,126 @@ +CollectionMetadata | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias CollectionMetadata

+
CollectionMetadata: {
    globallyUniqueId: string;
    name: string;
    status: CollectionStatus;
    type: CollectionType;
}
+

General information about a collection.

+
+
+

Type declaration

+
    +
  • +
    globallyUniqueId: string
    +

    A globally unique identifier for this collection.

    +
  • +
  • +
    name: string
    +

    Collection name.

    +
  • +
  • +
    status: CollectionStatus
    +

    An integer indicating the collection loading status.

    +
  • +
  • +
    type: CollectionType
    +

    An integer indicating the collection type.

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/collection.CollectionProperties.html b/8.8.0/types/collection.CollectionProperties.html new file mode 100644 index 000000000..97cb58b98 --- /dev/null +++ b/8.8.0/types/collection.CollectionProperties.html @@ -0,0 +1,184 @@ +CollectionProperties | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias CollectionProperties

+
CollectionProperties: {
    cacheEnabled: boolean;
    computedValues: ComputedValueProperties[];
    distributeShardsLike?: string;
    isDisjoint?: string;
    isSmart?: boolean;
    keyOptions: CollectionKeyProperties;
    numberOfShards?: number;
    replicationFactor?: number | "satellite";
    schema: SchemaProperties | null;
    shardKeys?: string[];
    shardingStrategy?: ShardingStrategy;
    smartGraphAttribute?: string;
    smartJoinAttribute?: string;
    statusString: string;
    syncByRevision: boolean;
    waitForSync: boolean;
    writeConcern: number;
}
+

An object defining the properties of a collection.

+
+
+

Type declaration

+
    +
  • +
    cacheEnabled: boolean
    +

    Whether the in-memory hash cache is enabled for this collection.

    +
  • +
  • +
    computedValues: ComputedValueProperties[]
    +

    Computed values applied to documents in this collection.

    +
  • +
  • +
    Optional distributeShardsLike?: string
    +

    (Enterprise Edition cluster only.) If set to a collection name, sharding +of the new collection will follow the rules for that collection. As long +as the new collection exists, the indicated collection can not be dropped.

    +
  • +
  • +
    Optional isDisjoint?: string
    +

    (Enterprise Edition only.) Whether the SmartGraph this collection belongs to is disjoint.

    +
  • +
  • +
    Optional isSmart?: boolean
    +

    (Enterprise Edition only.) Whether the collection is used in a SmartGraph or EnterpriseGraph.

    +
  • +
  • +
    keyOptions: CollectionKeyProperties
    +

    An object defining the collection's key generation.

    +
  • +
  • +
    Optional numberOfShards?: number
    +

    (Cluster only.) Number of shards of this collection.

    +
  • +
  • +
    Optional replicationFactor?: number | "satellite"
    +

    (Cluster only.) Replication factor of the collection.

    +
  • +
  • +
    schema: SchemaProperties | null
    +

    Properties for validating documents in the collection.

    +
  • +
  • +
    Optional shardKeys?: string[]
    +

    (Cluster only.) Keys of this collection that will be used for +sharding.

    +
  • +
  • +
    Optional shardingStrategy?: ShardingStrategy
    +

    (Cluster only.) Sharding strategy of the collection.

    +
  • +
  • +
    Optional smartGraphAttribute?: string
    +

    (Enterprise Edition cluster only.) Attribute used for sharding.

    +
  • +
  • +
    Optional smartJoinAttribute?: string
    +

    (Enterprise Edition cluster only.) Attribute containing the shard key +value of the referred-to smart join collection.

    +
  • +
  • +
    statusString: string
    +

    A human-readable representation of the collection loading status.

    +
  • +
  • +
    syncByRevision: boolean
    +

    Whether the newer revision-based replication protocol is enabled for +this collection.

    +
  • +
  • +
    waitForSync: boolean
    +

    Whether data should be synchronized to disk before returning from +a document create, update, replace or removal operation.

    +
  • +
  • +
    writeConcern: number
    +

    (Cluster only.) Write concern for this collection.

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/collection.CollectionPropertiesOptions.html b/8.8.0/types/collection.CollectionPropertiesOptions.html new file mode 100644 index 000000000..725c72e15 --- /dev/null +++ b/8.8.0/types/collection.CollectionPropertiesOptions.html @@ -0,0 +1,139 @@ +CollectionPropertiesOptions | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias CollectionPropertiesOptions

+
CollectionPropertiesOptions: {
    cacheEnabled?: boolean;
    computedValues?: ComputedValueOptions[];
    replicationFactor?: number | "satellite";
    schema?: SchemaOptions;
    waitForSync?: boolean;
    writeConcern?: number;
}
+

Options for setting a collection's properties.

+

See properties and properties.

+
+
+

Type declaration

+
    +
  • +
    Optional cacheEnabled?: boolean
    +

    Whether the in-memory hash cache is enabled for this collection.

    +

    Default: false

    +
  • +
  • +
    Optional computedValues?: ComputedValueOptions[]
    +

    Computed values to apply to documents in this collection.

    +
  • +
  • +
    Optional replicationFactor?: number | "satellite"
    +

    (Cluster only.) How many copies of each document should be kept in the +cluster.

    +

    Default: 1

    +
  • +
  • +
    Optional schema?: SchemaOptions
    +

    Options for validating documents in this collection.

    +
  • +
  • +
    Optional waitForSync?: boolean
    +

    Whether data should be synchronized to disk before returning from +a document create, update, replace or removal operation.

    +
  • +
  • +
    Optional writeConcern?: number
    +

    (Cluster only.) Write concern for this collection.

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/collection.CollectionReadOptions.html b/8.8.0/types/collection.CollectionReadOptions.html new file mode 100644 index 000000000..aacfb120f --- /dev/null +++ b/8.8.0/types/collection.CollectionReadOptions.html @@ -0,0 +1,132 @@ +CollectionReadOptions | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias CollectionReadOptions

+
CollectionReadOptions: {
    allowDirtyRead?: boolean;
    graceful?: boolean;
    ifMatch?: string;
    ifNoneMatch?: string;
}
+

Options for retrieving a document from a collection.

+
+
+

Type declaration

+
    +
  • +
    Optional allowDirtyRead?: boolean
    +

    If set to true, the request will explicitly permit ArangoDB to return a +potentially dirty or stale result and arangojs will load balance the +request without distinguishing between leaders and followers.

    +
  • +
  • +
    Optional graceful?: boolean
    +

    If set to true, null is returned instead of an exception being thrown +if the document does not exist.

    +
  • +
  • +
    Optional ifMatch?: string
    +

    If set to a document revision, the request will fail with an error if the +document exists but its _rev does not match the given revision.

    +
  • +
  • +
    Optional ifNoneMatch?: string
    +

    If set to a document revision, the request will fail with an error if the +document exists and its _rev matches the given revision. Note that an +HttpError with code 304 will be thrown instead of an ArangoError.

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/collection.CollectionRemoveOptions.html b/8.8.0/types/collection.CollectionRemoveOptions.html new file mode 100644 index 000000000..0cb88e0f3 --- /dev/null +++ b/8.8.0/types/collection.CollectionRemoveOptions.html @@ -0,0 +1,139 @@ +CollectionRemoveOptions | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias CollectionRemoveOptions

+
CollectionRemoveOptions: {
    ifMatch?: string;
    refillIndexCaches?: boolean;
    returnOld?: boolean;
    silent?: boolean;
    waitForSync?: boolean;
}
+

Options for removing a document from a collection.

+
+
+

Type declaration

+
    +
  • +
    Optional ifMatch?: string
    +

    If set to a document revision, the document will only be removed if its +_rev matches the given revision.

    +
  • +
  • +
    Optional refillIndexCaches?: boolean
    +

    If set to true, existing entries in in-memory index caches will be +deleted if document removals affect the edge index or cache-enabled +persistent indexes.

    +

    Default: false

    +
  • +
  • +
    Optional returnOld?: boolean
    +

    If set to true, the complete old document will be returned as the old +property on the result object. Has no effect if silent is set to true.

    +

    Default: false

    +
  • +
  • +
    Optional silent?: boolean
    +

    If set to true, no data will be returned by the server. This option can +be used to reduce network traffic.

    +

    Default: false

    +
  • +
  • +
    Optional waitForSync?: boolean
    +

    If set to true, changes will be synchronized to disk before returning.

    +

    Default: false

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/collection.CollectionReplaceOptions.html b/8.8.0/types/collection.CollectionReplaceOptions.html new file mode 100644 index 000000000..f3321e17a --- /dev/null +++ b/8.8.0/types/collection.CollectionReplaceOptions.html @@ -0,0 +1,151 @@ +CollectionReplaceOptions | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias CollectionReplaceOptions

+
CollectionReplaceOptions: {
    ifMatch?: string;
    ignoreRevs?: boolean;
    refillIndexCaches?: boolean;
    returnNew?: boolean;
    returnOld?: boolean;
    silent?: boolean;
    waitForSync?: boolean;
}
+

Options for replacing an existing document in a collection.

+
+
+

Type declaration

+
    +
  • +
    Optional ifMatch?: string
    +

    If set to a document revision, the document will only be replaced if its +_rev matches the given revision.

    +
  • +
  • +
    Optional ignoreRevs?: boolean
    +

    If set to false, the existing document will only be modified if its +_rev property matches the same property on the new data.

    +

    Default: true

    +
  • +
  • +
    Optional refillIndexCaches?: boolean
    +

    If set to true, existing entries in in-memory index caches will be +updated if document replacements affect the edge index or cache-enabled +persistent indexes.

    +

    Default: false

    +
  • +
  • +
    Optional returnNew?: boolean
    +

    If set to true, the complete new document will be returned as the new +property on the result object. Has no effect if silent is set to true.

    +

    Default: false

    +
  • +
  • +
    Optional returnOld?: boolean
    +

    If set to true, the complete old document will be returned as the old +property on the result object. Has no effect if silent is set to true.

    +

    Default: false

    +
  • +
  • +
    Optional silent?: boolean
    +

    If set to true, no data will be returned by the server. This option can +be used to reduce network traffic.

    +

    Default: false

    +
  • +
  • +
    Optional waitForSync?: boolean
    +

    If set to true, data will be synchronized to disk before returning.

    +

    Default: false

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/collection.CollectionUpdateOptions.html b/8.8.0/types/collection.CollectionUpdateOptions.html new file mode 100644 index 000000000..346f91a45 --- /dev/null +++ b/8.8.0/types/collection.CollectionUpdateOptions.html @@ -0,0 +1,164 @@ +CollectionUpdateOptions | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias CollectionUpdateOptions

+
CollectionUpdateOptions: {
    ifMatch?: string;
    ignoreRevs?: boolean;
    keepNull?: boolean;
    mergeObjects?: boolean;
    refillIndexCaches?: boolean;
    returnNew?: boolean;
    returnOld?: boolean;
    silent?: boolean;
    waitForSync?: boolean;
}
+

Options for updating a document in a collection.

+
+
+

Type declaration

+
    +
  • +
    Optional ifMatch?: string
    +

    If set to a document revision, the document will only be updated if its +_rev matches the given revision.

    +
  • +
  • +
    Optional ignoreRevs?: boolean
    +

    If set to false, the existing document will only be modified if its +_rev property matches the same property on the new data.

    +

    Default: true

    +
  • +
  • +
    Optional keepNull?: boolean
    +

    If set to false, properties with a value of null will be removed from +the new document.

    +

    Default: true

    +
  • +
  • +
    Optional mergeObjects?: boolean
    +

    If set to false, object properties that already exist in the old +document will be overwritten rather than merged. This does not affect +arrays.

    +

    Default: true

    +
  • +
  • +
    Optional refillIndexCaches?: boolean
    +

    If set to true, existing entries in in-memory index caches will be +updated if document updates affect the edge index or cache-enabled +persistent indexes.

    +

    Default: false

    +
  • +
  • +
    Optional returnNew?: boolean
    +

    If set to true, the complete new document will be returned as the new +property on the result object. Has no effect if silent is set to true.

    +

    Default: false

    +
  • +
  • +
    Optional returnOld?: boolean
    +

    If set to true, the complete old document will be returned as the old +property on the result object. Has no effect if silent is set to true.

    +

    Default: false

    +
  • +
  • +
    Optional silent?: boolean
    +

    If set to true, no data will be returned by the server. This option can +be used to reduce network traffic.

    +

    Default: false

    +
  • +
  • +
    Optional waitForSync?: boolean
    +

    If set to true, data will be synchronized to disk before returning.

    +

    Default: false

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/collection.ComputedValueOptions.html b/8.8.0/types/collection.ComputedValueOptions.html new file mode 100644 index 000000000..71a1dabd9 --- /dev/null +++ b/8.8.0/types/collection.ComputedValueOptions.html @@ -0,0 +1,143 @@ +ComputedValueOptions | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias ComputedValueOptions

+
ComputedValueOptions: {
    computeOn?: WriteOperation[];
    expression: string | AqlLiteral | AqlQuery;
    failOnWarning?: boolean;
    keepNull?: boolean;
    name: string;
    overwrite?: boolean;
}
+

Options for creating a computed value.

+
+
+

Type declaration

+
    +
  • +
    Optional computeOn?: WriteOperation[]
    +

    Which operations should result in the value being computed.

    +

    Default: ["insert", "update", "replace"]

    +
  • +
  • +
    expression: string | AqlLiteral | AqlQuery
    +

    AQL RETURN expression that computes the value.

    +

    Note that when passing an AQL query object, the bindVars will be ignored.

    +
  • +
  • +
    Optional failOnWarning?: boolean
    +

    Whether the write operation should fail if the expression produces a +warning.

    +

    Default: false

    +
  • +
  • +
    Optional keepNull?: boolean
    +

    If set to false, the field will be unset if the expression evaluates to +null. Otherwise the field will be set to the value null. Has no effect +if overwrite is set to false.

    +

    Default: true

    +
  • +
  • +
    name: string
    +

    Name of the target attribute of the computed value.

    +
  • +
  • +
    Optional overwrite?: boolean
    +

    If set to false, the computed value will not be applied if the +expression evaluates to null.

    +

    Default: true

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/collection.ComputedValueProperties.html b/8.8.0/types/collection.ComputedValueProperties.html new file mode 100644 index 000000000..3727ed9ef --- /dev/null +++ b/8.8.0/types/collection.ComputedValueProperties.html @@ -0,0 +1,138 @@ +ComputedValueProperties | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias ComputedValueProperties

+
ComputedValueProperties: {
    computeOn: WriteOperation[];
    expression: string;
    failOnWarning: boolean;
    keepNull: boolean;
    name: string;
    overwrite: boolean;
}
+

Properties defining a computed value.

+
+
+

Type declaration

+
    +
  • +
    computeOn: WriteOperation[]
    +

    Which operations should result in the value being computed.

    +
  • +
  • +
    expression: string
    +

    AQL RETURN expression that computes the value.

    +
  • +
  • +
    failOnWarning: boolean
    +

    Whether the write operation should fail if the expression produces a +warning.

    +
  • +
  • +
    keepNull: boolean
    +

    If set to false, the field will be unset if the expression evaluates to +null. Otherwise the field will be set to the value null. Has no effect +if overwrite is set to false.

    +
  • +
  • +
    name: string
    +

    Name of the target attribute of the computed value.

    +
  • +
  • +
    overwrite: boolean
    +

    If set to false, the computed value will not be applied if the +expression evaluates to null.

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/collection.CreateCollectionOptions.html b/8.8.0/types/collection.CreateCollectionOptions.html new file mode 100644 index 000000000..e90507d99 --- /dev/null +++ b/8.8.0/types/collection.CreateCollectionOptions.html @@ -0,0 +1,186 @@ +CreateCollectionOptions | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias CreateCollectionOptions

+
CreateCollectionOptions: {
    cacheEnabled?: boolean;
    computedValues?: ComputedValueOptions[];
    distributeShardsLike?: string;
    enforceReplicationFactor?: boolean;
    keyOptions?: CollectionKeyOptions;
    numberOfShards?: number;
    replicationFactor?: number;
    schema?: SchemaOptions;
    shardKeys?: string[];
    shardingStrategy?: ShardingStrategy;
    smartGraphAttribute?: string;
    smartJoinAttribute?: string;
    waitForSync?: boolean;
    waitForSyncReplication?: boolean;
    writeConcern?: number;
}
+

Options for creating a collection.

+

See createCollection, createEdgeCollection +and create or create.

+
+
+

Type declaration

+
    +
  • +
    Optional cacheEnabled?: boolean
    +

    Whether the in-memory hash cache is enabled for this collection.

    +
  • +
  • +
    Optional computedValues?: ComputedValueOptions[]
    +

    Computed values to apply to documents in this collection.

    +
  • +
  • +
    Optional distributeShardsLike?: string
    +

    (Enterprise Edition cluster only.) If set to a collection name, sharding +of the new collection will follow the rules for that collection. As long +as the new collection exists, the indicated collection can not be dropped.

    +
  • +
  • +
    Optional enforceReplicationFactor?: boolean
    +

    (Cluster only.) Unless set to false, the server will check whether +enough replicas are available at creation time and bail out otherwise.

    +

    Default: true

    +
  • +
  • +
    Optional keyOptions?: CollectionKeyOptions
    +

    An object defining the collection's key generation.

    +
  • +
  • +
    Optional numberOfShards?: number
    +

    (Cluster only.) Number of shards to distribute the collection across.

    +

    Default: 1

    +
  • +
  • +
    Optional replicationFactor?: number
    +

    (Cluster only.) How many copies of each document should be kept in the +cluster.

    +

    Default: 1

    +
  • +
  • +
    Optional schema?: SchemaOptions
    +

    Options for validating documents in the collection.

    +
  • +
  • +
    Optional shardKeys?: string[]
    +

    (Cluster only.) Document attributes to use to determine the target shard +for each document.

    +

    Default: ["_key"]

    +
  • +
  • +
    Optional shardingStrategy?: ShardingStrategy
    +

    (Cluster only.) Sharding strategy to use.

    +
  • +
  • +
    Optional smartGraphAttribute?: string
    +

    (Enterprise Edition cluster only.) Attribute used for sharding.

    +
  • +
  • +
    Optional smartJoinAttribute?: string
    +

    (Enterprise Edition cluster only.) Attribute containing the shard key +value of the referred-to smart join collection.

    +
  • +
  • +
    Optional waitForSync?: boolean
    +

    If set to true, data will be synchronized to disk before returning from +a document create, update, replace or removal operation.

    +

    Default: false

    +
  • +
  • +
    Optional waitForSyncReplication?: boolean
    +

    (Cluster only.) Unless set to false, the server will wait for all +replicas to create the collection before returning.

    +

    Default: true

    +
  • +
  • +
    Optional writeConcern?: number
    +

    (Cluster only.) Write concern for this collection.

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/collection.DocumentExistsOptions.html b/8.8.0/types/collection.DocumentExistsOptions.html new file mode 100644 index 000000000..647752a90 --- /dev/null +++ b/8.8.0/types/collection.DocumentExistsOptions.html @@ -0,0 +1,120 @@ +DocumentExistsOptions | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias DocumentExistsOptions

+
DocumentExistsOptions: {
    ifMatch?: string;
    ifNoneMatch?: string;
}
+

Options for checking whether a document exists in a collection.

+
+
+

Type declaration

+
    +
  • +
    Optional ifMatch?: string
    +

    If set to a document revision, the document will only match if its _rev +matches the given revision.

    +
  • +
  • +
    Optional ifNoneMatch?: string
    +

    If set to a document revision, the document will only match if its _rev +does not match the given revision.

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/collection.DocumentOperationFailure.html b/8.8.0/types/collection.DocumentOperationFailure.html new file mode 100644 index 000000000..2fbd511fc --- /dev/null +++ b/8.8.0/types/collection.DocumentOperationFailure.html @@ -0,0 +1,122 @@ +DocumentOperationFailure | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias DocumentOperationFailure

+
DocumentOperationFailure: {
    error: true;
    errorMessage: string;
    errorNum: number;
}
+

Represents a bulk operation failure for an individual document.

+
+
+

Type declaration

+
    +
  • +
    error: true
    +

    Indicates that the operation failed.

    +
  • +
  • +
    errorMessage: string
    +

    Human-readable description of the failure.

    +
  • +
  • +
    errorNum: number
    +

    Numeric representation of the failure.

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/collection.DocumentOperationMetadata.html b/8.8.0/types/collection.DocumentOperationMetadata.html new file mode 100644 index 000000000..61846e56b --- /dev/null +++ b/8.8.0/types/collection.DocumentOperationMetadata.html @@ -0,0 +1,107 @@ +DocumentOperationMetadata | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias DocumentOperationMetadata

+
DocumentOperationMetadata: DocumentMetadata & {
    _oldRev?: string;
}
+

Metadata returned by a document operation.

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/collection.KeyGenerator.html b/8.8.0/types/collection.KeyGenerator.html new file mode 100644 index 000000000..0e8f06d68 --- /dev/null +++ b/8.8.0/types/collection.KeyGenerator.html @@ -0,0 +1,107 @@ +KeyGenerator | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias KeyGenerator

+
KeyGenerator: "traditional" | "autoincrement" | "uuid" | "padded"
+

Type of key generator.

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/collection.SchemaOptions.html b/8.8.0/types/collection.SchemaOptions.html new file mode 100644 index 000000000..748588c7c --- /dev/null +++ b/8.8.0/types/collection.SchemaOptions.html @@ -0,0 +1,123 @@ +SchemaOptions | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias SchemaOptions

+
SchemaOptions: {
    level?: ValidationLevel;
    message?: string;
    rule: any;
}
+

Options for validating collection documents.

+
+
+

Type declaration

+
    +
  • +
    Optional level?: ValidationLevel
    +

    When validation should be applied.

    +

    Default: "strict"

    +
  • +
  • +
    Optional message?: string
    +

    Message to be used if validation fails.

    +
  • +
  • +
    rule: any
    +

    JSON Schema description of the validation schema for documents.

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/collection.SchemaProperties.html b/8.8.0/types/collection.SchemaProperties.html new file mode 100644 index 000000000..5d643024e --- /dev/null +++ b/8.8.0/types/collection.SchemaProperties.html @@ -0,0 +1,126 @@ +SchemaProperties | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias SchemaProperties

+
SchemaProperties: {
    level: ValidationLevel;
    message: string;
    rule: any;
    type: "json";
}
+

Properties for validating documents in a collection.

+
+
+

Type declaration

+
    +
  • +
    level: ValidationLevel
    +

    When validation should be applied.

    +
  • +
  • +
    message: string
    +

    Message to be used if validation fails.

    +
  • +
  • +
    rule: any
    +

    JSON Schema description of the validation schema for documents.

    +
  • +
  • +
    type: "json"
    +

    Type of document validation.

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/collection.ShardingStrategy.html b/8.8.0/types/collection.ShardingStrategy.html new file mode 100644 index 000000000..0d92e077f --- /dev/null +++ b/8.8.0/types/collection.ShardingStrategy.html @@ -0,0 +1,107 @@ +ShardingStrategy | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias ShardingStrategy

+
ShardingStrategy: "hash" | "enterprise-hash-smart-edge" | "enterprise-hash-smart-vertex" | "community-compat" | "enterprise-compat" | "enterprise-smart-edge-compat"
+

Strategy for sharding a collection.

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/collection.SimpleQueryAllOptions.html b/8.8.0/types/collection.SimpleQueryAllOptions.html new file mode 100644 index 000000000..a1393d9db --- /dev/null +++ b/8.8.0/types/collection.SimpleQueryAllOptions.html @@ -0,0 +1,139 @@ +SimpleQueryAllOptions | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias SimpleQueryAllOptions

+
SimpleQueryAllOptions: {
    batchSize?: number;
    limit?: number;
    skip?: number;
    stream?: boolean;
    ttl?: number;
}
+

Options for retrieving all documents in a collection.

+ +

Deprecated

Simple Queries have been deprecated in ArangoDB 3.4 and can be +replaced with AQL queries.

+
+
+

Type declaration

+
    +
  • +
    Optional batchSize?: number
    +

    Number of result values to be transferred by the server in each +network roundtrip (or "batch").

    +

    Must be greater than zero.

    +

    See also QueryOptions.

    +
  • +
  • +
    Optional limit?: number
    +

    Maximum number of documents to return.

    +
  • +
  • +
    Optional skip?: number
    +

    Number of documents to skip in the query.

    +
  • +
  • +
    Optional stream?: boolean
    +

    If set to true, the query will be executed as a streaming query.

    +

    See also QueryOptions.

    +
  • +
  • +
    Optional ttl?: number
    +

    Time-to-live for the cursor in seconds. The cursor results may be +garbage collected by ArangoDB after this much time has passed.

    +

    See also QueryOptions.

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/collection.SimpleQueryByExampleOptions.html b/8.8.0/types/collection.SimpleQueryByExampleOptions.html new file mode 100644 index 000000000..0fe0c85d7 --- /dev/null +++ b/8.8.0/types/collection.SimpleQueryByExampleOptions.html @@ -0,0 +1,134 @@ +SimpleQueryByExampleOptions | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias SimpleQueryByExampleOptions

+
SimpleQueryByExampleOptions: {
    batchSize?: number;
    limit?: number;
    skip?: number;
    ttl?: number;
}
+

Options for retrieving documents by example.

+ +

Deprecated

Simple Queries have been deprecated in ArangoDB 3.4 and can be +replaced with AQL queries.

+
+
+

Type declaration

+
    +
  • +
    Optional batchSize?: number
    +

    Number of result values to be transferred by the server in each +network roundtrip (or "batch").

    +

    Must be greater than zero.

    +

    See also QueryOptions.

    +
  • +
  • +
    Optional limit?: number
    +

    Maximum number of documents to return.

    +
  • +
  • +
    Optional skip?: number
    +

    Number of documents to skip in the query.

    +
  • +
  • +
    Optional ttl?: number
    +

    Time-to-live for the cursor in seconds. The cursor results may be +garbage collected by ArangoDB after this much time has passed.

    +

    See also QueryOptions.

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/collection.SimpleQueryFulltextOptions.html b/8.8.0/types/collection.SimpleQueryFulltextOptions.html new file mode 100644 index 000000000..bb3d75027 --- /dev/null +++ b/8.8.0/types/collection.SimpleQueryFulltextOptions.html @@ -0,0 +1,125 @@ +SimpleQueryFulltextOptions | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias SimpleQueryFulltextOptions

+
SimpleQueryFulltextOptions: {
    index?: string;
    limit?: number;
    skip?: number;
}
+

Options for performing a fulltext query.

+ +

Deprecated

Simple Queries have been deprecated in ArangoDB 3.4 and can be +replaced with AQL queries.

+
+
+

Type declaration

+
    +
  • +
    Optional index?: string
    +

    Unique identifier of the fulltext index to use to perform the query.

    +
  • +
  • +
    Optional limit?: number
    +

    Maximum number of documents to return.

    +
  • +
  • +
    Optional skip?: number
    +

    Number of documents to skip in the query.

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/collection.SimpleQueryListType.html b/8.8.0/types/collection.SimpleQueryListType.html new file mode 100644 index 000000000..45cfd9882 --- /dev/null +++ b/8.8.0/types/collection.SimpleQueryListType.html @@ -0,0 +1,111 @@ +SimpleQueryListType | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias SimpleQueryListType

+
SimpleQueryListType: "id" | "key" | "path"
+

Type of document reference.

+

See list and list.

+ +

Deprecated

Simple Queries have been deprecated in ArangoDB 3.4 and can be +replaced with AQL queries.

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/collection.SimpleQueryRemoveByExampleOptions.html b/8.8.0/types/collection.SimpleQueryRemoveByExampleOptions.html new file mode 100644 index 000000000..e7711ccf6 --- /dev/null +++ b/8.8.0/types/collection.SimpleQueryRemoveByExampleOptions.html @@ -0,0 +1,123 @@ +SimpleQueryRemoveByExampleOptions | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias SimpleQueryRemoveByExampleOptions

+
SimpleQueryRemoveByExampleOptions: {
    limit?: number;
    waitForSync?: boolean;
}
+

Options for removing documents by example.

+ +

Deprecated

Simple Queries have been deprecated in ArangoDB 3.4 and can be +replaced with AQL queries.

+
+
+

Type declaration

+
    +
  • +
    Optional limit?: number
    +

    Maximum number of documents to return.

    +
  • +
  • +
    Optional waitForSync?: boolean
    +

    If set to true, the request will wait until all modifications have been +synchronized to disk before returning successfully.

    +

    Default: false

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/collection.SimpleQueryRemoveByExampleResult.html b/8.8.0/types/collection.SimpleQueryRemoveByExampleResult.html new file mode 100644 index 000000000..579dcab92 --- /dev/null +++ b/8.8.0/types/collection.SimpleQueryRemoveByExampleResult.html @@ -0,0 +1,118 @@ +SimpleQueryRemoveByExampleResult | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias SimpleQueryRemoveByExampleResult

+
SimpleQueryRemoveByExampleResult: {
    deleted: number;
}
+

Result of removing documents by an example.

+

See removeByExample and removeByExample.

+ +

Deprecated

Simple Queries have been deprecated in ArangoDB 3.4 and can be +replaced with AQL queries.

+
+
+

Type declaration

+
    +
  • +
    deleted: number
    +

    Number of documents removed.

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/collection.SimpleQueryRemoveByKeysOptions.html b/8.8.0/types/collection.SimpleQueryRemoveByKeysOptions.html new file mode 100644 index 000000000..d1d739dec --- /dev/null +++ b/8.8.0/types/collection.SimpleQueryRemoveByKeysOptions.html @@ -0,0 +1,131 @@ +SimpleQueryRemoveByKeysOptions | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias SimpleQueryRemoveByKeysOptions

+
SimpleQueryRemoveByKeysOptions: {
    returnOld?: boolean;
    silent?: boolean;
    waitForSync?: boolean;
}
+

Options for removing documents by keys.

+ +

Deprecated

Simple Queries have been deprecated in ArangoDB 3.4 and can be +replaced with AQL queries.

+
+
+

Type declaration

+
    +
  • +
    Optional returnOld?: boolean
    +

    If set to true, the complete old document will be returned as the old +property on the result object. Has no effect if silent is set to true.

    +

    Default: false

    +
  • +
  • +
    Optional silent?: boolean
    +

    If set to true, no data will be returned by the server. This option can +be used to reduce network traffic.

    +

    Default: false

    +
  • +
  • +
    Optional waitForSync?: boolean
    +

    If set to true, the request will wait until all modifications have been +synchronized to disk before returning successfully.

    +

    Default: false

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/collection.SimpleQueryRemoveByKeysResult.html b/8.8.0/types/collection.SimpleQueryRemoveByKeysResult.html new file mode 100644 index 000000000..743fe200d --- /dev/null +++ b/8.8.0/types/collection.SimpleQueryRemoveByKeysResult.html @@ -0,0 +1,131 @@ +SimpleQueryRemoveByKeysResult | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias SimpleQueryRemoveByKeysResult<T>

+
SimpleQueryRemoveByKeysResult<T>: {
    ignored: number;
    old?: DocumentMetadata[] | Document<T>[];
    removed: number;
}
+

Result of removing documents by keys.

+

See removeByKeys and removeByKeys.

+ +

Deprecated

Simple Queries have been deprecated in ArangoDB 3.4 and can be +replaced with AQL queries.

+
+
+

Type Parameters

+
    +
  • +

    T extends Record<string, any> = any

+
+

Type declaration

+
    +
  • +
    ignored: number
    +

    Number of documents not removed.

    +
  • +
  • +
    Optional old?: DocumentMetadata[] | Document<T>[]
    +

    Documents that have been removed.

    +
  • +
  • +
    removed: number
    +

    Number of documents removed.

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/collection.SimpleQueryReplaceByExampleOptions.html b/8.8.0/types/collection.SimpleQueryReplaceByExampleOptions.html new file mode 100644 index 000000000..35e9167dc --- /dev/null +++ b/8.8.0/types/collection.SimpleQueryReplaceByExampleOptions.html @@ -0,0 +1,110 @@ +SimpleQueryReplaceByExampleOptions | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias SimpleQueryReplaceByExampleOptions

+
SimpleQueryReplaceByExampleOptions: SimpleQueryRemoveByExampleOptions
+

Options for replacing documents by example.

+ +

Deprecated

Simple Queries have been deprecated in ArangoDB 3.4 and can be +replaced with AQL queries.

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/collection.SimpleQueryReplaceByExampleResult.html b/8.8.0/types/collection.SimpleQueryReplaceByExampleResult.html new file mode 100644 index 000000000..2a3465ac8 --- /dev/null +++ b/8.8.0/types/collection.SimpleQueryReplaceByExampleResult.html @@ -0,0 +1,118 @@ +SimpleQueryReplaceByExampleResult | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias SimpleQueryReplaceByExampleResult

+
SimpleQueryReplaceByExampleResult: {
    replaced: number;
}
+

Result of replacing documents by an example.

+

See replaceByExample and replaceByExample.

+ +

Deprecated

Simple Queries have been deprecated in ArangoDB 3.4 and can be +replaced with AQL queries.

+
+
+

Type declaration

+
    +
  • +
    replaced: number
    +

    Number of documents replaced.

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/collection.SimpleQueryUpdateByExampleOptions.html b/8.8.0/types/collection.SimpleQueryUpdateByExampleOptions.html new file mode 100644 index 000000000..e55d630f7 --- /dev/null +++ b/8.8.0/types/collection.SimpleQueryUpdateByExampleOptions.html @@ -0,0 +1,136 @@ +SimpleQueryUpdateByExampleOptions | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias SimpleQueryUpdateByExampleOptions

+
SimpleQueryUpdateByExampleOptions: {
    keepNull?: boolean;
    limit?: number;
    mergeObjects?: boolean;
    waitForSync?: boolean;
}
+

Options for updating documents by example.

+ +

Deprecated

Simple Queries have been deprecated in ArangoDB 3.4 and can be +replaced with AQL queries.

+
+
+

Type declaration

+
    +
  • +
    Optional keepNull?: boolean
    +

    If set to false, properties with a value of null will be removed from +the new document.

    +

    Default: true

    +
  • +
  • +
    Optional limit?: number
    +

    Maximum number of documents to return.

    +
  • +
  • +
    Optional mergeObjects?: boolean
    +

    If set to false, object properties that already exist in the old +document will be overwritten rather than merged. This does not affect +arrays.

    +

    Default: true

    +
  • +
  • +
    Optional waitForSync?: boolean
    +

    If set to true, the request will wait until all modifications have been +synchronized to disk before returning successfully.

    +

    Default: false

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/collection.SimpleQueryUpdateByExampleResult.html b/8.8.0/types/collection.SimpleQueryUpdateByExampleResult.html new file mode 100644 index 000000000..3d0433323 --- /dev/null +++ b/8.8.0/types/collection.SimpleQueryUpdateByExampleResult.html @@ -0,0 +1,118 @@ +SimpleQueryUpdateByExampleResult | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias SimpleQueryUpdateByExampleResult

+
SimpleQueryUpdateByExampleResult: {
    updated: number;
}
+

Result of updating documents by an example.

+

See updateByExample and updateByExample.

+ +

Deprecated

Simple Queries have been deprecated in ArangoDB 3.4 and can be +replaced with AQL queries.

+
+
+

Type declaration

+
    +
  • +
    updated: number
    +

    Number of documents updated.

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/collection.TraversalOptions.html b/8.8.0/types/collection.TraversalOptions.html new file mode 100644 index 000000000..33fc46f15 --- /dev/null +++ b/8.8.0/types/collection.TraversalOptions.html @@ -0,0 +1,235 @@ +TraversalOptions | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias TraversalOptions

+
TraversalOptions: {
    direction?: "inbound" | "outbound" | "any";
    expander?: string;
    filter?: string;
    init?: string;
    itemOrder?: "forward" | "backward";
    maxDepth?: number;
    maxIterations?: number;
    minDepth?: number;
    order?: "preorder" | "postorder" | "preorder-expander";
    sort?: string;
    strategy?: "depthfirst" | "breadthfirst";
    uniqueness?: {
        edges?: "none" | "global" | "path";
        vertices?: "none" | "global" | "path";
    };
    visitor?: string;
}
+

Options for performing a graph traversal.

+ +

Deprecated

Simple Queries have been deprecated in ArangoDB 3.4 and are +no longer supported in ArangoDB 3.12. They can be replaced with AQL queries.

+
+
+

Type declaration

+
    +
  • +
    Optional direction?: "inbound" | "outbound" | "any"
    +

    Direction of the traversal, relative to the starting vertex if expander +is not set.

    +
  • +
  • +
    Optional expander?: string
    +

    A string evaluating to the body of a JavaScript function to be executed +on the server to use when direction is not set.

    +

    The code has access to three variables: config, vertex, path. +The code must return an array of objects with edge and vertex +attributes representing the connections for the vertex.

    +

    Note: This code will be evaluated and executed on the +server inside ArangoDB's embedded JavaScript environment and can not +access any other variables.

    +

    See the official ArangoDB documentation for +the JavaScript @arangodb module +for information about accessing the database from within ArangoDB's +server-side JavaScript environment.

    +
  • +
  • +
    Optional filter?: string
    +

    A string evaluating to the body of a JavaScript function to be executed +on the server to filter nodes.

    +

    The code has access to three variables: config, vertex, path. +The code may include a return statement for the following values:

    +
      +
    • "exclude": The vertex will not be visited.
    • +
    • "prune": The edges of the vertex will not be followed.
    • +
    • "" or undefined: The vertex will be visited and its edges followed.
    • +
    • an array including any of the above values.
    • +
    +

    Note: This code will be evaluated and executed on the +server inside ArangoDB's embedded JavaScript environment and can not +access any other variables.

    +

    See the official ArangoDB documentation for +the JavaScript @arangodb module +for information about accessing the database from within ArangoDB's +server-side JavaScript environment.

    +
  • +
  • +
    Optional init?: string
    +

    A string evaluating to the body of a JavaScript function to be executed +on the server to initialize the traversal result object.

    +

    The code has access to two variables: config, result. +The code may modify the result object.

    +

    Note: This code will be evaluated and executed on the +server inside ArangoDB's embedded JavaScript environment and can not +access any other variables.

    +

    See the official ArangoDB documentation for +the JavaScript @arangodb module +for information about accessing the database from within ArangoDB's +server-side JavaScript environment.

    +
  • +
  • +
    Optional itemOrder?: "forward" | "backward"
    +

    Item iteration order.

    +
  • +
  • +
    Optional maxDepth?: number
    +

    If specified, only nodes in at most this depth will be visited.

    +
  • +
  • +
    Optional maxIterations?: number
    +

    Maximum number of iterations before a traversal is aborted because of a +potential endless loop.

    +
  • +
  • +
    Optional minDepth?: number
    +

    If specified, only nodes in at least this depth will be visited.

    +
  • +
  • +
    Optional order?: "preorder" | "postorder" | "preorder-expander"
    +

    Traversal order.

    +
  • +
  • +
    Optional sort?: string
    +

    A string evaluating to the body of a JavaScript function to be executed +on the server to sort edges if expander is not set.

    +

    The code has access to two variables representing edges: l, r. +The code must return -1 if l < r, 1 if l > r or 0 if both +values are equal.

    +

    Note: This code will be evaluated and executed on the +server inside ArangoDB's embedded JavaScript environment and can not +access any other variables.

    +

    See the official ArangoDB documentation for +the JavaScript @arangodb module +for information about accessing the database from within ArangoDB's +server-side JavaScript environment.

    +
  • +
  • +
    Optional strategy?: "depthfirst" | "breadthfirst"
    +

    Traversal strategy.

    +
  • +
  • +
    Optional uniqueness?: {
        edges?: "none" | "global" | "path";
        vertices?: "none" | "global" | "path";
    }
    +

    Specifies uniqueness for vertices and edges.

    +
    +
      +
    • +
      Optional edges?: "none" | "global" | "path"
      +

      Uniqueness for edges.

      +
    • +
    • +
      Optional vertices?: "none" | "global" | "path"
      +

      Uniqueness for vertices.

      +
  • +
  • +
    Optional visitor?: string
    +

    A string evaluating to the body of a JavaScript function to be executed +on the server when a node is visited.

    +

    The code has access to five variables: config, result, vertex, +path, connected. +The code may modify the result object.

    +

    Note: This code will be evaluated and executed on the +server inside ArangoDB's embedded JavaScript environment and can not +access any other variables.

    +

    See the official ArangoDB documentation for +the JavaScript @arangodb module +for information about accessing the database from within ArangoDB's +server-side JavaScript environment.

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/collection.ValidationLevel.html b/8.8.0/types/collection.ValidationLevel.html new file mode 100644 index 000000000..28f445bac --- /dev/null +++ b/8.8.0/types/collection.ValidationLevel.html @@ -0,0 +1,114 @@ +ValidationLevel | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias ValidationLevel

+
ValidationLevel: "none" | "new" | "moderate" | "strict"
+

When a validation should be applied.

+
    +
  • "none": No validation.
  • +
  • "new": Newly inserted documents are validated.
  • +
  • "moderate": New and modified documents are validated unless the modified +document was already invalid.
  • +
  • "strict": New and modified documents are always validated.
  • +
+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/collection.WriteOperation.html b/8.8.0/types/collection.WriteOperation.html new file mode 100644 index 000000000..7d0cf7276 --- /dev/null +++ b/8.8.0/types/collection.WriteOperation.html @@ -0,0 +1,107 @@ +WriteOperation | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias WriteOperation

+
WriteOperation: "insert" | "update" | "replace"
+

Write operation that can result in a computed value being computed.

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/connection.AgentOptions.html b/8.8.0/types/connection.AgentOptions.html new file mode 100644 index 000000000..35875a0b1 --- /dev/null +++ b/8.8.0/types/connection.AgentOptions.html @@ -0,0 +1,76 @@ +AgentOptions | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias AgentOptions

+
AgentOptions: NodeAgentOptions | XhrOptions
+

Options for creating the Node.js http.Agent or https.Agent.

+

In browser environments this option can be used to pass additional options +to the underlying calls of the +xhr module.

+

See also http.Agent +and https.Agent +(when using TLS).

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/connection.ArangoApiResponse.html b/8.8.0/types/connection.ArangoApiResponse.html new file mode 100644 index 000000000..4a6390e7a --- /dev/null +++ b/8.8.0/types/connection.ArangoApiResponse.html @@ -0,0 +1,75 @@ +ArangoApiResponse | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias ArangoApiResponse<T>

+
ArangoApiResponse<T>: T & ArangoResponseMetadata
+

Extends the given base type T with the generic HTTP API response properties.

+
+
+

Type Parameters

+
    +
  • +

    T

+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/connection.ArangoResponseMetadata.html b/8.8.0/types/connection.ArangoResponseMetadata.html new file mode 100644 index 000000000..62c0dda86 --- /dev/null +++ b/8.8.0/types/connection.ArangoResponseMetadata.html @@ -0,0 +1,81 @@ +ArangoResponseMetadata | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias ArangoResponseMetadata

+
ArangoResponseMetadata: {
    code: number;
    error: false;
}
+

Generic properties shared by all ArangoDB HTTP API responses.

+
+
+

Type declaration

+
    +
  • +
    code: number
    +

    Response status code, typically 200.

    +
  • +
  • +
    error: false
    +

    Indicates that the request was successful.

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/connection.BasicAuthCredentials.html b/8.8.0/types/connection.BasicAuthCredentials.html new file mode 100644 index 000000000..4f3397816 --- /dev/null +++ b/8.8.0/types/connection.BasicAuthCredentials.html @@ -0,0 +1,81 @@ +BasicAuthCredentials | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias BasicAuthCredentials

+
BasicAuthCredentials: {
    password?: string;
    username: string;
}
+

Credentials for HTTP Basic authentication.

+
+
+

Type declaration

+
    +
  • +
    Optional password?: string
    +

    Password to use for authentication. Defaults to an empty string.

    +
  • +
  • +
    username: string
    +

    Username to use for authentication, e.g. "root".

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/connection.BearerAuthCredentials.html b/8.8.0/types/connection.BearerAuthCredentials.html new file mode 100644 index 000000000..e40ffabe8 --- /dev/null +++ b/8.8.0/types/connection.BearerAuthCredentials.html @@ -0,0 +1,77 @@ +BearerAuthCredentials | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias BearerAuthCredentials

+
BearerAuthCredentials: {
    token: string;
}
+

Credentials for HTTP Bearer token authentication.

+
+
+

Type declaration

+
    +
  • +
    token: string
    +

    Bearer token to use for authentication.

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/connection.Config.html b/8.8.0/types/connection.Config.html new file mode 100644 index 000000000..2b0df30b6 --- /dev/null +++ b/8.8.0/types/connection.Config.html @@ -0,0 +1,218 @@ +Config | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias Config

+
Config: {
    agent?: any;
    agentOptions?: AgentOptions & RequestInterceptors;
    arangoVersion?: number;
    auth?: BasicAuthCredentials | BearerAuthCredentials;
    databaseName?: string;
    headers?: Headers;
    loadBalancingStrategy?: LoadBalancingStrategy;
    maxRetries?: false | number;
    precaptureStackTraces?: boolean;
    responseQueueTimeSamples?: number;
    retryOnConflict?: number;
    url?: string | string[];
}
+

Options for configuring arangojs.

+
+
+

Type declaration

+
    +
  • +
    Optional agent?: any
    +

    An http Agent instance to use for connections.

    +

    By default a new Agent instance will be created using the agentOptions.

    +

    This option has no effect when using the browser version of arangojs.

    +

    See also http.Agent +and https.Agent +(when using TLS).

    +
  • +
  • +
    Optional agentOptions?: AgentOptions & RequestInterceptors
    +

    Options used to create that underlying HTTP/HTTPS Agent (or the xhr +module when using arangojs in the browser). This will be ignored if +agent is also provided.

    +

    The option maxSockets is also used to limit how many requests +arangojs will perform concurrently. The maximum number of requests is +equal to maxSockets.

    +

    Note: arangojs will limit the number of concurrent requests based on +this value even if an agent is provided.

    +

    Note: when using ROUND_ROBIN load balancing and passing an array of +URLs in the url option, the default value of maxSockets will be set +to 3 * url.length instead of 3.

    +

    Default (Node.js): { maxSockets: 3, keepAlive: true, keepAliveMsecs: 1000 }

    +

    Default (browser): { maxSockets: 3, useXDR: true, withCredentials: true }

    +
  • +
  • +
    Optional arangoVersion?: number
    +

    Numeric representation of the ArangoDB version the driver should expect. +The format is defined as XYYZZ where X is the major version, Y is +the zero-filled two-digit minor version and Z is the zero-filled two-digit +bugfix version, e.g. 30102 for 3.1.2, 20811 for 2.8.11.

    +

    Depending on this value certain methods may become unavailable or change +their behavior to remain compatible with different versions of ArangoDB.

    +

    Default: 30900

    +
  • +
  • +
    Optional auth?: BasicAuthCredentials | BearerAuthCredentials
    +

    Credentials to use for authentication.

    +

    See also useBasicAuth and +useBearerAuth.

    +

    Default: { username: "root", password: "" }

    +
  • +
  • +
    Optional databaseName?: string
    +

    Name of the database to use.

    +

    Default: "_system"

    +
  • +
  • +
    Optional headers?: Headers
    +

    An object with additional headers to send with every request.

    +

    If an "authorization" header is provided, it will be overridden when +using useBasicAuth, useBearerAuth or +the auth configuration option.

    +
  • +
  • +
    Optional loadBalancingStrategy?: LoadBalancingStrategy
    +

    Determines the behavior when multiple URLs are provided:

    +
      +
    • "NONE": No load balancing. All requests will be handled by the first +URL in the list until a network error is encountered. On network error, +arangojs will advance to using the next URL in the list.

      +
    • +
    • "ONE_RANDOM": Randomly picks one URL from the list initially, then +behaves like "NONE".

      +
    • +
    • "ROUND_ROBIN": Every sequential request uses the next URL in the list.

      +
    • +
    +

    Default: "NONE"

    +
  • +
  • +
    Optional maxRetries?: false | number
    +

    Determines the behavior when a request fails because the underlying +connection to the server could not be opened +(i.e. ECONNREFUSED in Node.js):

    +
      +
    • false: the request fails immediately.

      +
    • +
    • 0: the request is retried until a server can be reached but only a +total number of times matching the number of known servers (including +the initial failed request).

      +
    • +
    • any other number: the request is retried until a server can be reached +or the request has been retried a total of maxRetries number of times +(not including the initial failed request).

      +
    • +
    +

    When working with a single server, the retries (if any) will be made to +the same server.

    +

    This setting currently has no effect when using arangojs in a browser.

    +

    Note: Requests bound to a specific server (e.g. fetching query results) +will never be retried automatically and ignore this setting.

    +

    Note: To set the number of retries when a write-write conflict is +encountered, see retryOnConflict instead.

    +

    Default: 0

    +
  • +
  • +
    Optional precaptureStackTraces?: boolean
    +

    If set to true, arangojs will generate stack traces every time a request +is initiated and augment the stack traces of any errors it generates.

    +

    Warning: This will cause arangojs to generate stack traces in advance +even if the request does not result in an error. Generating stack traces +may negatively impact performance.

    +
  • +
  • +
    Optional responseQueueTimeSamples?: number
    +

    Limits the number of values of server-reported response queue times that +will be stored and accessible using queueTime. If set to +a finite value, older values will be discarded to make room for new values +when that limit is reached.

    +

    Default: 10

    +
  • +
  • +
    Optional retryOnConflict?: number
    +

    If set to a positive number, requests will automatically be retried at +most this many times if they result in a write-write conflict.

    +

    Default: 0

    +
  • +
  • +
    Optional url?: string | string[]
    +

    Base URL of the ArangoDB server or list of server URLs.

    +

    When working with a cluster, the method acquireHostList +can be used to automatically pick up additional coordinators/followers at +any point.

    +

    When running ArangoDB on a unix socket, e.g. /tmp/arangodb.sock, the +following URL formats are supported for unix sockets:

    +
      +
    • unix:///tmp/arangodb.sock (no SSL)
    • +
    • http+unix:///tmp/arangodb.sock (or https+unix:// for SSL)
    • +
    • http://unix:/tmp/arangodb.sock (or https://unix: for SSL)
    • +
    +

    Additionally ssl and tls are treated as synonymous with https and +tcp is treated as synonymous with http, so the following URLs are +considered identical:

    +
      +
    • tcp://127.0.0.1:8529 and http://127.0.0.1:8529
    • +
    • ssl://127.0.0.1:8529 and https://127.0.0.1:8529
    • +
    • tcp+unix:///tmp/arangodb.sock and http+unix:///tmp/arangodb.sock
    • +
    • ssl+unix:///tmp/arangodb.sock and https+unix:///tmp/arangodb.sock
    • +
    • tcp://unix:/tmp/arangodb.sock and http://unix:/tmp/arangodb.sock
    • +
    • ssl://unix:/tmp/arangodb.sock and https://unix:/tmp/arangodb.sock
    • +
    +

    See also auth for passing authentication credentials.

    +

    Default: "http://127.0.0.1:8529"

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/connection.Headers.html b/8.8.0/types/connection.Headers.html new file mode 100644 index 000000000..2c7ab2386 --- /dev/null +++ b/8.8.0/types/connection.Headers.html @@ -0,0 +1,72 @@ +Headers | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias Headers

+
Headers: Record<string, string>
+

An arbitrary object with string values representing HTTP headers and their +values.

+

Header names should always be lowercase.

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/connection.LoadBalancingStrategy.html b/8.8.0/types/connection.LoadBalancingStrategy.html new file mode 100644 index 000000000..652a29340 --- /dev/null +++ b/8.8.0/types/connection.LoadBalancingStrategy.html @@ -0,0 +1,81 @@ +LoadBalancingStrategy | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias LoadBalancingStrategy

+
LoadBalancingStrategy: "NONE" | "ROUND_ROBIN" | "ONE_RANDOM"
+

Determines the behavior when multiple URLs are used:

+
    +
  • "NONE": No load balancing. All requests will be handled by the first +URL in the list until a network error is encountered. On network error, +arangojs will advance to using the next URL in the list.

    +
  • +
  • "ONE_RANDOM": Randomly picks one URL from the list initially, then +behaves like "NONE".

    +
  • +
  • "ROUND_ROBIN": Every sequential request uses the next URL in the list.

    +
  • +
+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/connection.Params.html b/8.8.0/types/connection.Params.html new file mode 100644 index 000000000..e62ba03e3 --- /dev/null +++ b/8.8.0/types/connection.Params.html @@ -0,0 +1,71 @@ +Params | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias Params

+
Params: Record<string, any>
+

An arbitrary object with scalar values representing query string parameters +and their values.

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/connection.RequestInterceptors.html b/8.8.0/types/connection.RequestInterceptors.html new file mode 100644 index 000000000..1906ba053 --- /dev/null +++ b/8.8.0/types/connection.RequestInterceptors.html @@ -0,0 +1,116 @@ +RequestInterceptors | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias RequestInterceptors

+
RequestInterceptors: {
    after?: ((err: ArangojsError | null, res?: ArangojsResponse) => void);
    before?: ((req: ClientRequest) => void);
}
+

Additional options for intercepting the request/response. These methods +are primarily intended for tracking network related metrics.

+
+
+

Type declaration

+
    +
  • +
    Optional after?: ((err: ArangojsError | null, res?: ArangojsResponse) => void)
    +
      +
    • +
        +
      • (err: ArangojsError | null, res?: ArangojsResponse): void
      • +
      • +

        Callback that will be invoked when the server response has been received +and processed or when the request has been failed without a response.

        +

        The originating request will be available as the request property +on either the error or response object.

        +
        +
        +

        Parameters

        +
          +
        • +
          err: ArangojsError | null
          +

          Error encountered when handling this request or null.

          +
        • +
        • +
          Optional res: ArangojsResponse
          +

          Response object for this request, if no error occurred.

          +
        +

        Returns void

  • +
  • +
    Optional before?: ((req: ClientRequest) => void)
    +
      +
    • +
        +
      • (req: ClientRequest): void
      • +
      • +

        Callback that will be invoked with the finished request object before it +is finalized. In the browser the request may already have been sent.

        +
        +
        +

        Parameters

        +
          +
        • +
          req: ClientRequest
          +

          Request object or XHR instance used for this request.

          +
        +

        Returns void

+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/connection.RequestOptions.html b/8.8.0/types/connection.RequestOptions.html new file mode 100644 index 000000000..d2fe3d4aa --- /dev/null +++ b/8.8.0/types/connection.RequestOptions.html @@ -0,0 +1,127 @@ +RequestOptions | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias RequestOptions

+
RequestOptions: {
    allowDirtyRead?: boolean;
    basePath?: string;
    body?: any;
    expectBinary?: boolean;
    headers?: Headers;
    isBinary?: boolean;
    method?: string;
    path?: string;
    qs?: string | Params;
    retryOnConflict?: number;
    timeout?: number;
}
+

Options for performing a request with arangojs.

+
+
+

Type declaration

+
    +
  • +
    Optional allowDirtyRead?: boolean
    +

    Whether ArangoDB is allowed to perform a dirty read to respond to this +request. If set to true, the response may reflect a dirty state from +a non-authoritative server.

    +
  • +
  • +
    Optional basePath?: string
    +

    Optional prefix path to prepend to the path.

    +
  • +
  • +
    Optional body?: any
    +

    Request body data.

    +
  • +
  • +
    Optional expectBinary?: boolean
    +

    If set to true, the response body will not be interpreted as JSON and +instead passed as-is.

    +
  • +
  • +
    Optional headers?: Headers
    +

    HTTP headers to pass along with this request in addition to the default +headers generated by arangojs.

    +
  • +
  • +
    Optional isBinary?: boolean
    +

    If set to true, the request body will not be converted to JSON and +instead passed as-is.

    +
  • +
  • +
    Optional method?: string
    +

    HTTP method to use in order to perform the request.

    +

    Default: "GET"

    +
  • +
  • +
    Optional path?: string
    +

    URL path, relative to the basePath and server domain.

    +
  • +
  • +
    Optional qs?: string | Params
    +

    URL parameters to pass as part of the query string.

    +
  • +
  • +
    Optional retryOnConflict?: number
    +

    If set to a positive number, the request will automatically be retried at +most this many times if it results in a write-write conflict.

    +

    Default: config.retryOnConflict

    +
  • +
  • +
    Optional timeout?: number
    +

    Time in milliseconds after which arangojs will abort the request if the +socket has not already timed out.

    +

    See also agentOptions.timeout in Config.

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/connection.XhrOptions.html b/8.8.0/types/connection.XhrOptions.html new file mode 100644 index 000000000..2d841ac6d --- /dev/null +++ b/8.8.0/types/connection.XhrOptions.html @@ -0,0 +1,120 @@ +XhrOptions | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias XhrOptions

+
XhrOptions: {
    beforeSend?: ((xhrObject: any) => void);
    maxSockets?: number;
    timeout?: number;
    useXdr?: boolean;
    withCredentials?: boolean;
    xhr?: any;
}
+

Options of the xhr module that can be set using agentOptions when using +arangojs in the browser. Additionally maxSockets can be used to control +the maximum number of parallel requests.

+

See also: xhr on npm.

+
+
+

Type declaration

+
    +
  • +
    Optional beforeSend?: ((xhrObject: any) => void)
    +
      +
    • +
        +
      • (xhrObject: any): void
      • +
      • +

        Callback that will be invoked immediately before the send method of the +request is called.

        +

        See also RequestInterceptors.

        +
        +
        +

        Parameters

        +
          +
        • +
          xhrObject: any
        +

        Returns void

  • +
  • +
    Optional maxSockets?: number
    +

    Maximum number of parallel requests arangojs will perform. If any +additional requests are attempted, they will be enqueued until one of the +active requests has completed.

    +
  • +
  • +
    Optional timeout?: number
    +

    Number of milliseconds to wait for a response.

    +

    Default: 0 (disabled)

    +
  • +
  • +
    Optional useXdr?: boolean
    +

    (Internet Explorer 10 and lower only.) Whether XDomainRequest should be +used instead of XMLHttpRequest. Only required for performing +cross-domain requests in older versions of Internet Explorer.

    +
  • +
  • +
    Optional withCredentials?: boolean
    +

    Specifies whether browser credentials (e.g. cookies) should be sent if +performing a cross-domain request.

    +

    See XMLHttpRequest.withCredentials.

    +
  • +
  • +
    Optional xhr?: any
    +

    XMLHttpRequest object to use instead of the native implementation.

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/database.AccessLevel.html b/8.8.0/types/database.AccessLevel.html new file mode 100644 index 000000000..cd2ed355c --- /dev/null +++ b/8.8.0/types/database.AccessLevel.html @@ -0,0 +1,122 @@ +AccessLevel | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias AccessLevel

+
AccessLevel: "rw" | "ro" | "none"
+

Access level for an ArangoDB user's access to a collection or database.

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/database.AqlUserFunction.html b/8.8.0/types/database.AqlUserFunction.html new file mode 100644 index 000000000..4d546a345 --- /dev/null +++ b/8.8.0/types/database.AqlUserFunction.html @@ -0,0 +1,138 @@ +AqlUserFunction | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias AqlUserFunction

+
AqlUserFunction: {
    code: string;
    isDeterministic: boolean;
    name: string;
}
+

Definition of an AQL User Function.

+
+
+

Type declaration

+
    +
  • +
    code: string
    +

    Implementation of the AQL User Function.

    +
  • +
  • +
    isDeterministic: boolean
    +

    Whether the function is deterministic.

    +

    See createFunction.

    +
  • +
  • +
    name: string
    +

    Name of the AQL User Function.

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/database.ArangoUser.html b/8.8.0/types/database.ArangoUser.html new file mode 100644 index 000000000..416381d09 --- /dev/null +++ b/8.8.0/types/database.ArangoUser.html @@ -0,0 +1,137 @@ +ArangoUser | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias ArangoUser

+
ArangoUser: {
    active: boolean;
    extra: Record<string, any>;
    user: string;
}
+

Properties of an ArangoDB user object.

+
+
+

Type declaration

+
    +
  • +
    active: boolean
    +

    Whether the ArangoDB user account is enabled and can authenticate.

    +
  • +
  • +
    extra: Record<string, any>
    +

    Additional information to store about this user.

    +
  • +
  • +
    user: string
    +

    ArangoDB username of the user.

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/database.AstNode.html b/8.8.0/types/database.AstNode.html new file mode 100644 index 000000000..50ee69567 --- /dev/null +++ b/8.8.0/types/database.AstNode.html @@ -0,0 +1,131 @@ +AstNode | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias AstNode

+
AstNode: {
    subNodes: AstNode[];
    type: string;
    [key: string]: any;
}
+

Node in an AQL abstract syntax tree (AST).

+
+
+

Type declaration

+
    +
  • +
    [key: string]: any
  • +
  • +
    subNodes: AstNode[]
  • +
  • +
    type: string
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/database.ClusterImbalanceInfo.html b/8.8.0/types/database.ClusterImbalanceInfo.html new file mode 100644 index 000000000..db54f1491 --- /dev/null +++ b/8.8.0/types/database.ClusterImbalanceInfo.html @@ -0,0 +1,191 @@ +ClusterImbalanceInfo | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias ClusterImbalanceInfo

+
ClusterImbalanceInfo: {
    leader: {
        imbalance: number;
        leaderDupl: number[];
        numberShards: number[];
        targetWeight: number[];
        totalShards: number;
        totalWeight: number;
        weightUsed: number[];
    };
    shards: {
        imbalance: number;
        numberShards: number[];
        sizeUsed: number[];
        targetSize: number[];
        totalShards: number;
        totalShardsFromSystemCollections: number;
        totalUsed: number;
    };
}
+

Information about a cluster imbalance.

+
+
+

Type declaration

+
    +
  • +
    leader: {
        imbalance: number;
        leaderDupl: number[];
        numberShards: number[];
        targetWeight: number[];
        totalShards: number;
        totalWeight: number;
        weightUsed: number[];
    }
    +

    Information about the leader imbalance.

    +
    +
      +
    • +
      imbalance: number
      +

      The measure of the total imbalance. A high value indicates a high imbalance.

      +
    • +
    • +
      leaderDupl: number[]
      +

      The measure of the leader shard distribution. The higher the number, the worse the distribution.

      +
    • +
    • +
      numberShards: number[]
      +

      The number of leader shards per DB-Server.

      +
    • +
    • +
      targetWeight: number[]
      +

      The ideal weight of leader shards per DB-Server.

      +
    • +
    • +
      totalShards: number
      +

      The sum of shards, counting leader shards only.

      +
    • +
    • +
      totalWeight: number
      +

      The sum of all weights.

      +
    • +
    • +
      weightUsed: number[]
      +

      The weight of leader shards per DB-Server. A leader has a weight of 1 by default but it is higher if collections can only be moved together because of distributeShardsLike.

      +
  • +
  • +
    shards: {
        imbalance: number;
        numberShards: number[];
        sizeUsed: number[];
        targetSize: number[];
        totalShards: number;
        totalShardsFromSystemCollections: number;
        totalUsed: number;
    }
    +

    Information about the shard imbalance.

    +
    +
      +
    • +
      imbalance: number
      +

      The measure of the total imbalance. A high value indicates a high imbalance.

      +
    • +
    • +
      numberShards: number[]
      +

      The number of leader and follower shards per DB-Server.

      +
    • +
    • +
      sizeUsed: number[]
      +

      The size of shards per DB-Server.

      +
    • +
    • +
      targetSize: number[]
      +

      The ideal size of shards per DB-Server.

      +
    • +
    • +
      totalShards: number
      +

      The sum of shards, counting leader and follower shards.

      +
    • +
    • +
      totalShardsFromSystemCollections: number
      +

      The sum of system collection shards, counting leader shards only.

      +
    • +
    • +
      totalUsed: number
      +

      The sum of the sizes.

      +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/database.ClusterRebalanceMove.html b/8.8.0/types/database.ClusterRebalanceMove.html new file mode 100644 index 000000000..8962bc238 --- /dev/null +++ b/8.8.0/types/database.ClusterRebalanceMove.html @@ -0,0 +1,143 @@ +ClusterRebalanceMove | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias ClusterRebalanceMove

+
ClusterRebalanceMove: {
    collection: number;
    from: string;
    isLeader: boolean;
    shard: string;
    to: string;
}
+
+

Type declaration

+
    +
  • +
    collection: number
    +

    Collection ID of the collection the shard belongs to.

    +
  • +
  • +
    from: string
    +

    The server name from which to move.

    +
  • +
  • +
    isLeader: boolean
    +

    True if this is a leader move shard operation.

    +
  • +
  • +
    shard: string
    +

    Shard ID of the shard to be moved.

    +
  • +
  • +
    to: string
    +

    The ID of the destination server.

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/database.ClusterRebalanceOptions.html b/8.8.0/types/database.ClusterRebalanceOptions.html new file mode 100644 index 000000000..54ab17fda --- /dev/null +++ b/8.8.0/types/database.ClusterRebalanceOptions.html @@ -0,0 +1,159 @@ +ClusterRebalanceOptions | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias ClusterRebalanceOptions

+
ClusterRebalanceOptions: {
    databasesExcluded?: string[];
    excludeSystemCollections?: boolean;
    leaderChanges?: boolean;
    maximumNumberOfMoves?: number;
    moveFollowers?: boolean;
    moveLeaders?: boolean;
    piFactor?: number;
}
+

Options for rebalancing the cluster.

+
+
+

Type declaration

+
    +
  • +
    Optional databasesExcluded?: string[]
    +

    A list of database names to exclude from the analysis.

    +

    Default: []

    +
  • +
  • +
    Optional excludeSystemCollections?: boolean
    +

    Ignore system collections in the rebalance plan.

    +

    Default: false

    +
  • +
  • +
    Optional leaderChanges?: boolean
    +

    Allow leader changes without moving data.

    +

    Default: true

    +
  • +
  • +
    Optional maximumNumberOfMoves?: number
    +

    Maximum number of moves to be computed.

    +

    Default: 1000

    +
  • +
  • +
    Optional moveFollowers?: boolean
    +

    Allow moving followers.

    +

    Default: false

    +
  • +
  • +
    Optional moveLeaders?: boolean
    +

    Allow moving leaders.

    +

    Default: false

    +
  • +
  • +
    Optional piFactor?: number
    +

    Default: 256**6

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/database.ClusterRebalanceResult.html b/8.8.0/types/database.ClusterRebalanceResult.html new file mode 100644 index 000000000..e2841668b --- /dev/null +++ b/8.8.0/types/database.ClusterRebalanceResult.html @@ -0,0 +1,135 @@ +ClusterRebalanceResult | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias ClusterRebalanceResult

+
ClusterRebalanceResult: {
    imbalanceAfter: ClusterImbalanceInfo;
    imbalanceBefore: ClusterImbalanceInfo;
    moves: ClusterRebalanceMove[];
}
+
+

Type declaration

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/database.ClusterRebalanceState.html b/8.8.0/types/database.ClusterRebalanceState.html new file mode 100644 index 000000000..ff26946f0 --- /dev/null +++ b/8.8.0/types/database.ClusterRebalanceState.html @@ -0,0 +1,122 @@ +ClusterRebalanceState | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias ClusterRebalanceState

+
ClusterRebalanceState: ClusterImbalanceInfo & {
    pendingMoveShards: number;
    todoMoveShards: number;
}
+

Information about the current state of the cluster imbalance.

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/database.CreateDatabaseOptions.html b/8.8.0/types/database.CreateDatabaseOptions.html new file mode 100644 index 000000000..dfb6aa9ee --- /dev/null +++ b/8.8.0/types/database.CreateDatabaseOptions.html @@ -0,0 +1,147 @@ +CreateDatabaseOptions | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias CreateDatabaseOptions

+
CreateDatabaseOptions: {
    replicationFactor?: "satellite" | number;
    sharding?: "" | "flexible" | "single";
    users?: CreateDatabaseUser[];
    writeConcern?: number;
}
+

Options for creating a database.

+

See createDatabase.

+
+
+

Type declaration

+
    +
  • +
    Optional replicationFactor?: "satellite" | number
    +

    (Cluster only.) Default replication factor for new collections in this +database.

    +

    Setting this to 1 disables replication. Setting this to "satellite" +will replicate to every DBServer.

    +
  • +
  • +
    Optional sharding?: "" | "flexible" | "single"
    +

    (Cluster only.) The sharding method to use for new collections in the +database.

    +
  • +
  • +
    Optional users?: CreateDatabaseUser[]
    +

    Database users to create with the database.

    +
  • +
  • +
    Optional writeConcern?: number
    +

    (Cluster only.) Default write concern for new collections created in this +database.

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/database.CreateDatabaseUser.html b/8.8.0/types/database.CreateDatabaseUser.html new file mode 100644 index 000000000..a53c98f8a --- /dev/null +++ b/8.8.0/types/database.CreateDatabaseUser.html @@ -0,0 +1,143 @@ +CreateDatabaseUser | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias CreateDatabaseUser

+
CreateDatabaseUser: {
    active?: boolean;
    extra?: Record<string, any>;
    passwd?: string;
    username: string;
}
+

Database user to create with a database.

+
+
+

Type declaration

+
    +
  • +
    Optional active?: boolean
    +

    Whether the user is active.

    +

    Default: true

    +
  • +
  • +
    Optional extra?: Record<string, any>
    +

    Additional data to store with the user object.

    +
  • +
  • +
    Optional passwd?: string
    +

    Password of the user to create.

    +

    Default: ""

    +
  • +
  • +
    username: string
    +

    Username of the user to create.

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/database.CreateUserOptions.html b/8.8.0/types/database.CreateUserOptions.html new file mode 100644 index 000000000..a15c0a29a --- /dev/null +++ b/8.8.0/types/database.CreateUserOptions.html @@ -0,0 +1,143 @@ +CreateUserOptions | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias CreateUserOptions

+
CreateUserOptions: {
    active?: boolean;
    extra?: Record<string, any>;
    passwd: string;
    user: string;
}
+

Options for creating an ArangoDB user.

+
+
+

Type declaration

+
    +
  • +
    Optional active?: boolean
    +

    Whether the ArangoDB user account is enabled and can authenticate.

    +

    Default: true

    +
  • +
  • +
    Optional extra?: Record<string, any>
    +

    Additional information to store about this user.

    +

    Default: {}

    +
  • +
  • +
    passwd: string
    +

    Password the ArangoDB user will use for authentication.

    +
  • +
  • +
    user: string
    +

    ArangoDB username of the user.

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/database.DatabaseInfo.html b/8.8.0/types/database.DatabaseInfo.html new file mode 100644 index 000000000..a0168f84f --- /dev/null +++ b/8.8.0/types/database.DatabaseInfo.html @@ -0,0 +1,157 @@ +DatabaseInfo | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias DatabaseInfo

+
DatabaseInfo: {
    id: string;
    isSystem: boolean;
    name: string;
    path: string;
    replicationFactor?: "satellite" | number;
    sharding?: "" | "flexible" | "single";
    writeConcern?: number;
}
+

Object describing a database.

+

See get.

+
+
+

Type declaration

+
    +
  • +
    id: string
    +

    Unique identifier of the database.

    +
  • +
  • +
    isSystem: boolean
    +

    Whether the database is the system database.

    +
  • +
  • +
    name: string
    +

    Name of the database.

    +
  • +
  • +
    path: string
    +

    File system path of the database.

    +
  • +
  • +
    Optional replicationFactor?: "satellite" | number
    +

    (Cluster only.) Default replication factor for new collections in this +database.

    +
  • +
  • +
    Optional sharding?: "" | "flexible" | "single"
    +

    (Cluster only.) The sharding method to use for new collections in the +database.

    +
  • +
  • +
    Optional writeConcern?: number
    +

    (Cluster only.) Default write concern for new collections created in this +database.

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/database.ExplainOptions.html b/8.8.0/types/database.ExplainOptions.html new file mode 100644 index 000000000..093480928 --- /dev/null +++ b/8.8.0/types/database.ExplainOptions.html @@ -0,0 +1,148 @@ +ExplainOptions | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias ExplainOptions

+
ExplainOptions: {
    allPlans?: boolean;
    maxNumberOfPlans?: number;
    optimizer?: {
        rules: string[];
    };
}
+

Options for explaining a query.

+

See explain.

+
+
+

Type declaration

+
    +
  • +
    Optional allPlans?: boolean
    +

    If set to true, all possible execution plans will be returned as the +plans property. Otherwise only the optimal execution plan will be +returned as the plan property.

    +

    Default: false

    +
  • +
  • +
    Optional maxNumberOfPlans?: number
    +

    Maximum number of plans that the optimizer is allowed to generate. +Setting this to a low value limits the amount of work the optimizer does.

    +
  • +
  • +
    Optional optimizer?: {
        rules: string[];
    }
    +

    An object with a rules property specifying a list of optimizer rules to +be included or excluded by the optimizer for this query. Prefix a rule +name with + to include it, or - to exclude it. The name all acts as +an alias matching all optimizer rules.

    +
    +
      +
    • +
      rules: string[]
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/database.ExplainPlan.html b/8.8.0/types/database.ExplainPlan.html new file mode 100644 index 000000000..44b3615ec --- /dev/null +++ b/8.8.0/types/database.ExplainPlan.html @@ -0,0 +1,153 @@ +ExplainPlan | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias ExplainPlan

+
ExplainPlan: {
    collections: {
        name: string;
        type: "read" | "write";
    }[];
    estimatedCost: number;
    estimatedNrItems: number;
    isModificationQuery: boolean;
    nodes: {
        dependencies: number[];
        estimatedCost: number;
        estimatedNrItems: number;
        id: number;
        type: string;
        [key: string]: any;
    }[];
    rules: string[];
    variables: {
        id: number;
        name: string;
    }[];
}
+

Plan explaining query execution.

+
+
+

Type declaration

+
    +
  • +
    collections: {
        name: string;
        type: "read" | "write";
    }[]
    +

    Information about collections involved in the query.

    +
  • +
  • +
    estimatedCost: number
    +

    Total estimated cost of the plan.

    +
  • +
  • +
    estimatedNrItems: number
    +

    Estimated number of items returned by the query.

    +
  • +
  • +
    isModificationQuery: boolean
    +

    Whether the query is a data modification query.

    +
  • +
  • +
    nodes: {
        dependencies: number[];
        estimatedCost: number;
        estimatedNrItems: number;
        id: number;
        type: string;
        [key: string]: any;
    }[]
    +

    Execution nodes in this plan.

    +
  • +
  • +
    rules: string[]
    +

    Rules applied by the optimizer.

    +
  • +
  • +
    variables: {
        id: number;
        name: string;
    }[]
    +

    Variables used in the query.

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/database.ExplainStats.html b/8.8.0/types/database.ExplainStats.html new file mode 100644 index 000000000..1d4cbf329 --- /dev/null +++ b/8.8.0/types/database.ExplainStats.html @@ -0,0 +1,145 @@ +ExplainStats | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias ExplainStats

+
ExplainStats: {
    executionTime: number;
    peakMemoryUsage: number;
    plansCreated: number;
    rulesExecuted: number;
    rulesSkipped: number;
}
+

Optimizer statistics for an explained query.

+
+
+

Type declaration

+
    +
  • +
    executionTime: number
    +

    Time in seconds needed to explain the query.

    +
  • +
  • +
    peakMemoryUsage: number
    +

    Maximum memory usage in bytes of the query during explain.

    +
  • +
  • +
    plansCreated: number
    +

    Total number of plans created.

    +
  • +
  • +
    rulesExecuted: number
    +

    Total number of rules executed for this query.

    +
  • +
  • +
    rulesSkipped: number
    +

    Number of rules skipped for this query.

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/database.HotBackupList.html b/8.8.0/types/database.HotBackupList.html new file mode 100644 index 000000000..d6d58d482 --- /dev/null +++ b/8.8.0/types/database.HotBackupList.html @@ -0,0 +1,129 @@ +HotBackupList | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias HotBackupList

+
HotBackupList: {
    list: Record<string, HotBackupResult & {
        available: boolean;
        countIncludesFilesOnly: boolean;
        keys: any[];
        nrPiecesPresent: number;
        version: string;
    }>;
    server: string;
}
+

(Enterprise Edition only.) List of known hot backups.

+
+
+

Type declaration

+
    +
  • +
    list: Record<string, HotBackupResult & {
        available: boolean;
        countIncludesFilesOnly: boolean;
        keys: any[];
        nrPiecesPresent: number;
        version: string;
    }>
  • +
  • +
    server: string
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/database.HotBackupOptions.html b/8.8.0/types/database.HotBackupOptions.html new file mode 100644 index 000000000..11ab8c1ed --- /dev/null +++ b/8.8.0/types/database.HotBackupOptions.html @@ -0,0 +1,150 @@ +HotBackupOptions | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias HotBackupOptions

+
HotBackupOptions: {
    allowInconsistent?: boolean;
    force?: boolean;
    label?: string;
    timeout?: number;
}
+

(Enterprise Edition only.) Options for creating a hot backup.

+
+
+

Type declaration

+
    +
  • +
    Optional allowInconsistent?: boolean
    +

    If set to true and no global transaction lock can be acquired within the +given timeout, a possibly inconsistent backup is taken.

    +

    Default: false

    +
  • +
  • +
    Optional force?: boolean
    +

    (Enterprise Edition cluster only.) If set to true and no global +transaction lock can be acquired within the given timeout, all running +transactions are forcefully aborted to ensure that a consistent backup +can be created.

    +

    Default: false.

    +
  • +
  • +
    Optional label?: string
    +

    Label to appended to the backup's identifier.

    +

    Default: If omitted or empty, a UUID will be generated.

    +
  • +
  • +
    Optional timeout?: number
    +

    Time in seconds that the operation will attempt to get a consistent +snapshot.

    +

    Default: 120.

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/database.HotBackupResult.html b/8.8.0/types/database.HotBackupResult.html new file mode 100644 index 000000000..48b193a7a --- /dev/null +++ b/8.8.0/types/database.HotBackupResult.html @@ -0,0 +1,137 @@ +HotBackupResult | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias HotBackupResult

+
HotBackupResult: {
    datetime: string;
    id: string;
    nrDBServers: number;
    nrFiles: number;
    potentiallyInconsistent: boolean;
    sizeInBytes: number;
}
+

(Enterprise Edition only.) Result of a hot backup.

+
+
+

Type declaration

+
    +
  • +
    datetime: string
  • +
  • +
    id: string
  • +
  • +
    nrDBServers: number
  • +
  • +
    nrFiles: number
  • +
  • +
    potentiallyInconsistent: boolean
  • +
  • +
    sizeInBytes: number
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/database.InstallServiceOptions.html b/8.8.0/types/database.InstallServiceOptions.html new file mode 100644 index 000000000..d24b623df --- /dev/null +++ b/8.8.0/types/database.InstallServiceOptions.html @@ -0,0 +1,153 @@ +InstallServiceOptions | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias InstallServiceOptions

+
InstallServiceOptions: {
    configuration?: Record<string, any>;
    dependencies?: Record<string, string>;
    development?: boolean;
    legacy?: boolean;
    setup?: boolean;
}
+

Options for installing the service.

+

See installService.

+
+
+

Type declaration

+
    +
  • +
    Optional configuration?: Record<string, any>
    +

    An object mapping configuration option names to values.

    +

    See also getServiceConfiguration.

    +
  • +
  • +
    Optional dependencies?: Record<string, string>
    +

    An object mapping dependency aliases to mount points.

    +

    See also getServiceDependencies.

    +
  • +
  • +
    Optional development?: boolean
    +

    Whether the service should be installed in development mode.

    +

    See also setServiceDevelopmentMode.

    +

    Default: false

    +
  • +
  • +
    Optional legacy?: boolean
    +

    Whether the service should be installed in legacy compatibility mode

    +

    This overrides the engines option in the service manifest (if any).

    +

    Default: false

    +
  • +
  • +
    Optional setup?: boolean
    +

    Whether the "setup" script should be executed.

    +

    Default: true

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/database.LogEntries.html b/8.8.0/types/database.LogEntries.html new file mode 100644 index 000000000..113b344be --- /dev/null +++ b/8.8.0/types/database.LogEntries.html @@ -0,0 +1,137 @@ +LogEntries | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias LogEntries

+
LogEntries: {
    level: LogLevel[];
    lid: number[];
    text: string[];
    timestamp: number[];
    topic: string[];
    totalAmount: number;
}
+

An object representing a list of log entries.

+
+
+

Type declaration

+
    +
  • +
    level: LogLevel[]
  • +
  • +
    lid: number[]
  • +
  • +
    text: string[]
  • +
  • +
    timestamp: number[]
  • +
  • +
    topic: string[]
  • +
  • +
    totalAmount: number
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/database.LogEntriesOptions.html b/8.8.0/types/database.LogEntriesOptions.html new file mode 100644 index 000000000..bc755cb56 --- /dev/null +++ b/8.8.0/types/database.LogEntriesOptions.html @@ -0,0 +1,157 @@ +LogEntriesOptions | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias LogEntriesOptions

+
LogEntriesOptions: {
    level?: LogLevel | LogLevelLabel | Lowercase<LogLevelLabel>;
    offset?: number;
    search?: string;
    size?: number;
    sort?: LogSortDirection;
    start?: number;
    upto?: LogLevel | LogLevelLabel | Lowercase<LogLevelLabel>;
}
+

Options for retrieving log entries.

+
+
+

Type declaration

+
    +
  • +
    Optional level?: LogLevel | LogLevelLabel | Lowercase<LogLevelLabel>
    +

    If set, only log entries with this log level will be returned.

    +
  • +
  • +
    Optional offset?: number
    +

    If set, this many log entries will be skipped.

    +
  • +
  • +
    Optional search?: string
    +

    If set, only log entries containing the specified text will be returned.

    +
  • +
  • +
    Optional size?: number
    +

    If set, only this many entries will be returned.

    +
  • +
  • +
    Optional sort?: LogSortDirection
    +

    If set to "desc", log entries will be returned in reverse chronological +order.

    +

    Default: "asc".

    +
  • +
  • +
    Optional start?: number
    +

    If set, only log entries with an lid greater than or equal to this value +will be returned.

    +
  • +
  • +
    Optional upto?: LogLevel | LogLevelLabel | Lowercase<LogLevelLabel>
    +

    Maximum log level of the entries to retrieve.

    +

    Default: INFO.

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/database.LogLevelLabel.html b/8.8.0/types/database.LogLevelLabel.html new file mode 100644 index 000000000..8b80483e1 --- /dev/null +++ b/8.8.0/types/database.LogLevelLabel.html @@ -0,0 +1,122 @@ +LogLevelLabel | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias LogLevelLabel

+
LogLevelLabel: "FATAL" | "ERROR" | "WARNING" | "INFO" | "DEBUG"
+

String representation of the logging level of a log entry.

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/database.LogLevelSetting.html b/8.8.0/types/database.LogLevelSetting.html new file mode 100644 index 000000000..2a0a94d53 --- /dev/null +++ b/8.8.0/types/database.LogLevelSetting.html @@ -0,0 +1,122 @@ +LogLevelSetting | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias LogLevelSetting

+
LogLevelSetting: LogLevelLabel | "DEFAULT"
+

Logging level setting.

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/database.LogMessage.html b/8.8.0/types/database.LogMessage.html new file mode 100644 index 000000000..f9cfd0779 --- /dev/null +++ b/8.8.0/types/database.LogMessage.html @@ -0,0 +1,135 @@ +LogMessage | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias LogMessage

+
LogMessage: {
    date: string;
    id: number;
    level: LogLevelLabel;
    message: string;
    topic: string;
}
+

An object representing a single log entry.

+
+
+

Type declaration

+
    +
  • +
    date: string
  • +
  • +
    id: number
  • +
  • +
    level: LogLevelLabel
  • +
  • +
    message: string
  • +
  • +
    topic: string
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/database.LogSortDirection.html b/8.8.0/types/database.LogSortDirection.html new file mode 100644 index 000000000..97b0333f3 --- /dev/null +++ b/8.8.0/types/database.LogSortDirection.html @@ -0,0 +1,122 @@ +LogSortDirection | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias LogSortDirection

+
LogSortDirection: "asc" | "desc"
+

Log sorting direction, ascending or descending.

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/database.MultiExplainResult.html b/8.8.0/types/database.MultiExplainResult.html new file mode 100644 index 000000000..47fc15dd5 --- /dev/null +++ b/8.8.0/types/database.MultiExplainResult.html @@ -0,0 +1,141 @@ +MultiExplainResult | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias MultiExplainResult

+
MultiExplainResult: {
    cacheable: boolean;
    plans: ExplainPlan[];
    stats: ExplainStats;
    warnings: {
        code: number;
        message: string;
    }[];
}
+

Result of explaining a query with multiple plans.

+
+
+

Type declaration

+
    +
  • +
    cacheable: boolean
    +

    Whether it would be possible to cache the query.

    +
  • +
  • +
    plans: ExplainPlan[]
    +

    Query plans.

    +
  • +
  • +
    stats: ExplainStats
    +

    Optimizer statistics for the explained query.

    +
  • +
  • +
    warnings: {
        code: number;
        message: string;
    }[]
    +

    Warnings encountered while planning the query execution.

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/database.MultiServiceDependency.html b/8.8.0/types/database.MultiServiceDependency.html new file mode 100644 index 000000000..ade50069f --- /dev/null +++ b/8.8.0/types/database.MultiServiceDependency.html @@ -0,0 +1,154 @@ +MultiServiceDependency | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias MultiServiceDependency

+
MultiServiceDependency: {
    current?: string[];
    description?: string;
    multiple: true;
    name: string;
    required: boolean;
    title: string;
    version: string;
}
+

Object describing a multi-service dependency defined by a Foxx service.

+
+
+

Type declaration

+
    +
  • +
    Optional current?: string[]
    +

    Current mount points the dependency is resolved to.

    +
  • +
  • +
    Optional description?: string
    +

    Human-readable description of the dependency.

    +
  • +
  • +
    multiple: true
    +

    Whether this is a multi-service dependency.

    +
  • +
  • +
    name: string
    +

    Name of the service the dependency expects to match.

    +
  • +
  • +
    required: boolean
    +

    Whether the dependency must be matched in order for the service +to be operational.

    +
  • +
  • +
    title: string
    +

    Formatted name of the dependency.

    +
  • +
  • +
    version: string
    +

    Version of the service the dependency expects to match.

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/database.ParseResult.html b/8.8.0/types/database.ParseResult.html new file mode 100644 index 000000000..2150b2b85 --- /dev/null +++ b/8.8.0/types/database.ParseResult.html @@ -0,0 +1,141 @@ +ParseResult | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias ParseResult

+
ParseResult: {
    ast: AstNode[];
    bindVars: string[];
    collections: string[];
    parsed: boolean;
}
+

Result of parsing a query.

+
+
+

Type declaration

+
    +
  • +
    ast: AstNode[]
    +

    Abstract syntax tree (AST) of the query.

    +
  • +
  • +
    bindVars: string[]
    +

    Names of all bind parameters used in the query.

    +
  • +
  • +
    collections: string[]
    +

    Names of all collections involved in the query.

    +
  • +
  • +
    parsed: boolean
    +

    Whether the query was parsed.

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/database.QueryInfo.html b/8.8.0/types/database.QueryInfo.html new file mode 100644 index 000000000..0c4203de3 --- /dev/null +++ b/8.8.0/types/database.QueryInfo.html @@ -0,0 +1,165 @@ +QueryInfo | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias QueryInfo

+
QueryInfo: {
    bindVars: Record<string, any>;
    database: string;
    id: string;
    peakMemoryUsage: number;
    query: string;
    runTime: number;
    started: string;
    state: "executing" | "finished" | "killed";
    stream: boolean;
    user: string;
}
+

Object describing a query.

+
+
+

Type declaration

+
    +
  • +
    bindVars: Record<string, any>
    +

    Bind parameters used in the query.

    +
  • +
  • +
    database: string
    +

    Name of the database the query runs in.

    +
  • +
  • +
    id: string
    +

    Unique identifier for this query.

    +
  • +
  • +
    peakMemoryUsage: number
    +

    Maximum memory usage in bytes of the query.

    +
  • +
  • +
    query: string
    +

    Query string (potentially truncated).

    +
  • +
  • +
    runTime: number
    +

    Query's running time in seconds.

    +
  • +
  • +
    started: string
    +

    Date and time the query was started.

    +
  • +
  • +
    state: "executing" | "finished" | "killed"
    +

    Query's current execution state.

    +
  • +
  • +
    stream: boolean
    +

    Whether the query uses a streaming cursor.

    +
  • +
  • +
    user: string
    +

    Name of the user that started the query.

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/database.QueryOptimizerRule.html b/8.8.0/types/database.QueryOptimizerRule.html new file mode 100644 index 000000000..615ad10f9 --- /dev/null +++ b/8.8.0/types/database.QueryOptimizerRule.html @@ -0,0 +1,142 @@ +QueryOptimizerRule | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias QueryOptimizerRule

+
QueryOptimizerRule: {
    flags: {
        canBeDisabled: boolean;
        canCreateAdditionalPlans: boolean;
        clusterOnly: boolean;
        disabledByDefault: boolean;
        enterpriseOnly: boolean;
        hidden: boolean;
    };
    name: string;
}
+

Optimizer rule for AQL queries.

+
+
+

Type declaration

+
    +
  • +
    flags: {
        canBeDisabled: boolean;
        canCreateAdditionalPlans: boolean;
        clusterOnly: boolean;
        disabledByDefault: boolean;
        enterpriseOnly: boolean;
        hidden: boolean;
    }
    +
      +
    • +
      canBeDisabled: boolean
    • +
    • +
      canCreateAdditionalPlans: boolean
    • +
    • +
      clusterOnly: boolean
    • +
    • +
      disabledByDefault: boolean
    • +
    • +
      enterpriseOnly: boolean
    • +
    • +
      hidden: boolean
  • +
  • +
    name: string
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/database.QueryOptions.html b/8.8.0/types/database.QueryOptions.html new file mode 100644 index 000000000..54bc8fc1a --- /dev/null +++ b/8.8.0/types/database.QueryOptions.html @@ -0,0 +1,278 @@ +QueryOptions | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias QueryOptions

+
QueryOptions: {
    allowDirtyRead?: boolean;
    allowRetry?: boolean;
    batchSize?: number;
    cache?: boolean;
    count?: boolean;
    failOnWarning?: boolean;
    fillBlockCache?: boolean;
    fullCount?: boolean;
    intermediateCommitCount?: number;
    intermediateCommitSize?: number;
    maxNodesPerCallstack?: number;
    maxPlans?: number;
    maxRuntime?: number;
    maxTransactionSize?: number;
    maxWarningsCount?: number;
    memoryLimit?: number;
    optimizer?: {
        rules: string[];
    };
    profile?: boolean | number;
    retryOnConflict?: number;
    satelliteSyncWait?: number;
    skipInaccessibleCollections?: boolean;
    stream?: boolean;
    timeout?: number;
    ttl?: number;
}
+

Options for executing a query.

+

See query.

+
+
+

Type declaration

+
    +
  • +
    Optional allowDirtyRead?: boolean
    +

    If set to true, the query will be executed with support for dirty reads +enabled, permitting ArangoDB to return a potentially dirty or stale result +and arangojs will load balance the request without distinguishing between +leaders and followers.

    +

    Note that dirty reads are only supported for read-only queries, not data +modification queries (e.g. using INSERT, UPDATE, REPLACE or +REMOVE) and only when using ArangoDB 3.4 or later.

    +

    Default: false

    +
  • +
  • +
    Optional allowRetry?: boolean
    +

    If set to true, cursor results will be stored by ArangoDB in such a way +that batch reads can be retried in the case of a communication error.

    +

    Default: false

    +
  • +
  • +
    Optional batchSize?: number
    +

    Number of result values to be transferred by the server in each +network roundtrip (or "batch").

    +

    Must be greater than zero.

    +
  • +
  • +
    Optional cache?: boolean
    +

    If set to false, the AQL query results cache lookup will be skipped for +this query.

    +

    Default: true

    +
  • +
  • +
    Optional count?: boolean
    +

    Unless set to false, the number of result values in the result set will +be returned in the count attribute. This may be disabled by default in +a future version of ArangoDB if calculating this value has a performance +impact for some queries.

    +

    Default: true.

    +
  • +
  • +
    Optional failOnWarning?: boolean
    +

    If set to true, the query will throw an exception and abort if it would + otherwise produce a warning.

    +
  • +
  • +
    Optional fillBlockCache?: boolean
    +

    If set to false, the query data will not be stored in the RocksDB block +cache. This can be used to avoid thrashing he block cache when reading a +lot of data.

    +
  • +
  • +
    Optional fullCount?: boolean
    +

    If set to true and the query has a LIMIT clause, the total number of +values matched before the last top-level LIMIT in the query was applied +will be returned in the extra.stats.fullCount attribute.

    +
  • +
  • +
    Optional intermediateCommitCount?: number
    +

    (RocksDB only.) Maximum number of operations after which an intermediate +commit is automatically performed.

    +
  • +
  • +
    Optional intermediateCommitSize?: number
    +

    (RocksDB only.) Maximum total size of operations in bytes after which an +intermediate commit is automatically performed.

    +
  • +
  • +
    Optional maxNodesPerCallstack?: number
    +

    Controls after how many execution nodes in a query a stack split should be +performed.

    +

    Default: 250 (200 on macOS)

    +
  • +
  • +
    Optional maxPlans?: number
    +

    Limits the maximum number of plans that will be created by the AQL query +optimizer.

    +
  • +
  • +
    Optional maxRuntime?: number
    +

    Maximum allowed execution time before the query will be killed in seconds.

    +

    If set to 0, the query will be allowed to run indefinitely.

    +

    Default: 0

    +
  • +
  • +
    Optional maxTransactionSize?: number
    +

    (RocksDB only.) Maximum size of transactions in bytes.

    +
  • +
  • +
    Optional maxWarningsCount?: number
    +

    Limits the maximum number of warnings a query will return.

    +
  • +
  • +
    Optional memoryLimit?: number
    +

    Maximum memory size in bytes that the query is allowed to use. +Exceeding this value will result in the query failing with an error.

    +

    If set to 0, the memory limit is disabled.

    +

    Default: 0

    +
  • +
  • +
    Optional optimizer?: {
        rules: string[];
    }
    +

    An object with a rules property specifying a list of optimizer rules to +be included or excluded by the optimizer for this query. Prefix a rule +name with + to include it, or - to exclude it. The name all acts as +an alias matching all optimizer rules.

    +
    +
      +
    • +
      rules: string[]
  • +
  • +
    Optional profile?: boolean | number
    +

    If set to 1 or true, additional query profiling information will be +returned in the extra.profile attribute if the query is not served from +the result cache.

    +

    If set to 2, the query will return execution stats per query plan node +in the extra.stats.nodes attribute. Additionally the query plan is +returned in extra.plan.

    +
  • +
  • +
    Optional retryOnConflict?: number
    +

    If set to a positive number, the query will automatically be retried at +most this many times if it results in a write-write conflict.

    +

    Default: 0

    +
  • +
  • +
    Optional satelliteSyncWait?: number
    +

    (Enterprise Edition cluster only.) Limits the maximum time in seconds a +DBServer will wait to bring satellite collections involved in the query +into sync. Exceeding this value will result in the query being stopped.

    +

    Default: 60

    +
  • +
  • +
    Optional skipInaccessibleCollections?: boolean
    +

    (Enterprise Edition cluster only.) If set to true, collections +inaccessible to current user will result in an access error instead +of being treated as empty.

    +
  • +
  • +
    Optional stream?: boolean
    +

    If set to true, the query will be executed as a streaming query.

    +
  • +
  • +
    Optional timeout?: number
    +

    Maximum time in milliseconds arangojs will wait for a server response. +Exceeding this value will result in the request being cancelled.

    +

    Note: Setting a timeout for the client does not guarantee the query +will be killed by ArangoDB if it is already being executed. See the +maxRuntime option for limiting the execution time within ArangoDB.

    +
  • +
  • +
    Optional ttl?: number
    +

    Time-to-live for the cursor in seconds. The cursor results may be +garbage collected by ArangoDB after this much time has passed.

    +

    Default: 30

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/database.QueryTracking.html b/8.8.0/types/database.QueryTracking.html new file mode 100644 index 000000000..a6516dfe9 --- /dev/null +++ b/8.8.0/types/database.QueryTracking.html @@ -0,0 +1,150 @@ +QueryTracking | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias QueryTracking

+
QueryTracking: {
    enabled: boolean;
    maxQueryStringLength: number;
    maxSlowQueries: number;
    slowQueryThreshold: number;
    trackBindVars: boolean;
    trackSlowQueries: boolean;
}
+

Information about query tracking.

+
+
+

Type declaration

+
    +
  • +
    enabled: boolean
    +

    Whether query tracking is enabled.

    +
  • +
  • +
    maxQueryStringLength: number
    +

    Maximum query string length in bytes that is kept in the list.

    +
  • +
  • +
    maxSlowQueries: number
    +

    Maximum number of slow queries that is kept in the list.

    +
  • +
  • +
    slowQueryThreshold: number
    +

    Threshold execution time in seconds for when a query is +considered slow.

    +
  • +
  • +
    trackBindVars: boolean
    +

    Whether bind parameters are being tracked along with queries.

    +
  • +
  • +
    trackSlowQueries: boolean
    +

    Whether slow queries are being tracked.

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/database.QueryTrackingOptions.html b/8.8.0/types/database.QueryTrackingOptions.html new file mode 100644 index 000000000..7a0b6fc6e --- /dev/null +++ b/8.8.0/types/database.QueryTrackingOptions.html @@ -0,0 +1,152 @@ +QueryTrackingOptions | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias QueryTrackingOptions

+
QueryTrackingOptions: {
    enabled?: boolean;
    maxQueryStringLength?: number;
    maxSlowQueries?: number;
    slowQueryThreshold?: number;
    trackBindVars?: boolean;
    trackSlowQueries?: boolean;
}
+

Options for query tracking.

+

See queryTracking.

+
+
+

Type declaration

+
    +
  • +
    Optional enabled?: boolean
    +

    If set to false, neither queries nor slow queries will be tracked.

    +
  • +
  • +
    Optional maxQueryStringLength?: number
    +

    Maximum query string length in bytes that will be kept in the list.

    +
  • +
  • +
    Optional maxSlowQueries?: number
    +

    Maximum number of slow queries to be kept in the list.

    +
  • +
  • +
    Optional slowQueryThreshold?: number
    +

    Threshold execution time in seconds for when a query will be +considered slow.

    +
  • +
  • +
    Optional trackBindVars?: boolean
    +

    If set to true, bind parameters will be tracked along with queries.

    +
  • +
  • +
    Optional trackSlowQueries?: boolean
    +

    If set to true and enabled is also set to true, slow queries will be +tracked if their execution time exceeds slowQueryThreshold.

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/database.QueueTimeMetrics.html b/8.8.0/types/database.QueueTimeMetrics.html new file mode 100644 index 000000000..daf8b9ae0 --- /dev/null +++ b/8.8.0/types/database.QueueTimeMetrics.html @@ -0,0 +1,159 @@ +QueueTimeMetrics | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias QueueTimeMetrics

+
QueueTimeMetrics: {
    getAvg: (() => number);
    getLatest: (() => number | undefined);
    getValues: (() => [number, number][]);
}
+

An object providing methods for accessing queue time metrics of the most +recently received server responses if the server supports this feature.

+
+
+

Type declaration

+
    +
  • +
    getAvg: (() => number)
    +
      +
    • +
        +
      • (): number
      • +
      • +

        Returns the average queue time of the most recently received responses +in seconds.

        +
        +

        Returns number

  • +
  • +
    getLatest: (() => number | undefined)
    +
      +
    • +
        +
      • (): number | undefined
      • +
      • +

        Returns the queue time of the most recently received response in seconds.

        +
        +

        Returns number | undefined

  • +
  • +
    getValues: (() => [number, number][])
    +
      +
    • +
        +
      • (): [number, number][]
      • +
      • +

        Returns a list of the most recently received queue time values as tuples +of the timestamp of the response being processed in milliseconds and the +queue time in seconds.

        +
        +

        Returns [number, number][]

+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/database.ReplaceServiceOptions.html b/8.8.0/types/database.ReplaceServiceOptions.html new file mode 100644 index 000000000..e1cc6fbaf --- /dev/null +++ b/8.8.0/types/database.ReplaceServiceOptions.html @@ -0,0 +1,165 @@ +ReplaceServiceOptions | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias ReplaceServiceOptions

+
ReplaceServiceOptions: {
    configuration?: Record<string, any>;
    dependencies?: Record<string, string>;
    development?: boolean;
    force?: boolean;
    legacy?: boolean;
    setup?: boolean;
    teardown?: boolean;
}
+

Options for replacing a service.

+

See replaceService.

+
+
+

Type declaration

+
    +
  • +
    Optional configuration?: Record<string, any>
    +

    An object mapping configuration option names to values.

    +

    See also getServiceConfiguration.

    +
  • +
  • +
    Optional dependencies?: Record<string, string>
    +

    An object mapping dependency aliases to mount points.

    +

    See also getServiceDependencies.

    +
  • +
  • +
    Optional development?: boolean
    +

    Whether the service should be installed in development mode.

    +

    See also setServiceDevelopmentMode.

    +

    Default: false

    +
  • +
  • +
    Optional force?: boolean
    +

    If set to true, replacing a service that does not already exist will +fall back to installing the new service.

    +

    Default: false

    +
  • +
  • +
    Optional legacy?: boolean
    +

    Whether the service should be installed in legacy compatibility mode

    +

    This overrides the engines option in the service manifest (if any).

    +

    Default: false

    +
  • +
  • +
    Optional setup?: boolean
    +

    Whether the "setup" script should be executed.

    +

    Default: true

    +
  • +
  • +
    Optional teardown?: boolean
    +

    Whether the existing service's "teardown" script should be executed +prior to removing that service.

    +

    Default: true

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/database.ServiceConfiguration.html b/8.8.0/types/database.ServiceConfiguration.html new file mode 100644 index 000000000..075b6835d --- /dev/null +++ b/8.8.0/types/database.ServiceConfiguration.html @@ -0,0 +1,159 @@ +ServiceConfiguration | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias ServiceConfiguration

+
ServiceConfiguration: {
    current: any;
    currentRaw: any;
    default?: any;
    description?: string;
    required: boolean;
    title: string;
    type: "integer" | "boolean" | "string" | "number" | "json" | "password" | "int" | "bool";
}
+

Object describing a configuration option of a Foxx service.

+
+
+

Type declaration

+
    +
  • +
    current: any
    +

    Processed current value of the configuration option as exposed in the +service code.

    +
  • +
  • +
    currentRaw: any
    +

    Current value of the configuration option as stored internally.

    +
  • +
  • +
    Optional default?: any
    +

    Default value of the configuration option.

    +
  • +
  • +
    Optional description?: string
    +

    Human-readable description of the configuration option.

    +
  • +
  • +
    required: boolean
    +

    Whether the configuration option must be set in order for the service +to be operational.

    +
  • +
  • +
    title: string
    +

    Formatted name of the configuration option.

    +
  • +
  • +
    type: "integer" | "boolean" | "string" | "number" | "json" | "password" | "int" | "bool"
    +

    Data type of the configuration value.

    +

    Note: "int" and "bool" are historical synonyms for "integer" and +"boolean". The "password" type is synonymous with "string" but can +be used to distinguish values which should not be displayed in plain text +by software when managing the service.

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/database.ServiceInfo.html b/8.8.0/types/database.ServiceInfo.html new file mode 100644 index 000000000..e72b1a4f1 --- /dev/null +++ b/8.8.0/types/database.ServiceInfo.html @@ -0,0 +1,170 @@ +ServiceInfo | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias ServiceInfo

+
ServiceInfo: {
    checksum: string;
    development: boolean;
    legacy: boolean;
    manifest: FoxxManifest;
    mount: string;
    name?: string;
    options: {
        configuration: Record<string, any>;
        dependencies: Record<string, string>;
    };
    path: string;
    version?: string;
}
+

Object describing a Foxx service in detail.

+
+
+

Type declaration

+
    +
  • +
    checksum: string
    +

    Internal checksum of the service's initial source bundle.

    +
  • +
  • +
    development: boolean
    +

    Whether development mode is enabled for this service.

    +
  • +
  • +
    legacy: boolean
    +

    Whether the service is running in legacy compatibility mode.

    +
  • +
  • +
    manifest: FoxxManifest
    +

    Content of the service manifest of this service.

    +
  • +
  • +
    mount: string
    +

    Service mount point, relative to the database.

    +
  • +
  • +
    Optional name?: string
    +

    Name defined in the service manifest.

    +
  • +
  • +
    options: {
        configuration: Record<string, any>;
        dependencies: Record<string, string>;
    }
    +

    Options for this service.

    +
    +
      +
    • +
      configuration: Record<string, any>
      +

      Configuration values set for this service.

      +
    • +
    • +
      dependencies: Record<string, string>
      +

      Service dependency configuration of this service.

      +
  • +
  • +
    path: string
    +

    File system path of the service.

    +
  • +
  • +
    Optional version?: string
    +

    Version defined in the service manifest.

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/database.ServiceSummary.html b/8.8.0/types/database.ServiceSummary.html new file mode 100644 index 000000000..9452d44f1 --- /dev/null +++ b/8.8.0/types/database.ServiceSummary.html @@ -0,0 +1,150 @@ +ServiceSummary | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias ServiceSummary

+
ServiceSummary: {
    development: boolean;
    legacy: boolean;
    mount: string;
    name?: string;
    provides: Record<string, string>;
    version?: string;
}
+

Object briefly describing a Foxx service.

+
+
+

Type declaration

+
    +
  • +
    development: boolean
    +

    Whether development mode is enabled for this service.

    +
  • +
  • +
    legacy: boolean
    +

    Whether the service is running in legacy compatibility mode.

    +
  • +
  • +
    mount: string
    +

    Service mount point, relative to the database.

    +
  • +
  • +
    Optional name?: string
    +

    Name defined in the service manifest.

    +
  • +
  • +
    provides: Record<string, string>
    +

    Service dependencies the service expects to be able to match as a mapping +from dependency names to versions the service is compatible with.

    +
  • +
  • +
    Optional version?: string
    +

    Version defined in the service manifest.

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/database.ServiceTestDefaultReport.html b/8.8.0/types/database.ServiceTestDefaultReport.html new file mode 100644 index 000000000..884b9c1b0 --- /dev/null +++ b/8.8.0/types/database.ServiceTestDefaultReport.html @@ -0,0 +1,135 @@ +ServiceTestDefaultReport | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias ServiceTestDefaultReport

+
ServiceTestDefaultReport: {
    failures: ServiceTestDefaultTest[];
    passes: ServiceTestDefaultTest[];
    pending: ServiceTestDefaultTest[];
    stats: ServiceTestStats;
    tests: ServiceTestDefaultTest[];
}
+

Test results for a Foxx service's tests using the default reporter.

+
+
+

Type declaration

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/database.ServiceTestDefaultTest.html b/8.8.0/types/database.ServiceTestDefaultTest.html new file mode 100644 index 000000000..e8df2e30f --- /dev/null +++ b/8.8.0/types/database.ServiceTestDefaultTest.html @@ -0,0 +1,133 @@ +ServiceTestDefaultTest | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias ServiceTestDefaultTest

+
ServiceTestDefaultTest: {
    duration: number;
    err?: string;
    fullTitle: string;
    title: string;
}
+

Test results for a single test case using the default reporter.

+
+
+

Type declaration

+
    +
  • +
    duration: number
  • +
  • +
    Optional err?: string
  • +
  • +
    fullTitle: string
  • +
  • +
    title: string
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/database.ServiceTestStats.html b/8.8.0/types/database.ServiceTestStats.html new file mode 100644 index 000000000..d3cd305bc --- /dev/null +++ b/8.8.0/types/database.ServiceTestStats.html @@ -0,0 +1,145 @@ +ServiceTestStats | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias ServiceTestStats

+
ServiceTestStats: {
    duration: number;
    failures: number;
    passes: number;
    pending: number;
    tests: number;
}
+

Test stats for a Foxx service's tests.

+
+
+

Type declaration

+
    +
  • +
    duration: number
    +

    Total test duration in milliseconds.

    +
  • +
  • +
    failures: number
    +

    Number of tests that failed.

    +
  • +
  • +
    passes: number
    +

    Number of tests that ran successfully.

    +
  • +
  • +
    pending: number
    +

    Number of tests skipped or not executed.

    +
  • +
  • +
    tests: number
    +

    Total number of tests found.

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/database.ServiceTestStreamReport.html b/8.8.0/types/database.ServiceTestStreamReport.html new file mode 100644 index 000000000..43f0ab719 --- /dev/null +++ b/8.8.0/types/database.ServiceTestStreamReport.html @@ -0,0 +1,122 @@ +ServiceTestStreamReport | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias ServiceTestStreamReport

+
ServiceTestStreamReport: (["start", {
    total: number;
}] | ["pass", ServiceTestStreamTest] | ["fail", ServiceTestStreamTest] | ["end", ServiceTestStats])[]
+

Test results for a Foxx service's tests using the stream reporter.

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/database.ServiceTestStreamTest.html b/8.8.0/types/database.ServiceTestStreamTest.html new file mode 100644 index 000000000..fe03a9346 --- /dev/null +++ b/8.8.0/types/database.ServiceTestStreamTest.html @@ -0,0 +1,133 @@ +ServiceTestStreamTest | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias ServiceTestStreamTest

+
ServiceTestStreamTest: {
    duration: number;
    err?: string;
    fullTitle: string;
    title: string;
}
+

Test results for a single test case using the stream reporter.

+
+
+

Type declaration

+
    +
  • +
    duration: number
  • +
  • +
    Optional err?: string
  • +
  • +
    fullTitle: string
  • +
  • +
    title: string
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/database.ServiceTestSuite.html b/8.8.0/types/database.ServiceTestSuite.html new file mode 100644 index 000000000..cacf9922b --- /dev/null +++ b/8.8.0/types/database.ServiceTestSuite.html @@ -0,0 +1,131 @@ +ServiceTestSuite | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias ServiceTestSuite

+
ServiceTestSuite: {
    suites: ServiceTestSuite[];
    tests: ServiceTestSuiteTest[];
    title: string;
}
+

Test results for a single test suite using the suite reporter.

+
+
+

Type declaration

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/database.ServiceTestSuiteReport.html b/8.8.0/types/database.ServiceTestSuiteReport.html new file mode 100644 index 000000000..8e994e572 --- /dev/null +++ b/8.8.0/types/database.ServiceTestSuiteReport.html @@ -0,0 +1,131 @@ +ServiceTestSuiteReport | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias ServiceTestSuiteReport

+
ServiceTestSuiteReport: {
    stats: ServiceTestStats;
    suites: ServiceTestSuite[];
    tests: ServiceTestSuiteTest[];
}
+

Test results for a Foxx service's tests using the suite reporter.

+
+
+

Type declaration

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/database.ServiceTestSuiteTest.html b/8.8.0/types/database.ServiceTestSuiteTest.html new file mode 100644 index 000000000..14206dc7d --- /dev/null +++ b/8.8.0/types/database.ServiceTestSuiteTest.html @@ -0,0 +1,133 @@ +ServiceTestSuiteTest | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias ServiceTestSuiteTest

+
ServiceTestSuiteTest: {
    duration: number;
    err?: any;
    result: "pending" | "pass" | "fail";
    title: string;
}
+

Test results for a single test case using the suite reporter.

+
+
+

Type declaration

+
    +
  • +
    duration: number
  • +
  • +
    Optional err?: any
  • +
  • +
    result: "pending" | "pass" | "fail"
  • +
  • +
    title: string
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/database.ServiceTestTapReport.html b/8.8.0/types/database.ServiceTestTapReport.html new file mode 100644 index 000000000..616bbb043 --- /dev/null +++ b/8.8.0/types/database.ServiceTestTapReport.html @@ -0,0 +1,122 @@ +ServiceTestTapReport | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias ServiceTestTapReport

+
ServiceTestTapReport: string[]
+

Test results for a Foxx service's tests in TAP format.

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/database.ServiceTestXunitReport.html b/8.8.0/types/database.ServiceTestXunitReport.html new file mode 100644 index 000000000..1150b52ce --- /dev/null +++ b/8.8.0/types/database.ServiceTestXunitReport.html @@ -0,0 +1,123 @@ +ServiceTestXunitReport | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias ServiceTestXunitReport

+
ServiceTestXunitReport: ["testsuite", {
    errors: number;
    failures: number;
    skip: number;
    tests: number;
    time: number;
    timestamp: number;
}, ...ServiceTestXunitTest[]]
+

Test results for a Foxx service's tests in XUnit format using the JSONML +representation.

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/database.ServiceTestXunitTest.html b/8.8.0/types/database.ServiceTestXunitTest.html new file mode 100644 index 000000000..05420cff7 --- /dev/null +++ b/8.8.0/types/database.ServiceTestXunitTest.html @@ -0,0 +1,123 @@ +ServiceTestXunitTest | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias ServiceTestXunitTest

+
ServiceTestXunitTest: ["testcase", {
    classname: string;
    name: string;
    time: number;
}] | ["testcase", {
    classname: string;
    name: string;
    time: number;
}, ["failure", {
    message: string;
    type: string;
}, string]]
+

Test results for a single test case in XUnit format using the JSONML +representation.

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/database.SingleExplainResult.html b/8.8.0/types/database.SingleExplainResult.html new file mode 100644 index 000000000..e09d6e483 --- /dev/null +++ b/8.8.0/types/database.SingleExplainResult.html @@ -0,0 +1,141 @@ +SingleExplainResult | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias SingleExplainResult

+
SingleExplainResult: {
    cacheable: boolean;
    plan: ExplainPlan;
    stats: ExplainStats;
    warnings: {
        code: number;
        message: string;
    }[];
}
+

Result of explaining a query with a single plan.

+
+
+

Type declaration

+
    +
  • +
    cacheable: boolean
    +

    Whether it would be possible to cache the query.

    +
  • +
  • +
    plan: ExplainPlan
    +

    Query plan.

    +
  • +
  • +
    stats: ExplainStats
    +

    Optimizer statistics for the explained query.

    +
  • +
  • +
    warnings: {
        code: number;
        message: string;
    }[]
    +

    Warnings encountered while planning the query execution.

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/database.SingleServiceDependency.html b/8.8.0/types/database.SingleServiceDependency.html new file mode 100644 index 000000000..f9d8aefe1 --- /dev/null +++ b/8.8.0/types/database.SingleServiceDependency.html @@ -0,0 +1,154 @@ +SingleServiceDependency | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias SingleServiceDependency

+
SingleServiceDependency: {
    current?: string;
    description?: string;
    multiple: false;
    name: string;
    required: boolean;
    title: string;
    version: string;
}
+

Object describing a single-service dependency defined by a Foxx service.

+
+
+

Type declaration

+
    +
  • +
    Optional current?: string
    +

    Current mount point the dependency is resolved to.

    +
  • +
  • +
    Optional description?: string
    +

    Human-readable description of the dependency.

    +
  • +
  • +
    multiple: false
    +

    Whether this is a multi-service dependency.

    +
  • +
  • +
    name: string
    +

    Name of the service the dependency expects to match.

    +
  • +
  • +
    required: boolean
    +

    Whether the dependency must be matched in order for the service +to be operational.

    +
  • +
  • +
    title: string
    +

    Formatted name of the dependency.

    +
  • +
  • +
    version: string
    +

    Version of the service the dependency expects to match.

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/database.SwaggerJson.html b/8.8.0/types/database.SwaggerJson.html new file mode 100644 index 000000000..93cc0d4b0 --- /dev/null +++ b/8.8.0/types/database.SwaggerJson.html @@ -0,0 +1,143 @@ +SwaggerJson | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias SwaggerJson

+
SwaggerJson: {
    info: {
        description: string;
        license: string;
        title: string;
        version: string;
    };
    path: {
        [key: string]: any;
    };
    [key: string]: any;
}
+

OpenAPI 2.0 description of a Foxx service.

+
+
+

Type declaration

+
    +
  • +
    [key: string]: any
  • +
  • +
    info: {
        description: string;
        license: string;
        title: string;
        version: string;
    }
    +
      +
    • +
      description: string
    • +
    • +
      license: string
    • +
    • +
      title: string
    • +
    • +
      version: string
  • +
  • +
    path: {
        [key: string]: any;
    }
    +
      +
    • +
      [key: string]: any
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/database.TransactionCollections.html b/8.8.0/types/database.TransactionCollections.html new file mode 100644 index 000000000..0652d3f7c --- /dev/null +++ b/8.8.0/types/database.TransactionCollections.html @@ -0,0 +1,141 @@ +TransactionCollections | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias TransactionCollections

+
TransactionCollections: {
    exclusive?: (string | ArangoCollection)[] | string | ArangoCollection;
    read?: (string | ArangoCollection)[] | string | ArangoCollection;
    write?: (string | ArangoCollection)[] | string | ArangoCollection;
}
+

Collections involved in a transaction.

+
+
+

Type declaration

+
    +
  • +
    Optional exclusive?: (string | ArangoCollection)[] | string | ArangoCollection
    +

    An array of collections or a single collection that will be read from or +written to during the transaction with no other writes being able to run +in parallel.

    +
  • +
  • +
    Optional read?: (string | ArangoCollection)[] | string | ArangoCollection
    +

    An array of collections or a single collection that will be read from +during the transaction.

    +
  • +
  • +
    Optional write?: (string | ArangoCollection)[] | string | ArangoCollection
    +

    An array of collections or a single collection that will be read from or +written to during the transaction.

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/database.TransactionDetails.html b/8.8.0/types/database.TransactionDetails.html new file mode 100644 index 000000000..eb6d8bfaf --- /dev/null +++ b/8.8.0/types/database.TransactionDetails.html @@ -0,0 +1,134 @@ +TransactionDetails | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias TransactionDetails

+
TransactionDetails: {
    id: string;
    state: "running" | "committed" | "aborted";
}
+

Details for a transaction.

+

See also TransactionStatus.

+
+
+

Type declaration

+
    +
  • +
    id: string
    +

    Unique identifier of the transaction.

    +
  • +
  • +
    state: "running" | "committed" | "aborted"
    +

    Status (or "state") of the transaction.

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/database.TransactionOptions.html b/8.8.0/types/database.TransactionOptions.html new file mode 100644 index 000000000..4dd9b4516 --- /dev/null +++ b/8.8.0/types/database.TransactionOptions.html @@ -0,0 +1,152 @@ +TransactionOptions | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias TransactionOptions

+
TransactionOptions: {
    allowDirtyRead?: boolean;
    allowImplicit?: boolean;
    lockTimeout?: number;
    maxTransactionSize?: number;
    waitForSync?: boolean;
}
+

Options for how the transaction should be performed.

+
+
+

Type declaration

+
    +
  • +
    Optional allowDirtyRead?: boolean
    +

    If set to true, the request will explicitly permit ArangoDB to return a +potentially dirty or stale result and arangojs will load balance the +request without distinguishing between leaders and followers.

    +
  • +
  • +
    Optional allowImplicit?: boolean
    +

    Whether the transaction may read from collections not specified for this +transaction. If set to false, accessing any collections not specified +will result in the transaction being aborted to avoid potential deadlocks.

    +

    Default: true.

    +
  • +
  • +
    Optional lockTimeout?: number
    +

    Determines how long the database will wait while attempting to gain locks +on collections used by the transaction before timing out.

    +
  • +
  • +
    Optional maxTransactionSize?: number
    +

    (RocksDB only.) Determines the transaction size limit in bytes.

    +
  • +
  • +
    Optional waitForSync?: boolean
    +

    Determines whether to force the transaction to write all data to disk +before returning.

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/database.UninstallServiceOptions.html b/8.8.0/types/database.UninstallServiceOptions.html new file mode 100644 index 000000000..dbe087d78 --- /dev/null +++ b/8.8.0/types/database.UninstallServiceOptions.html @@ -0,0 +1,138 @@ +UninstallServiceOptions | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias UninstallServiceOptions

+
UninstallServiceOptions: {
    force?: boolean;
    teardown?: boolean;
}
+

Options for uninstalling a service.

+

See uninstallService.

+
+
+

Type declaration

+
    +
  • +
    Optional force?: boolean
    +

    If set to true, uninstalling a service that does not already exist +will be considered successful.

    +

    Default: false

    +
  • +
  • +
    Optional teardown?: boolean
    +

    Whether the service's "teardown" script should be executed +prior to removing that service.

    +

    Default: true

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/database.UpgradeServiceOptions.html b/8.8.0/types/database.UpgradeServiceOptions.html new file mode 100644 index 000000000..19d3725c6 --- /dev/null +++ b/8.8.0/types/database.UpgradeServiceOptions.html @@ -0,0 +1,165 @@ +UpgradeServiceOptions | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias UpgradeServiceOptions

+
UpgradeServiceOptions: {
    configuration?: Record<string, any>;
    dependencies?: Record<string, string>;
    development?: boolean;
    force?: boolean;
    legacy?: boolean;
    setup?: boolean;
    teardown?: boolean;
}
+

Options for upgrading a service.

+

See upgradeService.

+
+
+

Type declaration

+
    +
  • +
    Optional configuration?: Record<string, any>
    +

    An object mapping configuration option names to values.

    +

    See also getServiceConfiguration.

    +
  • +
  • +
    Optional dependencies?: Record<string, string>
    +

    An object mapping dependency aliases to mount points.

    +

    See also getServiceDependencies.

    +
  • +
  • +
    Optional development?: boolean
    +

    Whether the service should be installed in development mode.

    +

    See also setServiceDevelopmentMode.

    +

    Default: false

    +
  • +
  • +
    Optional force?: boolean
    +

    Unless set to true, upgrading a service that does not already exist will +fall back to installing the new service.

    +

    Default: false

    +
  • +
  • +
    Optional legacy?: boolean
    +

    Whether the service should be installed in legacy compatibility mode

    +

    This overrides the engines option in the service manifest (if any).

    +

    Default: false

    +
  • +
  • +
    Optional setup?: boolean
    +

    Whether the "setup" script should be executed.

    +

    Default: true

    +
  • +
  • +
    Optional teardown?: boolean
    +

    Whether the existing service's "teardown" script should be executed +prior to upgrading that service.

    +

    Default: false

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/database.UserAccessLevelOptions.html b/8.8.0/types/database.UserAccessLevelOptions.html new file mode 100644 index 000000000..639f33ff0 --- /dev/null +++ b/8.8.0/types/database.UserAccessLevelOptions.html @@ -0,0 +1,136 @@ +UserAccessLevelOptions | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias UserAccessLevelOptions

+
UserAccessLevelOptions: {
    collection?: ArangoCollection | string;
    database?: Database | string;
}
+

Options for accessing or manipulating access levels.

+
+
+

Type declaration

+
    +
  • +
    Optional collection?: ArangoCollection | string
    +

    The collection to access or manipulate the access level of.

    +
  • +
  • +
    Optional database?: Database | string
    +

    The database to access or manipulate the access level of.

    +

    If collection is an ArangoCollection, this option defaults to the +database the collection is contained in. Otherwise this option defaults to +the current database.

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/database.UserOptions.html b/8.8.0/types/database.UserOptions.html new file mode 100644 index 000000000..896a1e477 --- /dev/null +++ b/8.8.0/types/database.UserOptions.html @@ -0,0 +1,139 @@ +UserOptions | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias UserOptions

+
UserOptions: {
    active?: boolean;
    extra?: Record<string, any>;
    passwd: string;
}
+

Options for modifying an ArangoDB user.

+
+
+

Type declaration

+
    +
  • +
    Optional active?: boolean
    +

    Whether the ArangoDB user account is enabled and can authenticate.

    +

    Default: true

    +
  • +
  • +
    Optional extra?: Record<string, any>
    +

    Additional information to store about this user.

    +

    Default: {}

    +
  • +
  • +
    passwd: string
    +

    Password the ArangoDB user will use for authentication.

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/database.VersionInfo.html b/8.8.0/types/database.VersionInfo.html new file mode 100644 index 000000000..4ffbc3762 --- /dev/null +++ b/8.8.0/types/database.VersionInfo.html @@ -0,0 +1,144 @@ +VersionInfo | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias VersionInfo

+
VersionInfo: {
    details?: {
        [key: string]: string;
    };
    license: "community" | "enterprise";
    server: string;
    version: string;
}
+

Result of retrieving database version information.

+
+
+

Type declaration

+
    +
  • +
    Optional details?: {
        [key: string]: string;
    }
    +

    Additional information about the ArangoDB server.

    +
    +
      +
    • +
      [key: string]: string
  • +
  • +
    license: "community" | "enterprise"
    +

    ArangoDB license type or "edition".

    +
  • +
  • +
    server: string
    +

    Value identifying the server type, i.e. "arango".

    +
  • +
  • +
    version: string
    +

    ArangoDB server version.

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/documents.Document.html b/8.8.0/types/documents.Document.html new file mode 100644 index 000000000..f8549f074 --- /dev/null +++ b/8.8.0/types/documents.Document.html @@ -0,0 +1,73 @@ +Document | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias Document<T>

+
Document<T>: T & DocumentMetadata & Partial<EdgeMetadata>
+

Type representing a document stored in a collection.

+
+
+

Type Parameters

+
    +
  • +

    T extends Record<string, any> = any

+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/documents.DocumentData.html b/8.8.0/types/documents.DocumentData.html new file mode 100644 index 000000000..d6ae84129 --- /dev/null +++ b/8.8.0/types/documents.DocumentData.html @@ -0,0 +1,73 @@ +DocumentData | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias DocumentData<T>

+
DocumentData<T>: T & Partial<DocumentMetadata> & Partial<EdgeMetadata>
+

Type representing an object that can be stored in a collection.

+
+
+

Type Parameters

+
    +
  • +

    T extends Record<string, any> = any

+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/documents.DocumentMetadata.html b/8.8.0/types/documents.DocumentMetadata.html new file mode 100644 index 000000000..99fa51c82 --- /dev/null +++ b/8.8.0/types/documents.DocumentMetadata.html @@ -0,0 +1,85 @@ +DocumentMetadata | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias DocumentMetadata

+
DocumentMetadata: {
    _id: string;
    _key: string;
    _rev: string;
}
+

Common ArangoDB metadata properties of a document.

+
+
+

Type declaration

+
    +
  • +
    _id: string
    +

    Unique ID of the document, which is composed of the collection name +and the document _key.

    +
  • +
  • +
    _key: string
    +

    Key of the document, which uniquely identifies the document within its +collection.

    +
  • +
  • +
    _rev: string
    +

    Revision of the document data.

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/documents.DocumentSelector.html b/8.8.0/types/documents.DocumentSelector.html new file mode 100644 index 000000000..9d26f127a --- /dev/null +++ b/8.8.0/types/documents.DocumentSelector.html @@ -0,0 +1,71 @@ +DocumentSelector | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias DocumentSelector

+
DocumentSelector: ObjectWithId | ObjectWithKey | string
+

A value that can be used to identify a document within a collection in +arangojs methods, i.e. a partial ArangoDB document or the value of a +document's _key or _id.

+

See DocumentMetadata.

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/documents.Edge.html b/8.8.0/types/documents.Edge.html new file mode 100644 index 000000000..5ef16b17b --- /dev/null +++ b/8.8.0/types/documents.Edge.html @@ -0,0 +1,73 @@ +Edge | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias Edge<T>

+ +

Type representing an edge document stored in an edge collection.

+
+
+

Type Parameters

+
    +
  • +

    T extends Record<string, any> = any

+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/documents.EdgeData.html b/8.8.0/types/documents.EdgeData.html new file mode 100644 index 000000000..f96b8b947 --- /dev/null +++ b/8.8.0/types/documents.EdgeData.html @@ -0,0 +1,73 @@ +EdgeData | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias EdgeData<T>

+
EdgeData<T>: T & Partial<DocumentMetadata> & EdgeMetadata
+

Type representing an object that can be stored in an edge collection.

+
+
+

Type Parameters

+
    +
  • +

    T extends Record<string, any> = any

+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/documents.EdgeMetadata.html b/8.8.0/types/documents.EdgeMetadata.html new file mode 100644 index 000000000..5bdcf9583 --- /dev/null +++ b/8.8.0/types/documents.EdgeMetadata.html @@ -0,0 +1,79 @@ +EdgeMetadata | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias EdgeMetadata

+
EdgeMetadata: {
    _from: string;
    _to: string;
}
+

ArangoDB metadata defining the relations of an edge document.

+
+
+

Type declaration

+
    +
  • +
    _from: string
    +

    Unique ID of the document that acts as the edge's start vertex.

    +
  • +
  • +
    _to: string
    +

    Unique ID of the document that acts as the edge's end vertex.

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/documents.ObjectWithId.html b/8.8.0/types/documents.ObjectWithId.html new file mode 100644 index 000000000..44fe3c6f8 --- /dev/null +++ b/8.8.0/types/documents.ObjectWithId.html @@ -0,0 +1,76 @@ +ObjectWithId | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias ObjectWithId

+
ObjectWithId: {
    _id: string;
    [key: string]: any;
}
+

An object with an ArangoDB document _id property.

+

See DocumentMetadata.

+
+
+

Type declaration

+
    +
  • +
    [key: string]: any
  • +
  • +
    _id: string
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/documents.ObjectWithKey.html b/8.8.0/types/documents.ObjectWithKey.html new file mode 100644 index 000000000..2656559c7 --- /dev/null +++ b/8.8.0/types/documents.ObjectWithKey.html @@ -0,0 +1,76 @@ +ObjectWithKey | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias ObjectWithKey

+
ObjectWithKey: {
    _key: string;
    [key: string]: any;
}
+

An object with an ArangoDB document _key property.

+

See DocumentMetadata.

+
+
+

Type declaration

+
    +
  • +
    [key: string]: any
  • +
  • +
    _key: string
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/documents.Patch.html b/8.8.0/types/documents.Patch.html new file mode 100644 index 000000000..b0c461325 --- /dev/null +++ b/8.8.0/types/documents.Patch.html @@ -0,0 +1,76 @@ +Patch | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias Patch<T>

+
Patch<T>: { [ K in keyof T]?: T[K] | Patch<T[K]> }
+

Type representing patch data for a given object type to represent a payload +ArangoDB can apply in a document PATCH request (i.e. a partial update).

+

This differs from Partial in that it also applies itself to any nested +objects recursively.

+
+
+

Type Parameters

+
    +
  • +

    T = Record<string, any>

+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/foxx_manifest.Configuration.html b/8.8.0/types/foxx_manifest.Configuration.html new file mode 100644 index 000000000..6861e5ede --- /dev/null +++ b/8.8.0/types/foxx_manifest.Configuration.html @@ -0,0 +1,81 @@ +Configuration | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias Configuration

+
Configuration: {
    default?: any;
    description?: string;
    required?: boolean;
    type: "integer" | "boolean" | "number" | "string" | "json" | "password" | "int" | "bool";
}
+

A configuration option.

+
+
+

Type declaration

+
    +
  • +
    Optional default?: any
    +

    The default value for this option in plain JSON. Can be omitted to provide no default value.

    +
  • +
  • +
    Optional description?: string
    +

    A human-readable description of the option.

    +
  • +
  • +
    Optional required?: boolean
    +

    Whether the service can not function without this option. Defaults to true unless a default value is provided.

    +
  • +
  • +
    type: "integer" | "boolean" | "number" | "string" | "json" | "password" | "int" | "bool"
    +

    The type of value expected for this option.

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/foxx_manifest.Dependency.html b/8.8.0/types/foxx_manifest.Dependency.html new file mode 100644 index 000000000..238f89bb8 --- /dev/null +++ b/8.8.0/types/foxx_manifest.Dependency.html @@ -0,0 +1,85 @@ +Dependency | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias Dependency

+
Dependency: {
    description?: string;
    multiple?: boolean;
    name?: string;
    required?: boolean;
    version?: string;
}
+

A service dependency.

+
+
+

Type declaration

+
    +
  • +
    Optional description?: string
    +

    A description of how the API is used or why it is needed.

    +
  • +
  • +
    Optional multiple?: boolean
    +

    Whether the dependency can be specified more than once.

    +
  • +
  • +
    Optional name?: string
    +

    Name of the API the service expects.

    +
  • +
  • +
    Optional required?: boolean
    +

    Whether the service can not function without this dependency.

    +
  • +
  • +
    Optional version?: string
    +

    The semantic version ranges of the API the service expects.

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/foxx_manifest.File.html b/8.8.0/types/foxx_manifest.File.html new file mode 100644 index 000000000..a01ed7e57 --- /dev/null +++ b/8.8.0/types/foxx_manifest.File.html @@ -0,0 +1,77 @@ +File | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias File

+
File: {
    gzip?: boolean;
    path: string;
    type?: string;
}
+

A service file asset.

+
+
+

Type declaration

+
    +
  • +
    Optional gzip?: boolean
    +

    If set to true the file will be served with gzip-encoding if supported by the client. This can be useful when serving text files like client-side JavaScript, CSS or HTML.

    +
  • +
  • +
    path: string
    +

    Relative path of the file or folder within the service.

    +
  • +
  • +
    Optional type?: string
    +

    The MIME content type of the file. Defaults to an intelligent guess based on the filename's extension.

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/foxx_manifest.FoxxManifest.html b/8.8.0/types/foxx_manifest.FoxxManifest.html new file mode 100644 index 000000000..fe59877a4 --- /dev/null +++ b/8.8.0/types/foxx_manifest.FoxxManifest.html @@ -0,0 +1,137 @@ +FoxxManifest | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias FoxxManifest

+
FoxxManifest: {
    author?: string;
    configuration?: Record<string, Configuration>;
    contributors?: string[];
    defaultDocument?: string;
    dependencies?: Record<string, string | Dependency>;
    description?: string;
    engines?: Record<string, string> & {
        arangodb?: string;
    };
    files?: Record<string, string | File>;
    keywords?: string[];
    lib?: string;
    license?: string;
    main?: string;
    name?: string;
    provides?: Record<string, string>;
    scripts?: Record<string, string>;
    tests?: string | string[];
    thumbnail?: string;
    version?: string;
}
+

Schema for ArangoDB Foxx service manifests.

+
+
+

Type declaration

+
    +
  • +
    Optional author?: string
    +

    The full name of the author of the service (i.e. you). This will be shown in the web interface.

    +
  • +
  • +
    Optional configuration?: Record<string, Configuration>
    +

    An object defining the configuration options this service requires.

    +
  • +
  • +
    Optional contributors?: string[]
    +

    A list of names of people that have contributed to the development of the service in some way. This will be shown in the web interface.

    +
  • +
  • +
    Optional defaultDocument?: string
    +

    If specified, the / (root) route of the service will automatically redirect to the given relative path, e.g. "index.html".

    +
  • +
  • +
    Optional dependencies?: Record<string, string | Dependency>
    +

    The dependencies this service uses, i.e. which APIs its dependencies need to be compatible with.

    +
  • +
  • +
    Optional description?: string
    +

    A human-readable description of the service. This will be shown in the web interface.

    +
  • +
  • +
    Optional engines?: Record<string, string> & {
        arangodb?: string;
    }
    +

    An object indicating the semantic version ranges of ArangoDB (or compatible environments) the service will be compatible with.

    +
  • +
  • +
    Optional files?: Record<string, string | File>
    +

    An object defining file assets served by this service.

    +
  • +
  • +
    Optional keywords?: string[]
    +

    A list of keywords that help categorize this service. This is used by the Foxx Store installers to organize services.

    +
  • +
  • +
    Optional lib?: string
    +

    The relative path to the Foxx JavaScript files in the service, e.g. "lib". Defaults to the folder containing this manifest.

    +
  • +
  • +
    Optional license?: string
    +

    A string identifying the license under which the service is published, ideally in the form of an SPDX license identifier. This will be shown in the web interface.

    +
  • +
  • +
    Optional main?: string
    +

    The relative path to the main entry point of this service (relative to lib), e.g. "index.js".

    +
  • +
  • +
    Optional name?: string
    +

    The name of the Foxx service. This will be shown in the web interface.

    +
  • +
  • +
    Optional provides?: Record<string, string>
    +

    The dependencies this provides, i.e. which APIs it claims to be compatible with.

    +
  • +
  • +
    Optional scripts?: Record<string, string>
    +

    An object defining named scripts provided by this service, which can either be used directly or as queued jobs by other services.

    +
  • +
  • +
    Optional tests?: string | string[]
    +

    A path/pattern or list of paths/patterns of JavaScript tests provided for this service.

    +
  • +
  • +
    Optional thumbnail?: string
    +

    The filename of a thumbnail that will be used alongside the service in the web interface. This should be a JPEG or PNG image that looks good at sizes 50x50 and 160x160.

    +
  • +
  • +
    Optional version?: string
    +

    The version number of the Foxx service. The version number must follow the semantic versioning format. This will be shown in the web interface.

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/graph.AddEdgeDefinitionOptions.html b/8.8.0/types/graph.AddEdgeDefinitionOptions.html new file mode 100644 index 000000000..3d7d43c86 --- /dev/null +++ b/8.8.0/types/graph.AddEdgeDefinitionOptions.html @@ -0,0 +1,79 @@ +AddEdgeDefinitionOptions | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias AddEdgeDefinitionOptions

+
AddEdgeDefinitionOptions: {
    satellites?: (string | ArangoCollection)[];
}
+
+

Type declaration

+
    +
  • +
    Optional satellites?: (string | ArangoCollection)[]
    +

    (Enterprise Edition cluster only.) Collections to be included in a Hybrid +SmartGraph.

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/graph.AddVertexCollectionOptions.html b/8.8.0/types/graph.AddVertexCollectionOptions.html new file mode 100644 index 000000000..7784055c5 --- /dev/null +++ b/8.8.0/types/graph.AddVertexCollectionOptions.html @@ -0,0 +1,79 @@ +AddVertexCollectionOptions | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias AddVertexCollectionOptions

+
AddVertexCollectionOptions: {
    satellites?: (string | ArangoCollection)[];
}
+
+

Type declaration

+
    +
  • +
    Optional satellites?: (string | ArangoCollection)[]
    +

    (Enterprise Edition cluster only.) Collections to be included in a Hybrid +SmartGraph.

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/graph.CreateGraphOptions.html b/8.8.0/types/graph.CreateGraphOptions.html new file mode 100644 index 000000000..f91d1d579 --- /dev/null +++ b/8.8.0/types/graph.CreateGraphOptions.html @@ -0,0 +1,126 @@ +CreateGraphOptions | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias CreateGraphOptions

+
CreateGraphOptions: {
    isDisjoint?: boolean;
    isSmart?: boolean;
    numberOfShards?: number;
    orphanCollections?: (string | ArangoCollection)[] | string | ArangoCollection;
    replicationFactor?: number | "satellite";
    satellites?: (string | ArangoCollection)[];
    smartGraphAttribute?: string;
    waitForSync?: boolean;
    writeConcern?: number;
}
+

Option for creating a graph.

+
+
+

Type declaration

+
    +
  • +
    Optional isDisjoint?: boolean
    +

    (Enterprise Edition cluster only.) If set to true, the graph will be +created as a Disjoint SmartGraph.

    +

    Default: false

    +
  • +
  • +
    Optional isSmart?: boolean
    +

    (Enterprise Edition cluster only.) If set to true, the graph will be +created as a SmartGraph.

    +

    Default: false

    +
  • +
  • +
    Optional numberOfShards?: number
    +

    (Cluster only.) Number of shards that is used for every collection +within this graph.

    +

    Has no effect when replicationFactor is set to "satellite".

    +
  • +
  • +
    Optional orphanCollections?: (string | ArangoCollection)[] | string | ArangoCollection
    +

    Additional vertex collections. Documents within these collections do not +have edges within this graph.

    +
  • +
  • +
    Optional replicationFactor?: number | "satellite"
    +

    (Cluster only.) Replication factor used when initially creating +collections for this graph.

    +

    Default: 1

    +
  • +
  • +
    Optional satellites?: (string | ArangoCollection)[]
    +

    (Enterprise Edition cluster only.) Collections to be included in a Hybrid +SmartGraph.

    +
  • +
  • +
    Optional smartGraphAttribute?: string
    +

    (Enterprise Edition cluster only.) Attribute containing the shard key +value to use for smart sharding.

    +
  • +
  • +
    Optional waitForSync?: boolean
    +

    If set to true, the request will wait until all modifications have been +synchronized to disk before returning successfully.

    +

    Default: false

    +
  • +
  • +
    Optional writeConcern?: number
    +

    (Cluster only.) Write concern for new collections in the graph.

    +

    Has no effect when replicationFactor is set to "satellite".

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/graph.EdgeDefinition.html b/8.8.0/types/graph.EdgeDefinition.html new file mode 100644 index 000000000..40f1c0f75 --- /dev/null +++ b/8.8.0/types/graph.EdgeDefinition.html @@ -0,0 +1,88 @@ +EdgeDefinition | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias EdgeDefinition

+
EdgeDefinition: {
    collection: string;
    from: string[];
    to: string[];
}
+

Definition of a relation in a Graph.

+
+
+

Type declaration

+
    +
  • +
    collection: string
    +

    Name of the collection containing the edges.

    +
  • +
  • +
    from: string[]
    +

    Array of names of collections containing the start vertices.

    +
  • +
  • +
    to: string[]
    +

    Array of names of collections containing the end vertices.

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/graph.EdgeDefinitionOptions.html b/8.8.0/types/graph.EdgeDefinitionOptions.html new file mode 100644 index 000000000..da238dd49 --- /dev/null +++ b/8.8.0/types/graph.EdgeDefinitionOptions.html @@ -0,0 +1,88 @@ +EdgeDefinitionOptions | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias EdgeDefinitionOptions

+
EdgeDefinitionOptions: {
    collection: string | ArangoCollection;
    from: (string | ArangoCollection)[] | string | ArangoCollection;
    to: (string | ArangoCollection)[] | string | ArangoCollection;
}
+

An edge definition used to define a collection of edges in a Graph.

+
+
+

Type declaration

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/graph.GraphCollectionInsertOptions.html b/8.8.0/types/graph.GraphCollectionInsertOptions.html new file mode 100644 index 000000000..192b404d0 --- /dev/null +++ b/8.8.0/types/graph.GraphCollectionInsertOptions.html @@ -0,0 +1,87 @@ +GraphCollectionInsertOptions | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias GraphCollectionInsertOptions

+
GraphCollectionInsertOptions: {
    returnNew?: boolean;
    waitForSync?: boolean;
}
+

Options for inserting a document into a graph collection.

+
+
+

Type declaration

+
    +
  • +
    Optional returnNew?: boolean
    +

    If set to true, the complete new document will be returned as the new +property on the result object.

    +

    Default: false

    +
  • +
  • +
    Optional waitForSync?: boolean
    +

    If set to true, data will be synchronized to disk before returning.

    +

    Default: false

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/graph.GraphCollectionReadOptions.html b/8.8.0/types/graph.GraphCollectionReadOptions.html new file mode 100644 index 000000000..705bd99e4 --- /dev/null +++ b/8.8.0/types/graph.GraphCollectionReadOptions.html @@ -0,0 +1,95 @@ +GraphCollectionReadOptions | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias GraphCollectionReadOptions

+
GraphCollectionReadOptions: {
    allowDirtyRead?: boolean;
    graceful?: boolean;
    rev?: string;
}
+

Options for retrieving a document from a graph collection.

+
+
+

Type declaration

+
    +
  • +
    Optional allowDirtyRead?: boolean
    +

    If set to true, the request will explicitly permit ArangoDB to return a +potentially dirty or stale result and arangojs will load balance the +request without distinguishing between leaders and followers.

    +

    Default: false

    +
  • +
  • +
    Optional graceful?: boolean
    +

    If set to true, null is returned instead of an exception being thrown +if the document does not exist.

    +

    Default: false

    +
  • +
  • +
    Optional rev?: string
    +

    If set to a document revision, the document will only be returned if its +_rev property matches this value.

    +

    See also DocumentMetadata.

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/graph.GraphCollectionRemoveOptions.html b/8.8.0/types/graph.GraphCollectionRemoveOptions.html new file mode 100644 index 000000000..23c3e442e --- /dev/null +++ b/8.8.0/types/graph.GraphCollectionRemoveOptions.html @@ -0,0 +1,93 @@ +GraphCollectionRemoveOptions | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias GraphCollectionRemoveOptions

+
GraphCollectionRemoveOptions: {
    returnOld?: boolean;
    rev?: string;
    waitForSync?: boolean;
}
+

Options for removing a document from a graph collection.

+
+
+

Type declaration

+
    +
  • +
    Optional returnOld?: boolean
    +

    If set to true, the complete old document will be returned as the old +property on the result object.

    +

    Default: false

    +
  • +
  • +
    Optional rev?: string
    +

    If set to a document revision, the document will only be removed if its +_rev property matches this value.

    +

    See also DocumentMetadata.

    +
  • +
  • +
    Optional waitForSync?: boolean
    +

    If set to true, data will be synchronized to disk before returning.

    +

    Default: false

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/graph.GraphCollectionReplaceOptions.html b/8.8.0/types/graph.GraphCollectionReplaceOptions.html new file mode 100644 index 000000000..a46caa201 --- /dev/null +++ b/8.8.0/types/graph.GraphCollectionReplaceOptions.html @@ -0,0 +1,105 @@ +GraphCollectionReplaceOptions | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias GraphCollectionReplaceOptions

+
GraphCollectionReplaceOptions: {
    keepNull?: boolean;
    returnNew?: boolean;
    returnOld?: boolean;
    rev?: string;
    waitForSync?: boolean;
}
+

Options for replacing a document in a graph collection.

+
+
+

Type declaration

+
    +
  • +
    Optional keepNull?: boolean
    +

    If set to false, properties with a value of null will be removed from +the new document.

    +

    Default: true

    +
  • +
  • +
    Optional returnNew?: boolean
    +

    If set to true, the complete new document will be returned as the new +property on the result object.

    +

    Default: false

    +
  • +
  • +
    Optional returnOld?: boolean
    +

    If set to true, the complete old document will be returned as the old +property on the result object.

    +

    Default: false

    +
  • +
  • +
    Optional rev?: string
    +

    If set to a document revision, the document will only be modified if its +_rev property matches this value.

    +

    See also DocumentMetadata.

    +
  • +
  • +
    Optional waitForSync?: boolean
    +

    If set to true, data will be synchronized to disk before returning.

    +

    Default: false

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/graph.GraphInfo.html b/8.8.0/types/graph.GraphInfo.html new file mode 100644 index 000000000..7c2bb4279 --- /dev/null +++ b/8.8.0/types/graph.GraphInfo.html @@ -0,0 +1,123 @@ +GraphInfo | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias GraphInfo

+
GraphInfo: {
    edgeDefinitions: EdgeDefinition[];
    isDisjoint?: boolean;
    isSatellite?: boolean;
    isSmart?: boolean;
    name: string;
    numberOfShards?: number;
    orphanCollections: string[];
    replicationFactor?: number;
    smartGraphAttribute?: string;
    writeConcern?: number;
}
+

General information about a graph.

+
+
+

Type declaration

+
    +
  • +
    edgeDefinitions: EdgeDefinition[]
    +

    Definitions for the relations of the graph.

    +
  • +
  • +
    Optional isDisjoint?: boolean
    +

    (Enterprise Edition cluster only.) If set to true, the graph has been +created as a Disjoint SmartGraph.

    +
  • +
  • +
    Optional isSatellite?: boolean
    +

    (Enterprise Edition cluster only.) If set to true, the graph is a +SatelliteGraph.

    +
  • +
  • +
    Optional isSmart?: boolean
    +

    (Enterprise Edition cluster only.) If set to true, the graph has been +created as a SmartGraph.

    +
  • +
  • +
    name: string
    +

    Name of the graph.

    +
  • +
  • +
    Optional numberOfShards?: number
    +

    (Cluster only.) Number of shards that is used for every collection +within this graph.

    +
  • +
  • +
    orphanCollections: string[]
    +

    Additional vertex collections. Documents within these collections do not +have edges within this graph.

    +
  • +
  • +
    Optional replicationFactor?: number
    +

    (Cluster only.) Replication factor used when initially creating +collections for this graph.

    +
  • +
  • +
    Optional smartGraphAttribute?: string
    +

    (Enterprise Edition cluster only.) Attribute containing the shard key +value to use for smart sharding.

    +
  • +
  • +
    Optional writeConcern?: number
    +

    (Cluster only.) Write concern for new collections in the graph.

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/graph.ReplaceEdgeDefinitionOptions.html b/8.8.0/types/graph.ReplaceEdgeDefinitionOptions.html new file mode 100644 index 000000000..2ea50f300 --- /dev/null +++ b/8.8.0/types/graph.ReplaceEdgeDefinitionOptions.html @@ -0,0 +1,79 @@ +ReplaceEdgeDefinitionOptions | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias ReplaceEdgeDefinitionOptions

+
ReplaceEdgeDefinitionOptions: {
    satellites?: string[];
}
+
+

Type declaration

+
    +
  • +
    Optional satellites?: string[]
    +

    (Enterprise Edition cluster only.) Collections to be included in a Hybrid +SmartGraph.

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/indexes.EnsureFulltextIndexOptions.html b/8.8.0/types/indexes.EnsureFulltextIndexOptions.html new file mode 100644 index 000000000..5e4fddee5 --- /dev/null +++ b/8.8.0/types/indexes.EnsureFulltextIndexOptions.html @@ -0,0 +1,109 @@ +EnsureFulltextIndexOptions | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias EnsureFulltextIndexOptions

+
EnsureFulltextIndexOptions: {
    fields: [string];
    inBackground?: boolean;
    minLength?: number;
    name?: string;
    type: "fulltext";
}
+

Options for creating a fulltext index.

+ +

Deprecated

Fulltext indexes have been deprecated in ArangoDB 3.10 and +should be replaced with ArangoSearch.

+
+
+

Type declaration

+
    +
  • +
    fields: [string]
    +

    An array containing exactly one attribute path.

    +
  • +
  • +
    Optional inBackground?: boolean
    +

    If set to true, the index will be created in the background to reduce +the write-lock duration for the collection during index creation.

    +

    Default: false

    +
  • +
  • +
    Optional minLength?: number
    +

    Minimum character length of words to index.

    +
  • +
  • +
    Optional name?: string
    +

    A unique name for this index.

    +
  • +
  • +
    type: "fulltext"
    +

    Type of this index.

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/indexes.EnsureGeoIndexOptions.html b/8.8.0/types/indexes.EnsureGeoIndexOptions.html new file mode 100644 index 000000000..e77cf3da8 --- /dev/null +++ b/8.8.0/types/indexes.EnsureGeoIndexOptions.html @@ -0,0 +1,81 @@ +EnsureGeoIndexOptions | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias EnsureGeoIndexOptions

+
EnsureGeoIndexOptions: {
    fields: [string, string];
    geoJson?: false;
    inBackground?: boolean;
    legacyPolygons?: boolean;
    name?: string;
    type: "geo";
} | {
    fields: [string];
    geoJson?: boolean;
    inBackground?: boolean;
    legacyPolygons?: boolean;
    name?: string;
    type: "geo";
}
+

Options for creating a geo index.

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/indexes.EnsureInvertedIndexOptions.html b/8.8.0/types/indexes.EnsureInvertedIndexOptions.html new file mode 100644 index 000000000..ce417536b --- /dev/null +++ b/8.8.0/types/indexes.EnsureInvertedIndexOptions.html @@ -0,0 +1,223 @@ +EnsureInvertedIndexOptions | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias EnsureInvertedIndexOptions

+
EnsureInvertedIndexOptions: {
    analyzer?: string;
    cache?: boolean;
    cleanupIntervalStep?: number;
    commitIntervalMsec?: number;
    consolidationIntervalMsec?: number;
    consolidationPolicy?: TierConsolidationPolicy;
    features?: AnalyzerFeature[];
    fields: (string | InvertedIndexFieldOptions)[];
    inBackground?: boolean;
    includeAllFields?: boolean;
    name?: string;
    optimizeTopK?: string[];
    parallelism?: number;
    primaryKeyCache?: boolean;
    primarySort?: {
        cache?: boolean;
        compression?: Compression;
        fields: InvertedIndexPrimarySortFieldOptions[];
    };
    searchField?: boolean;
    storedValues?: InvertedIndexStoredValueOptions[];
    trackListPositions?: boolean;
    type: "inverted";
    writeBufferActive?: number;
    writeBufferIdle?: number;
    writeBufferSizeMax?: number;
}
+

Options for creating an inverted index.

+
+
+

Type declaration

+
    +
  • +
    Optional analyzer?: string
    +

    Name of the default Analyzer to apply to the values of indexed fields.

    +

    Default: "identity"

    +
  • +
  • +
    Optional cache?: boolean
    +

    (Enterprise Edition only.) If set to true, then field normalization +values will always be cached in memory.

    +

    Default: false

    +
  • +
  • +
    Optional cleanupIntervalStep?: number
    +

    Wait at least this many commits between removing unused files in the +ArangoSearch data directory.

    +

    Default: 2

    +
  • +
  • +
    Optional commitIntervalMsec?: number
    +

    Wait at least this many milliseconds between committing View data store +changes and making documents visible to queries.

    +

    Default: 1000

    +
  • +
  • +
    Optional consolidationIntervalMsec?: number
    +

    Wait at least this many milliseconds between applying +consolidationPolicy to consolidate View data store and possibly release +space on the filesystem.

    +

    Default: 1000

    +
  • +
  • +
    Optional consolidationPolicy?: TierConsolidationPolicy
    +

    The consolidation policy to apply for selecting which segments should be +merged.

    +

    Default: { type: "tier" }

    +
  • +
  • +
    Optional features?: AnalyzerFeature[]
    +

    List of Analyzer features to enable for the default Analyzer.

    +

    Defaults to the Analyzer's features.

    +
  • +
  • +
    fields: (string | InvertedIndexFieldOptions)[]
    +

    An array of attribute paths or objects specifying options for the fields.

    +
  • +
  • +
    Optional inBackground?: boolean
    +

    If set to true, the index will be created in the background to reduce +the write-lock duration for the collection during index creation.

    +

    Default: false

    +
  • +
  • +
    Optional includeAllFields?: boolean
    +

    If set to true, all document attributes are indexed, excluding any +sub-attributes configured in the fields array. The analyzer and +features properties apply to the sub-attributes. This option only +applies when using the index in a SearchAlias View.

    +

    Default: false

    +
  • +
  • +
    Optional name?: string
    +

    A unique name for this index.

    +
  • +
  • +
    Optional optimizeTopK?: string[]
    +

    An array of strings defining sort expressions to optimize.

    +
  • +
  • +
    Optional parallelism?: number
    +

    The number of threads to use for indexing the fields.

    +

    Default: 2

    +
  • +
  • +
    Optional primaryKeyCache?: boolean
    +

    (Enterprise Edition only.) If set to true, then the primary key column +will always be cached in memory.

    +

    Default: false

    +
  • +
  • +
    Optional primarySort?: {
        cache?: boolean;
        compression?: Compression;
        fields: InvertedIndexPrimarySortFieldOptions[];
    }
    +

    Primary sort order to optimize AQL queries using a matching sort order.

    +
    +
      +
    • +
      Optional cache?: boolean
      +

      (Enterprise Edition only.) If set to true, then primary sort columns +will always be cached in memory.

      +

      Default: false

      +
    • +
    • +
      Optional compression?: Compression
      +

      How the primary sort data should be compressed.

      +

      Default: "lz4"

      +
    • +
    • +
      fields: InvertedIndexPrimarySortFieldOptions[]
      +

      An array of fields to sort the index by.

      +
  • +
  • +
    Optional searchField?: boolean
    +

    If set to true array values will by default be indexed using the same +behavior as ArangoSearch Views. This option only applies when using the +index in a SearchAlias View.

    +

    Default: false

    +
  • +
  • +
    Optional storedValues?: InvertedIndexStoredValueOptions[]
    +

    An array of attribute paths that will be stored in the index but can not +be used for index lookups or sorting but can avoid full document lookups.

    +
  • +
  • +
    Optional trackListPositions?: boolean
    +

    If set to true, the position of values in array values are tracked and +need to be specified in queries. Otherwise all values in an array are +treated as equivalent. This option only applies when using the index in a +SearchAlias View.

    +

    Default: false

    +
  • +
  • +
    type: "inverted"
    +

    Type of this index.

    +
  • +
  • +
    Optional writeBufferActive?: number
    +

    Maximum number of concurrent active writers (segments) that perform a +transaction.

    +

    Default: 0 (disabled)

    +
  • +
  • +
    Optional writeBufferIdle?: number
    +

    Maximum number of writers (segments) cached in the pool.

    +

    Default: 64

    +
  • +
  • +
    Optional writeBufferSizeMax?: number
    +

    Maximum memory byte size per writer (segment) before a writer (segment) +flush is triggered.

    +

    Default: 33554432 (32 MiB)

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/indexes.EnsureMdiIndexOptions.html b/8.8.0/types/indexes.EnsureMdiIndexOptions.html new file mode 100644 index 000000000..c02b6097a --- /dev/null +++ b/8.8.0/types/indexes.EnsureMdiIndexOptions.html @@ -0,0 +1,111 @@ +EnsureMdiIndexOptions | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias EnsureMdiIndexOptions

+
EnsureMdiIndexOptions: {
    fieldValueTypes: "double";
    fields: string[];
    inBackground?: boolean;
    name?: string;
    type: "mdi";
    unique?: boolean;
}
+

Options for creating a MDI index.

+
+
+

Type declaration

+
    +
  • +
    fieldValueTypes: "double"
    +

    Data type of the dimension attributes.

    +
  • +
  • +
    fields: string[]
    +

    An array containing attribute paths for the dimensions.

    +
  • +
  • +
    Optional inBackground?: boolean
    +

    If set to true, the index will be created in the background to reduce +the write-lock duration for the collection during index creation.

    +

    Default: false

    +
  • +
  • +
    Optional name?: string
    +

    A unique name for this index.

    +
  • +
  • +
    type: "mdi"
    +

    Type of this index.

    +
  • +
  • +
    Optional unique?: boolean
    +

    If set to true, a unique index will be created.

    +

    Default: false

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/indexes.EnsurePersistentIndexOptions.html b/8.8.0/types/indexes.EnsurePersistentIndexOptions.html new file mode 100644 index 000000000..4b02230e5 --- /dev/null +++ b/8.8.0/types/indexes.EnsurePersistentIndexOptions.html @@ -0,0 +1,137 @@ +EnsurePersistentIndexOptions | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias EnsurePersistentIndexOptions

+
EnsurePersistentIndexOptions: {
    cacheEnabled?: boolean;
    deduplicate?: boolean;
    estimates?: boolean;
    fields: string[];
    inBackground?: boolean;
    name?: string;
    sparse?: boolean;
    storedValues?: string[];
    type: "persistent";
    unique?: boolean;
}
+

Options for creating a persistent index.

+
+
+

Type declaration

+
    +
  • +
    Optional cacheEnabled?: boolean
    +

    If set to true, an in-memory hash cache will be put in front of the +persistent index.

    +

    Default: false

    +
  • +
  • +
    Optional deduplicate?: boolean
    +

    If set to false, inserting duplicate index values from the same +document will lead to a unique constraint error if this is a unique index.

    +

    Default: true

    +
  • +
  • +
    Optional estimates?: boolean
    +

    If set to false, index selectivity estimates will be disabled for this +index.

    +

    Default: true

    +
  • +
  • +
    fields: string[]
    +

    An array of attribute paths.

    +
  • +
  • +
    Optional inBackground?: boolean
    +

    If set to true, the index will be created in the background to reduce +the write-lock duration for the collection during index creation.

    +

    Default: false

    +
  • +
  • +
    Optional name?: string
    +

    A unique name for this index.

    +
  • +
  • +
    Optional sparse?: boolean
    +

    If set to true, the index will omit documents that do not contain at +least one of the attribute paths in fields and these documents will be +ignored for uniqueness checks.

    +

    Default: false

    +
  • +
  • +
    Optional storedValues?: string[]
    +

    An array of attribute paths that will be stored in the index but can not +be used for index lookups or sorting but can avoid full document lookups.

    +
  • +
  • +
    type: "persistent"
    +

    Type of this index.

    +
  • +
  • +
    Optional unique?: boolean
    +

    If set to true, a unique index will be created.

    +

    Default: false

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/indexes.EnsureTtlIndexOptions.html b/8.8.0/types/indexes.EnsureTtlIndexOptions.html new file mode 100644 index 000000000..bd6abe43c --- /dev/null +++ b/8.8.0/types/indexes.EnsureTtlIndexOptions.html @@ -0,0 +1,107 @@ +EnsureTtlIndexOptions | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias EnsureTtlIndexOptions

+
EnsureTtlIndexOptions: {
    expireAfter: number;
    fields: [string];
    inBackground?: boolean;
    name?: string;
    type: "ttl";
}
+

Options for creating a TTL index.

+
+
+

Type declaration

+
    +
  • +
    expireAfter: number
    +

    Duration in seconds after the attribute value at which the document will +be considered as expired.

    +
  • +
  • +
    fields: [string]
    +

    An array containing exactly one attribute path.

    +
  • +
  • +
    Optional inBackground?: boolean
    +

    If set to true, the index will be created in the background to reduce +the write-lock duration for the collection during index creation.

    +

    Default: false

    +
  • +
  • +
    Optional name?: string
    +

    A unique name for this index.

    +
  • +
  • +
    type: "ttl"
    +

    Type of this index.

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/indexes.FulltextIndex.html b/8.8.0/types/indexes.FulltextIndex.html new file mode 100644 index 000000000..09738a497 --- /dev/null +++ b/8.8.0/types/indexes.FulltextIndex.html @@ -0,0 +1,84 @@ +FulltextIndex | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias FulltextIndex

+
FulltextIndex: GenericIndex & {
    fields: [string];
    minLength: number;
    type: "fulltext";
}
+

An object representing a fulltext index.

+ +

Deprecated

Fulltext indexes have been deprecated in ArangoDB 3.10 and +should be replaced with ArangoSearch.

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/indexes.GenericIndex.html b/8.8.0/types/indexes.GenericIndex.html new file mode 100644 index 000000000..edcf86f39 --- /dev/null +++ b/8.8.0/types/indexes.GenericIndex.html @@ -0,0 +1,101 @@ +GenericIndex | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias GenericIndex

+
GenericIndex: {
    id: string;
    name: string;
    sparse: boolean;
    unique: boolean;
}
+

Shared attributes of all index types.

+
+
+

Type declaration

+
    +
  • +
    id: string
    +

    A unique identifier for this index.

    +
  • +
  • +
    name: string
    +

    A unique name for this index.

    +
  • +
  • +
    sparse: boolean
    +

    Whether documents not containing at least one of the attribute paths +are omitted by this index.

    +
  • +
  • +
    unique: boolean
    +

    Whether this index enforces uniqueness for values of its attribute paths.

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/indexes.GeoIndex.html b/8.8.0/types/indexes.GeoIndex.html new file mode 100644 index 000000000..7d69a6d27 --- /dev/null +++ b/8.8.0/types/indexes.GeoIndex.html @@ -0,0 +1,81 @@ +GeoIndex | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias GeoIndex

+
GeoIndex: GenericIndex & {
    bestIndexedLevel: number;
    fields: [string] | [string, string];
    geoJson: boolean;
    legacyPolygons: boolean;
    maxNumCoverCells: number;
    type: "geo";
    worstIndexedLevel: number;
}
+

An object representing a geo index.

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/indexes.Index.html b/8.8.0/types/indexes.Index.html new file mode 100644 index 000000000..999f6cb49 --- /dev/null +++ b/8.8.0/types/indexes.Index.html @@ -0,0 +1,81 @@ +Index | arangojs - v8.8.0
+
+ +
+ +
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/indexes.IndexSelector.html b/8.8.0/types/indexes.IndexSelector.html new file mode 100644 index 000000000..5df520f7b --- /dev/null +++ b/8.8.0/types/indexes.IndexSelector.html @@ -0,0 +1,81 @@ +IndexSelector | arangojs - v8.8.0
+
+ +
+ +
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/indexes.InvertedIndex.html b/8.8.0/types/indexes.InvertedIndex.html new file mode 100644 index 000000000..212a142da --- /dev/null +++ b/8.8.0/types/indexes.InvertedIndex.html @@ -0,0 +1,81 @@ +InvertedIndex | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias InvertedIndex

+
InvertedIndex: GenericIndex & {
    analyzer: string;
    cache?: boolean;
    cleanupIntervalStep: number;
    commitIntervalMsec: number;
    consolidationIntervalMsec: number;
    consolidationPolicy: Required<TierConsolidationPolicy>;
    features: AnalyzerFeature[];
    fields: {
        analyzer?: string;
        cache?: boolean;
        features?: AnalyzerFeature[];
        includeAllFields?: boolean;
        name: string;
        nested?: InvertedIndexNestedField[];
        searchField?: boolean;
        trackListPositions?: boolean;
    }[];
    includeAllFields: boolean;
    optimizeTopK: string[];
    parallelism: number;
    primaryKeyCache?: boolean;
    primarySort: {
        cache?: boolean;
        compression: Compression;
        fields: {
            direction: Direction;
            field: string;
        }[];
    };
    searchField: boolean;
    storedValues: {
        cache?: boolean;
        compression: Compression;
        fields: string[];
    }[];
    trackListPositions: boolean;
    type: "inverted";
    writeBufferActive: number;
    writeBufferIdle: number;
    writeBufferSizeMax: number;
}
+

An object representing an inverted index.

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/indexes.InvertedIndexFieldOptions.html b/8.8.0/types/indexes.InvertedIndexFieldOptions.html new file mode 100644 index 000000000..e4f260086 --- /dev/null +++ b/8.8.0/types/indexes.InvertedIndexFieldOptions.html @@ -0,0 +1,133 @@ +InvertedIndexFieldOptions | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias InvertedIndexFieldOptions

+
InvertedIndexFieldOptions: {
    analyzer?: string;
    cache?: boolean;
    features?: AnalyzerFeature[];
    includeAllFields?: boolean;
    name: string;
    nested?: (string | InvertedIndexNestedFieldOptions)[];
    searchField?: boolean;
    trackListPositions?: boolean;
}
+

Options for an attribute path in an inverted index.

+
+
+

Type declaration

+
    +
  • +
    Optional analyzer?: string
    +

    Name of the Analyzer to apply to the values of this field.

    +

    Defaults to the analyzer specified on the index itself.

    +
  • +
  • +
    Optional cache?: boolean
    +

    (Enterprise Edition only.) If set to true, then field normalization +values will always be cached in memory.

    +

    Defaults to the value of cache specified on the index itself.

    +
  • +
  • +
    Optional features?: AnalyzerFeature[]
    +

    List of Analyzer features to enable for this field's Analyzer.

    +

    Defaults to the features of the Analyzer.

    +
  • +
  • +
    Optional includeAllFields?: boolean
    +

    If set to true, all document attributes are indexed, excluding any +sub-attributes configured in the fields array. The analyzer and +features properties apply to the sub-attributes. This option only +applies when using the index in a SearchAlias View.

    +

    Defaults to the value of includeAllFields specified on the index itself.

    +
  • +
  • +
    name: string
    +

    An attribute path.

    +
  • +
  • +
    Optional nested?: (string | InvertedIndexNestedFieldOptions)[]
    +

    (Enterprise Edition only.) Sub-objects to index to allow querying for +co-occurring values.

    +
  • +
  • +
    Optional searchField?: boolean
    +

    If set to true array values will be indexed using the same behavior as +ArangoSearch Views. This option only applies when using the index in a +SearchAlias View.

    +

    Defaults to the value of searchField specified on the index itself.

    +
  • +
  • +
    Optional trackListPositions?: boolean
    +

    If set to true, the position of values in array values are tracked and +need to be specified in queries. Otherwise all values in an array are +treated as equivalent. This option only applies when using the index in a +SearchAlias View.

    +

    Defaults to the value of trackListPositions specified on the index +itself.

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/indexes.InvertedIndexNestedField.html b/8.8.0/types/indexes.InvertedIndexNestedField.html new file mode 100644 index 000000000..af19f224e --- /dev/null +++ b/8.8.0/types/indexes.InvertedIndexNestedField.html @@ -0,0 +1,95 @@ +InvertedIndexNestedField | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias InvertedIndexNestedField

+
InvertedIndexNestedField: {
    analyzer?: string;
    features?: AnalyzerFeature[];
    name: string;
    nested?: InvertedIndexNestedField[];
    searchField?: boolean;
}
+

(Enterprise Edition only.) An object representing a nested field in an +inverted index.

+
+
+

Type declaration

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/indexes.InvertedIndexNestedFieldOptions.html b/8.8.0/types/indexes.InvertedIndexNestedFieldOptions.html new file mode 100644 index 000000000..426f07933 --- /dev/null +++ b/8.8.0/types/indexes.InvertedIndexNestedFieldOptions.html @@ -0,0 +1,110 @@ +InvertedIndexNestedFieldOptions | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias InvertedIndexNestedFieldOptions

+
InvertedIndexNestedFieldOptions: {
    analyzer?: string;
    features?: AnalyzerFeature[];
    name: string;
    nested?: (string | InvertedIndexNestedFieldOptions)[];
    searchField?: boolean;
}
+

(Enterprise Edition only.) Options for a nested field in an inverted index.

+
+
+

Type declaration

+
    +
  • +
    Optional analyzer?: string
    +

    Name of the Analyzer to apply to the values of this field.

    +

    Defaults to the analyzer specified on the parent options or on the index +itself.

    +
  • +
  • +
    Optional features?: AnalyzerFeature[]
    +

    List of Analyzer features to enable for this field's Analyzer.

    +

    Defaults to the features of the Analyzer.

    +
  • +
  • +
    name: string
    +

    An attribute path.

    +
  • +
  • +
    Optional nested?: (string | InvertedIndexNestedFieldOptions)[]
    +

    Sub-objects to index to allow querying for co-occurring values.

    +
  • +
  • +
    Optional searchField?: boolean
    +

    If set to true array values will be indexed using the same behavior as +ArangoSearch Views. This option only applies when using the index in a +SearchAlias View.

    +

    Defaults to the value of searchField specified on the index itself.

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/indexes.InvertedIndexPrimarySortFieldOptions.html b/8.8.0/types/indexes.InvertedIndexPrimarySortFieldOptions.html new file mode 100644 index 000000000..1968e92c7 --- /dev/null +++ b/8.8.0/types/indexes.InvertedIndexPrimarySortFieldOptions.html @@ -0,0 +1,92 @@ +InvertedIndexPrimarySortFieldOptions | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias InvertedIndexPrimarySortFieldOptions

+
InvertedIndexPrimarySortFieldOptions: {
    direction: Direction;
    field: string;
}
+

Options for defining a primary sort field on an inverted index.

+
+
+

Type declaration

+
    +
  • +
    direction: Direction
    +

    The sorting direction.

    +
  • +
  • +
    field: string
    +

    The attribute path to sort by.

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/indexes.InvertedIndexStoredValueOptions.html b/8.8.0/types/indexes.InvertedIndexStoredValueOptions.html new file mode 100644 index 000000000..10dd48712 --- /dev/null +++ b/8.8.0/types/indexes.InvertedIndexStoredValueOptions.html @@ -0,0 +1,99 @@ +InvertedIndexStoredValueOptions | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias InvertedIndexStoredValueOptions

+
InvertedIndexStoredValueOptions: {
    cache?: boolean;
    compression?: Compression;
    fields: string[];
}
+

Options for defining a stored value on an inverted index.

+
+
+

Type declaration

+
    +
  • +
    Optional cache?: boolean
    +

    (Enterprise Edition only.) If set to true, then stored values will +always be cached in memory.

    +

    Default: false

    +
  • +
  • +
    Optional compression?: Compression
    +

    How the attribute values should be compressed.

    +

    Default: "lz4"

    +
  • +
  • +
    fields: string[]
    +

    The attribute paths to store.

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/indexes.MdiIndex.html b/8.8.0/types/indexes.MdiIndex.html new file mode 100644 index 000000000..1b3da595c --- /dev/null +++ b/8.8.0/types/indexes.MdiIndex.html @@ -0,0 +1,81 @@ +MdiIndex | arangojs - v8.8.0
+
+ +
+ +
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/indexes.ObjectWithId.html b/8.8.0/types/indexes.ObjectWithId.html new file mode 100644 index 000000000..64c4b897f --- /dev/null +++ b/8.8.0/types/indexes.ObjectWithId.html @@ -0,0 +1,86 @@ +ObjectWithId | arangojs - v8.8.0
+
+ +
+ +
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/indexes.ObjectWithName.html b/8.8.0/types/indexes.ObjectWithName.html new file mode 100644 index 000000000..1f524c21a --- /dev/null +++ b/8.8.0/types/indexes.ObjectWithName.html @@ -0,0 +1,86 @@ +ObjectWithName | arangojs - v8.8.0
+
+ +
+ +
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/indexes.PersistentIndex.html b/8.8.0/types/indexes.PersistentIndex.html new file mode 100644 index 000000000..c02d22d45 --- /dev/null +++ b/8.8.0/types/indexes.PersistentIndex.html @@ -0,0 +1,81 @@ +PersistentIndex | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias PersistentIndex

+
PersistentIndex: GenericIndex & {
    cacheEnabled: boolean;
    deduplicate: boolean;
    estimates: boolean;
    fields: string[];
    storedValues?: string[];
    type: "persistent";
}
+

An object representing a persistent index.

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/indexes.PrimaryIndex.html b/8.8.0/types/indexes.PrimaryIndex.html new file mode 100644 index 000000000..0916a0c97 --- /dev/null +++ b/8.8.0/types/indexes.PrimaryIndex.html @@ -0,0 +1,81 @@ +PrimaryIndex | arangojs - v8.8.0
+
+ +
+ +
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/indexes.TtlIndex.html b/8.8.0/types/indexes.TtlIndex.html new file mode 100644 index 000000000..e13f97586 --- /dev/null +++ b/8.8.0/types/indexes.TtlIndex.html @@ -0,0 +1,81 @@ +TtlIndex | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias TtlIndex

+
TtlIndex: GenericIndex & {
    expireAfter: number;
    fields: [string];
    selectivityEstimate: number;
    type: "ttl";
}
+

An object representing a TTL index.

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/transaction.TransactionAbortOptions.html b/8.8.0/types/transaction.TransactionAbortOptions.html new file mode 100644 index 000000000..4dc1c252a --- /dev/null +++ b/8.8.0/types/transaction.TransactionAbortOptions.html @@ -0,0 +1,72 @@ +TransactionAbortOptions | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias TransactionAbortOptions

+
TransactionAbortOptions: {
    allowDirtyRead?: boolean;
}
+

Options for how the transaction should be aborted.

+
+
+

Type declaration

+
    +
  • +
    Optional allowDirtyRead?: boolean
    +

    If set to true, the request will explicitly permit ArangoDB to return a +potentially dirty or stale result and arangojs will load balance the +request without distinguishing between leaders and followers.

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/transaction.TransactionCommitOptions.html b/8.8.0/types/transaction.TransactionCommitOptions.html new file mode 100644 index 000000000..52770f482 --- /dev/null +++ b/8.8.0/types/transaction.TransactionCommitOptions.html @@ -0,0 +1,72 @@ +TransactionCommitOptions | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias TransactionCommitOptions

+
TransactionCommitOptions: {
    allowDirtyRead?: boolean;
}
+

Options for how the transaction should be committed.

+
+
+

Type declaration

+
    +
  • +
    Optional allowDirtyRead?: boolean
    +

    If set to true, the request will explicitly permit ArangoDB to return a +potentially dirty or stale result and arangojs will load balance the +request without distinguishing between leaders and followers.

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/transaction.TransactionStatus.html b/8.8.0/types/transaction.TransactionStatus.html new file mode 100644 index 000000000..4211bb353 --- /dev/null +++ b/8.8.0/types/transaction.TransactionStatus.html @@ -0,0 +1,75 @@ +TransactionStatus | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias TransactionStatus

+
TransactionStatus: {
    id: string;
    status: "running" | "committed" | "aborted";
}
+

Status of a given transaction.

+

See also TransactionDetails.

+
+
+

Type declaration

+
    +
  • +
    id: string
    +

    Unique identifier of the transaction.

    +
  • +
  • +
    status: "running" | "committed" | "aborted"
    +

    Status of the transaction.

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/view.ArangoSearchViewDescription.html b/8.8.0/types/view.ArangoSearchViewDescription.html new file mode 100644 index 000000000..557747f23 --- /dev/null +++ b/8.8.0/types/view.ArangoSearchViewDescription.html @@ -0,0 +1,83 @@ +ArangoSearchViewDescription | arangojs - v8.8.0
+
+ +
+ +
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/view.ArangoSearchViewLink.html b/8.8.0/types/view.ArangoSearchViewLink.html new file mode 100644 index 000000000..2158cf4d6 --- /dev/null +++ b/8.8.0/types/view.ArangoSearchViewLink.html @@ -0,0 +1,102 @@ +ArangoSearchViewLink | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias ArangoSearchViewLink

+
ArangoSearchViewLink: {
    analyzers: string[];
    cache: boolean;
    fields: Record<string, ArangoSearchViewLink>;
    includeAllFields: boolean;
    nested?: Record<string, ArangoSearchViewLink>;
    storeValues: "none" | "id";
    trackListPositions: boolean;
}
+

A link definition for an ArangoSearch View.

+
+
+

Type declaration

+
    +
  • +
    analyzers: string[]
  • +
  • +
    cache: boolean
  • +
  • +
    fields: Record<string, ArangoSearchViewLink>
  • +
  • +
    includeAllFields: boolean
  • +
  • +
    Optional nested?: Record<string, ArangoSearchViewLink>
  • +
  • +
    storeValues: "none" | "id"
  • +
  • +
    trackListPositions: boolean
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/view.ArangoSearchViewLinkOptions.html b/8.8.0/types/view.ArangoSearchViewLinkOptions.html new file mode 100644 index 000000000..35d82972f --- /dev/null +++ b/8.8.0/types/view.ArangoSearchViewLinkOptions.html @@ -0,0 +1,133 @@ +ArangoSearchViewLinkOptions | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias ArangoSearchViewLinkOptions

+
ArangoSearchViewLinkOptions: {
    analyzers?: string[];
    cache?: boolean;
    fields?: Record<string, ArangoSearchViewLinkOptions>;
    inBackground?: boolean;
    includeAllFields?: boolean;
    nested?: Record<string, ArangoSearchViewLinkOptions>;
    storeValues?: "none" | "id";
    trackListPositions?: boolean;
}
+

A link definition for an ArangoSearch View.

+
+
+

Type declaration

+
    +
  • +
    Optional analyzers?: string[]
    +

    A list of names of Analyzers to apply to values of processed document +attributes.

    +

    Default: ["identity"]

    +
  • +
  • +
    Optional cache?: boolean
    +

    (Enterprise Edition only.) If set to true, then field normalization +values will always be cached in memory.

    +

    Default: false

    +
  • +
  • +
    Optional fields?: Record<string, ArangoSearchViewLinkOptions>
    +

    An object mapping names of attributes to process for each document to +ArangoSearchViewLinkOptions definitions.

    +
  • +
  • +
    Optional inBackground?: boolean
    +

    If set to true, then no exclusive lock is used on the source collection +during View index creation, so that it remains basically available.

    +

    Default: false

    +
  • +
  • +
    Optional includeAllFields?: boolean
    +

    If set to true, all document attributes will be processed, otherwise +only the attributes in fields will be processed.

    +

    Default: false

    +
  • +
  • +
    Optional nested?: Record<string, ArangoSearchViewLinkOptions>
    +

    (Enterprise Edition only.) An object mapping attribute names to +ArangoSearchViewLinkOptions definitions to index sub-objects +stored in an array.

    +
  • +
  • +
    Optional storeValues?: "none" | "id"
    +

    Controls how the view should keep track of the attribute values.

    +

    Default: "none"

    +
  • +
  • +
    Optional trackListPositions?: boolean
    +

    If set to true, the position of values in array values will be tracked, +otherwise all values in an array will be treated as equal alternatives.

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/view.ArangoSearchViewPatchPropertiesOptions.html b/8.8.0/types/view.ArangoSearchViewPatchPropertiesOptions.html new file mode 100644 index 000000000..3c9be618b --- /dev/null +++ b/8.8.0/types/view.ArangoSearchViewPatchPropertiesOptions.html @@ -0,0 +1,85 @@ +ArangoSearchViewPatchPropertiesOptions | arangojs - v8.8.0
+
+ +
+ +
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/view.ArangoSearchViewProperties.html b/8.8.0/types/view.ArangoSearchViewProperties.html new file mode 100644 index 000000000..f9b9912dc --- /dev/null +++ b/8.8.0/types/view.ArangoSearchViewProperties.html @@ -0,0 +1,85 @@ +ArangoSearchViewProperties | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias ArangoSearchViewProperties

+
ArangoSearchViewProperties: ArangoSearchViewDescription & {
    cleanupIntervalStep: number;
    commitIntervalMsec: number;
    consolidationIntervalMsec: number;
    consolidationPolicy: TierConsolidationPolicy | BytesAccumConsolidationPolicy;
    links: Record<string, Omit<ArangoSearchViewLink, "nested">>;
    optimizeTopK: string[];
    primaryKeyCache: boolean;
    primarySort: {
        direction: Direction;
        field: string;
    }[];
    primarySortCache: boolean;
    primarySortCompression: Compression;
    storedValues: {
        cache: boolean;
        compression: Compression;
        fields: string[];
    }[];
    writebufferActive: number;
    writebufferIdle: number;
    writebufferSizeMax: number;
}
+

Properties of an ArangoSearch View.

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/view.ArangoSearchViewPropertiesOptions.html b/8.8.0/types/view.ArangoSearchViewPropertiesOptions.html new file mode 100644 index 000000000..2d4e8bc62 --- /dev/null +++ b/8.8.0/types/view.ArangoSearchViewPropertiesOptions.html @@ -0,0 +1,115 @@ +ArangoSearchViewPropertiesOptions | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias ArangoSearchViewPropertiesOptions

+
ArangoSearchViewPropertiesOptions: {
    cleanupIntervalStep?: number;
    commitIntervalMsec?: number;
    consolidationIntervalMsec?: number;
    consolidationPolicy?: TierConsolidationPolicy;
    links?: Record<string, Omit<ArangoSearchViewLinkOptions, "nested">>;
}
+

Options for modifying the properties of an ArangoSearch View.

+
+
+

Type declaration

+
    +
  • +
    Optional cleanupIntervalStep?: number
    +

    How many commits to wait between removing unused files.

    +

    Default: 2

    +
  • +
  • +
    Optional commitIntervalMsec?: number
    +

    How long to wait between commiting View data store changes and making +documents visible to queries.

    +

    Default: 1000

    +
  • +
  • +
    Optional consolidationIntervalMsec?: number
    +

    How long to wait between applying the consolidationPolicy.

    +

    Default: 10000

    +
  • +
  • +
    Optional consolidationPolicy?: TierConsolidationPolicy
    +

    Consolidation policy to apply for selecting which segments should be +merged.

    +

    Default: { type: "tier" }

    +
  • +
  • +
    Optional links?: Record<string, Omit<ArangoSearchViewLinkOptions, "nested">>
    +

    An object mapping names of linked collections to +ArangoSearchViewLinkOptions definitions.

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/view.BytesAccumConsolidationPolicy.html b/8.8.0/types/view.BytesAccumConsolidationPolicy.html new file mode 100644 index 000000000..cee0bc605 --- /dev/null +++ b/8.8.0/types/view.BytesAccumConsolidationPolicy.html @@ -0,0 +1,100 @@ +BytesAccumConsolidationPolicy | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias BytesAccumConsolidationPolicy

+
BytesAccumConsolidationPolicy: {
    threshold?: number;
    type: "bytes_accum";
}
+

Policy to consolidate based on segment byte size and live document count as +dictated by the customization attributes.

+ +

Deprecated

The bytes_accum consolidation policy was deprecated in +ArangoDB 3.7 and should be replaced with the tier consolidation policy.

+
+
+

Type declaration

+
    +
  • +
    Optional threshold?: number
    +

    Must be in the range of 0.0 to 1.0.

    +
  • +
  • +
    type: "bytes_accum"
    +

    Type of consolidation policy.

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/view.Compression.html b/8.8.0/types/view.Compression.html new file mode 100644 index 000000000..dd0294be7 --- /dev/null +++ b/8.8.0/types/view.Compression.html @@ -0,0 +1,85 @@ +Compression | arangojs - v8.8.0
+
+ +
+ +
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/view.CreateArangoSearchViewOptions.html b/8.8.0/types/view.CreateArangoSearchViewOptions.html new file mode 100644 index 000000000..c2f74776b --- /dev/null +++ b/8.8.0/types/view.CreateArangoSearchViewOptions.html @@ -0,0 +1,85 @@ +CreateArangoSearchViewOptions | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias CreateArangoSearchViewOptions

+
CreateArangoSearchViewOptions: ArangoSearchViewPropertiesOptions & {
    optimizeTopK?: string[];
    primaryKeyCache?: boolean;
    primarySort?: ({
        direction: Direction;
        field: string;
    } | {
        asc: boolean;
        field: string;
    })[];
    primarySortCache?: boolean;
    primarySortCompression?: Compression;
    storedValues?: ArangoSearchViewStoredValueOptions[] | string[] | string[][];
    type: "arangosearch";
    writebufferActive?: number;
    writebufferIdle?: number;
    writebufferSizeMax?: number;
}
+

Options for creating an ArangoSearch View.

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/view.CreateSearchAliasViewOptions.html b/8.8.0/types/view.CreateSearchAliasViewOptions.html new file mode 100644 index 000000000..f9f0a97c1 --- /dev/null +++ b/8.8.0/types/view.CreateSearchAliasViewOptions.html @@ -0,0 +1,85 @@ +CreateSearchAliasViewOptions | arangojs - v8.8.0
+
+ +
+ +
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/view.CreateViewOptions.html b/8.8.0/types/view.CreateViewOptions.html new file mode 100644 index 000000000..8c2e206c6 --- /dev/null +++ b/8.8.0/types/view.CreateViewOptions.html @@ -0,0 +1,85 @@ +CreateViewOptions | arangojs - v8.8.0
+
+ +
+ +
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/view.Direction.html b/8.8.0/types/view.Direction.html new file mode 100644 index 000000000..20975d477 --- /dev/null +++ b/8.8.0/types/view.Direction.html @@ -0,0 +1,85 @@ +Direction | arangojs - v8.8.0
+
+ +
+ +
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/view.GenericViewDescription.html b/8.8.0/types/view.GenericViewDescription.html new file mode 100644 index 000000000..3be65c95f --- /dev/null +++ b/8.8.0/types/view.GenericViewDescription.html @@ -0,0 +1,100 @@ +GenericViewDescription | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias GenericViewDescription

+
GenericViewDescription: {
    globallyUniqueId: string;
    id: string;
    name: string;
}
+

Generic description of a View.

+
+
+

Type declaration

+
    +
  • +
    globallyUniqueId: string
    +

    A globally unique identifier for this View.

    +
  • +
  • +
    id: string
    +

    An identifier for this View.

    +
  • +
  • +
    name: string
    +

    Name of the View.

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/view.SearchAliasViewDescription.html b/8.8.0/types/view.SearchAliasViewDescription.html new file mode 100644 index 000000000..4dee85348 --- /dev/null +++ b/8.8.0/types/view.SearchAliasViewDescription.html @@ -0,0 +1,83 @@ +SearchAliasViewDescription | arangojs - v8.8.0
+
+ +
+ +
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/view.SearchAliasViewIndexOptions.html b/8.8.0/types/view.SearchAliasViewIndexOptions.html new file mode 100644 index 000000000..bb977c5c1 --- /dev/null +++ b/8.8.0/types/view.SearchAliasViewIndexOptions.html @@ -0,0 +1,96 @@ +SearchAliasViewIndexOptions | arangojs - v8.8.0
+
+ +
+ +
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/view.SearchAliasViewPatchIndexOptions.html b/8.8.0/types/view.SearchAliasViewPatchIndexOptions.html new file mode 100644 index 000000000..729cee5ad --- /dev/null +++ b/8.8.0/types/view.SearchAliasViewPatchIndexOptions.html @@ -0,0 +1,85 @@ +SearchAliasViewPatchIndexOptions | arangojs - v8.8.0
+
+ +
+ +
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/view.SearchAliasViewPatchPropertiesOptions.html b/8.8.0/types/view.SearchAliasViewPatchPropertiesOptions.html new file mode 100644 index 000000000..2c242c935 --- /dev/null +++ b/8.8.0/types/view.SearchAliasViewPatchPropertiesOptions.html @@ -0,0 +1,92 @@ +SearchAliasViewPatchPropertiesOptions | arangojs - v8.8.0
+
+ +
+ +
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/view.SearchAliasViewProperties.html b/8.8.0/types/view.SearchAliasViewProperties.html new file mode 100644 index 000000000..96dbeef05 --- /dev/null +++ b/8.8.0/types/view.SearchAliasViewProperties.html @@ -0,0 +1,85 @@ +SearchAliasViewProperties | arangojs - v8.8.0
+
+ +
+ +
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/view.SearchAliasViewPropertiesOptions.html b/8.8.0/types/view.SearchAliasViewPropertiesOptions.html new file mode 100644 index 000000000..991c92c0e --- /dev/null +++ b/8.8.0/types/view.SearchAliasViewPropertiesOptions.html @@ -0,0 +1,92 @@ +SearchAliasViewPropertiesOptions | arangojs - v8.8.0
+
+ +
+ +
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/view.TierConsolidationPolicy.html b/8.8.0/types/view.TierConsolidationPolicy.html new file mode 100644 index 000000000..fd4489c67 --- /dev/null +++ b/8.8.0/types/view.TierConsolidationPolicy.html @@ -0,0 +1,121 @@ +TierConsolidationPolicy | arangojs - v8.8.0
+
+ +
+
+
+
+ +

Type alias TierConsolidationPolicy

+
TierConsolidationPolicy: {
    minScore?: number;
    segmentsBytesFloor?: number;
    segmentsBytesMax?: number;
    segmentsMax?: number;
    segmentsMin?: number;
    type: "tier";
}
+

Policy to consolidate if the sum of all candidate segment byte size is less +than the total segment byte size multiplied by a given threshold.

+
+
+

Type declaration

+
    +
  • +
    Optional minScore?: number
    +

    Consolidation candidates with a score less than this value will be +filtered out.

    +

    Default: 0

    +
  • +
  • +
    Optional segmentsBytesFloor?: number
    +

    Size below which all segments are treated as equivalent.

    +

    Default: 2097152 (2 MiB)

    +
  • +
  • +
    Optional segmentsBytesMax?: number
    +

    Maximum allowed size of all consolidation segments.

    +

    Default: 5368709120 (5 GiB)

    +
  • +
  • +
    Optional segmentsMax?: number
    +

    Maximum number of segments that are evaluated as candidates for +consolidation.

    +

    Default: 10

    +
  • +
  • +
    Optional segmentsMin?: number
    +

    Minimum number of segments that are evaluated as candidates for +consolidation.

    +

    Default: 1

    +
  • +
  • +
    type: "tier"
    +

    Type of consolidation policy.

    +
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/view.ViewDescription.html b/8.8.0/types/view.ViewDescription.html new file mode 100644 index 000000000..25063380f --- /dev/null +++ b/8.8.0/types/view.ViewDescription.html @@ -0,0 +1,83 @@ +ViewDescription | arangojs - v8.8.0
+
+ +
+ +
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/view.ViewPatchPropertiesOptions.html b/8.8.0/types/view.ViewPatchPropertiesOptions.html new file mode 100644 index 000000000..3d6c2b49d --- /dev/null +++ b/8.8.0/types/view.ViewPatchPropertiesOptions.html @@ -0,0 +1,85 @@ +ViewPatchPropertiesOptions | arangojs - v8.8.0
+
+ +
+ +
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/view.ViewProperties.html b/8.8.0/types/view.ViewProperties.html new file mode 100644 index 000000000..ce7352aaf --- /dev/null +++ b/8.8.0/types/view.ViewProperties.html @@ -0,0 +1,83 @@ +ViewProperties | arangojs - v8.8.0
+
+ +
+ +
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/8.8.0/types/view.ViewPropertiesOptions.html b/8.8.0/types/view.ViewPropertiesOptions.html new file mode 100644 index 000000000..3929aa21b --- /dev/null +++ b/8.8.0/types/view.ViewPropertiesOptions.html @@ -0,0 +1,85 @@ +ViewPropertiesOptions | arangojs - v8.8.0
+
+ +
+ +
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/_data/versions.json b/_data/versions.json index b206170c0..a21b50606 100644 --- a/_data/versions.json +++ b/_data/versions.json @@ -1 +1 @@ -{"all":["8.7.0","8.6.0","8.5.0","8.4.1","8.4.0","8.3.1","8.3.0","8.2.1","8.2.0","8.1.0","8.0.0","8.0.0-rc.1","7.8.0","7.7.0","7.6.1","7.6.0","7.5.0","7.5.0-preview-arangodb.3.8","7.4.0","7.3.0","7.2.0","7.1.1","7.1.0","7.0.2","7.0.1","7.0.0","7.0.0-rc.2","7.0.0-rc.1","7.0.0-rc.0","7.0.0-preview.1","7.0.0-preview.0","6.14.1"],"stable":["8.7.0","8.6.0","8.5.0","8.4.1","8.4.0","8.3.1","8.3.0","8.2.1","8.2.0","8.1.0","8.0.0","7.8.0","7.7.0","7.6.1","7.6.0","7.5.0","7.4.0","7.3.0","7.2.0","7.1.1","7.1.0","7.0.2","7.0.1","7.0.0","6.14.1"]} +{"all":["8.8.0","8.7.0","8.6.0","8.5.0","8.4.1","8.4.0","8.3.1","8.3.0","8.2.1","8.2.0","8.1.0","8.0.0","8.0.0-rc.1","7.8.0","7.7.0","7.6.1","7.6.0","7.5.0","7.5.0-preview-arangodb.3.8","7.4.0","7.3.0","7.2.0","7.1.1","7.1.0","7.0.2","7.0.1","7.0.0","7.0.0-rc.2","7.0.0-rc.1","7.0.0-rc.0","7.0.0-preview.1","7.0.0-preview.0","6.14.1"],"stable":["8.8.0","8.7.0","8.6.0","8.5.0","8.4.1","8.4.0","8.3.1","8.3.0","8.2.1","8.2.0","8.1.0","8.0.0","7.8.0","7.7.0","7.6.1","7.6.0","7.5.0","7.4.0","7.3.0","7.2.0","7.1.1","7.1.0","7.0.2","7.0.1","7.0.0","6.14.1"]}