如何在 ArangoDB FOXX 中定义索引?

How to define an index in ArangoDB FOXX?

FOXX 应用程序可以自动创建索引吗?我有一个集合(模型),我需要一个字段用作性能的唯一索引。我可以在事后创建散列,但我只是想确保它在使用模型定义时不可用。如果是这样,我在哪里可以找到文档?

第二个问题是如何在 FOXX 中创建索引?我知道如何在 arangojs 中执行此操作,但我似乎无法在 FOXX 文档中找到它。刷这个问题。我想通了:db.collection.createIndex()。但是男孩隐藏在文档的 "misc" 部分的深处。

索引 API 不是 Foxx API 的一部分,而是一般的 ArangoDB API (Foxx 只是 ArangoDB 提供的用于构建和管理微服务的框架)并且可以找到在 ArangoDB 文档中:https://docs.arangodb.com/IndexHandling/WorkingWithIndexes.html

'use strict';
var myCollection = applicationContext.collection('my-data');
myCollection.ensureIndex({type: 'hash', fields: ['a', 'b'], unique: true});

在 ArangoDB 中 2.x Foxx 提供了集合和文档(即存储在这些集合中的数据集)的包装器,分别称为存储库和模型。每个存储库代表一个集合,每个模型代表一个文档。 ArangoDB 3.0 将提供一个新的、简化的 API,它通过鼓励您使用 ArangoDB 已经提供的基础集合 API 来消除这种额外的复杂性。

为了在 Foxx 存储库上使用特定于索引的方法(例如地理索引集合的地理查询),您需要使用额外的 indexes 属性 定义存储库,如下所示:

'use strict';
var Foxx = require('org/arangodb/foxx').Repository;
var MyModel = Foxx.Model.extend({/* ... */});
var MyRepo = Foxx.Repository.extend({
  indexes: [
    // same syntax as collection.ensureIndex:
    {type: 'hash', fields: ['a', 'b'], unique: true}
  ]
});
var repo = new MyRepo(applicationContext.collection('my-data'), {
  model: MyModel
});

实例化存储库时(即调用 new MyRepo(/* ... */)),Foxx 将确保根据需要创建索引。

请参阅 https://docs.arangodb.com/Foxx/Develop/Repository.html#defining-indexes 中的文档。

或者,如果您不想使用 Foxx 存储库,您可以在创建集合后在设置脚本中简单地定义索引,使用上面的常规索引 API。无论哪种方式,您都不需要多次担心 运行 代码:如果索引已经存在,ensureIndex 将不执行任何操作。