Mahuta

Махута

Mahuta (ранее известная как IPFS-Store) — это библиотека для агрегирования и консолидации файлов или документов, хранящихся вашим приложением в сети IPFS. Он предоставляет решение для удобного сбора, хранения, индексирования, кэширования и поиска данных IPFS, обрабатываемых вашей системой.

Статус проекта

Услуга	Владелец	Разработка
Статус ЭК
Тестовое покрытие
Бинтрей
Докер
Сонар

Функции

• Индексация : Mahuta хранит документы или файлы в IPFS и индексирует хэш с дополнительными метаданными.
• Обнаружение : проиндексированные документы и файлы можно искать с помощью сложных логических запросов или нечеткого/полнотекстового поиска.
• Масштабируемость : оптимизирован для крупномасштабных приложений, использующих механизм асинхронной записи и кэширования.
• Репликация : набор реплик можно настроить для репликации (закрепления) контента на нескольких узлах (стандартный узел IPFS или узел кластера IPFS).
• Мультиплатформенность : Mahuta можно использовать как простую встроенную библиотеку Java для вашего приложения на основе JVM или запускать как простой, масштабируемый и настраиваемый Rest API.

---

Начиная

Эти инструкции позволят вам запустить копию проекта на вашем локальном компьютере для целей разработки и тестирования.

Предварительные условия

Махута состоит из двух компонентов:

• узел 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. Настройте свой репозиторий весенних данных

 @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.

HTTP API с Docker

Предварительные условия

• Докер
• запустить IPFS и ElasticSearch с помощью Docker

Докер

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

Докер Составление

Ознакомьтесь с документацией по настройке HTTP-API Mahuta с помощью Docker.

Примеры

Чтобы получить доступ к документации по 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
  }
}