Mahuta

마후타

Mahuta (이전의 IPFS-Store)는 IPFS 네트워크에서 애플리케이션에 의해 저장된 파일이나 문서를 집계하고 통합하는 라이브러리입니다. 시스템에서 처리하는 IPFS 데이터를 편리한 방법으로 수집, 저장, 색인화, 캐시 및 검색하는 솔루션을 제공합니다.

프로젝트 현황

서비스	주인	개발
CI 현황
테스트 범위
빈트레이
도커
소나

특징

• 인덱싱 : Mahuta는 IPFS에 문서나 파일을 저장하고 선택적 메타데이터를 사용하여 해시를 인덱싱합니다.
• 검색 : 복잡한 논리적 질의 또는 퍼지/전체 텍스트 검색을 이용하여 인덱싱된 문서 및 파일을 검색할 수 있습니다.
• 확장성 : 비동기 쓰기 메커니즘 및 캐싱을 사용하는 대규모 애플리케이션에 최적화됨
• 복제 : 복제 세트는 여러 노드(표준 IPFS 노드 또는 IPFS 클러스터 노드)에 걸쳐 콘텐츠를 복제(고정)하도록 구성할 수 있습니다.
• 다중 플랫폼 : Mahuta는 JVM 기반 애플리케이션을 위한 간단한 내장형 Java 라이브러리로 사용하거나 간단하고 확장 가능하며 구성 가능한 Rest API로 실행할 수 있습니다.

---

시작하기

이 지침은 개발 및 테스트 목적으로 로컬 컴퓨터에서 프로젝트 사본을 시작하고 실행하는 데 도움이 됩니다.

전제 조건

Mahuta는 두 가지 구성 요소에 따라 달라집니다.

• IPFS 노드(go 또는 js 구현)
• 검색 엔진(현재 ElasticSearch만 지원됨)

먼저 IPFS와 ElasticSearch를 실행하여 두 구성요소를 실행하는 방법을 알아보세요.

자바 라이브러리

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. IPFS 노드 및 인덱서에 연결하도록 Mahuta 구성

 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를 참조하세요.

스프링 데이터

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 데이터를 참조하세요.

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로 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
  }
}