Mahuta

馬胡塔

Mahuta （以前稱為 IPFS-Store）是一個函式庫，用於聚合和整合應用程式在 IPFS 網路上儲存的檔案或文件。它提供了一個解決方案，以方便的方式收集、儲存、索引、快取和搜尋系統處理的 IPFS 資料。

項目狀況

服務	掌握	發展
CI狀態
測試覆蓋率
賓特雷
碼頭工人
聲納

特徵

• 索引：Mahuta 將文件或文件儲存在 IPFS 上，並使用可選元資料對雜湊進行索引。
• 發現：可以使用複雜的邏輯查詢或模糊/全文搜尋來搜尋索引的文件和文件）
• 可擴展：使用非同步寫入機制和快取針對大規模應用程式進行最佳化
• 複製：副本集可以設定為跨多個節點（標準 IPFS 節點或 IPFS 叢集節點）複製（固定）內容
• 多平台：Mahuta 可以用作基於 JVM 的應用程式的簡單嵌入式 Java 程式庫，也可以作為簡單、可擴展且可配置的 Rest API 運行。

---

入門

這些說明將為您提供在本機電腦上啟動並執行的專案副本，以用於開發和測試目的。

先決條件

Mahuta 取決於兩個組成部分：

• IPFS 節點（go 或 js 實作）
• 搜尋引擎（目前僅支援ElasticSearch）

了解如何運行這兩個元件 首先運行 IPFS 和 ElasticSearch

Java函式庫

1. 導入 Maven 依賴項（核心模組 + 索引器）

< repository >
    < id >consensys-kauri</ id >
    < name >consensys-kauri</ name >
    < url >https://consensys.bintray.com/kauri/</ url >
</ repository >

< dependency >
    < groupId >net.consensys.mahuta</ groupId >
    < artifactId >mahuta-core</ artifactId >
    < version >${MAHUTA_VERSION}</ version >
</ dependency >
< dependency >
    < groupId >net.consensys.mahuta</ groupId >
    < artifactId >mahuta-indexing-elasticsearch</ artifactId >
    < version >${MAHUTA_VERSION}</ version >
</ dependency >

2. 配置 Mahuta 以連接到 IPFS 節點和索引器

 Mahuta mahuta = new MahutaFactory()
    .configureStorage(IPFSService.connect("localhost", 5001))
    .configureIndexer(ElasticSearchService.connect("localhost", 9300, "cluster-name"))
    .defaultImplementation();

3. 執行進階操作

 IndexingResponse response = mahuta.prepareStringIndexing("article", "## This is my first article")
    .contentType("text/markdown")
    .indexDocId("article-1")
    .indexFields(ImmutableMap.of("title", "First Article", "author", "greg"))
    .execute();
    
GetResponse response = mahuta.prepareGet()
    .indexName("article")
    .indexDocId("article-1")
    .loadFile(true)
    .execute();
    
SearchResponse response = mahuta.prepareSearch()
    .indexName("article")
    .query(Query.newQuery().equals("author", "greg"))
    .pageRequest(PageRequest.of(0, 20))
    .execute();

欲了解更多信息，Mahuta Java API

Spring數據

1. 導入 Maven 依賴項

 <dependency>
    <groupId>net.consensys.mahuta</groupId>
    <artifactId>mahuta-springdata</artifactId>
    <version>${MAHUTA_VERSION}</version>
</dependency>

2. 配置您的 spring 資料儲存庫

 @IPFSDocument(index = "article", indexConfiguration = "article_mapping.json", indexContent = true)
public class Article {
    
    @Id
    private String id;

    @Hash
    private String hash;

    @Fulltext
    private String title;

    @Fulltext
    private String content;

    @Indexfield
    private Date createdAt;

    @Indexfield
    private String createdBy;
}



public class ArticleRepository extends MahutaRepositoryImpl<Article, String> {

    public ArticleRepository(Mahuta mahuta) {
        super(mahuta);
    }
}

欲了解更多信息，Mahuta Spring Data

使用 Docker 的 HTTP API

先決條件

• 碼頭工人
• 使用 Docker 運行 IPFS 和 ElasticSearch

碼頭工人

 $ docker run -it --name mahuta  
    -p 8040:8040 
    -e MAHUTA_IPFS_HOST=ipfs 
    -e MAHUTA_ELASTICSEARCH_HOST=elasticsearch 
    gjeanmart/mahuta

Docker 組合

查看文件以使用 Docker 配置 Mahuta HTTP-API。

範例

若要存取 API 文檔，請前往 Mahuta HTTP API

建立索引article

• 樣品請求：

 curl -X POST 
  http://localhost:8040/mahuta/config/index/article 
  -H 'Content-Type: application/json' 

• 成功響應：

  • 代碼：200
    內容：

 {
    "status": "SUCCESS"
}

儲存和索引文章及其元數據

• 樣品請求：

 curl -X POST 
  'http://localhost:8040/mahuta/index' 
  -H 'content-type: application/json' 
  -d '{"content":"# Hello world,n this is my first file stored on **IPFS**","indexName":"article","indexDocId":"hello_world","contentType":"text/markdown","index_fields":{"title":"Hello world","author":"Gregoire Jeanmart","votes":10,"date_created":1518700549,"tags":["general"]}}'

• 成功響應：

  • 代碼：200
    內容：

 {
  "indexName": "article",
  "indexDocId": "hello_world",
  "contentId": "QmWHR4e1JHMs2h7XtbDsS9r2oQkyuzVr5bHdkEMYiqfeNm",
  "contentType": "text/markdown",
  "content": null,
  "pinned": true,
  "indexFields": {
    "title": "Hello world",
    "author": "Gregoire Jeanmart",
    "votes": 10,
    "createAt": 1518700549,
    "tags": [
      "general"
    ]
  },
  "status": "SUCCESS"
}

按查詢搜尋

• 樣品請求：

 curl -X POST 
 'http://localhost:8040/mahuta/query/search?index=article' 
 -H 'content-type: application/json' 
 -d '{"query":[{"name":"title","operation":"CONTAINS","value":"Hello"},{"name":"author.keyword","operation":"EQUALS","value":"Gregoire Jeanmart"},{"name":"votes","operation":"GT","value":"5"}]}'

• 成功響應：

  • 代碼：200
    內容：

 {
  "status": "SUCCESS",
  "page": {
    "pageRequest": {
      "page": 0,
      "size": 20,
      "sort": null,
      "direction": "ASC"
    },
    "elements": [
      {
        "metadata": {
          "indexName": "article",
          "indexDocId": "hello_world",
          "contentId": "Qmd6VkHiLbLPncVQiewQe3SBP8rrG96HTkYkLbMzMe6tP2",
          "contentType": "text/markdown",
          "content": null,
          "pinned": true,
          "indexFields": {
            "author": "Gregoire Jeanmart",
            "votes": 10,
            "title": "Hello world",
            "createAt": 1518700549,
            "tags": [
              "general"
            ]
          }
        },
        "payload": null
      }
    ],
    "totalElements": 1,
    "totalPages": 1
  }
}