Microsoft MVP성태의 닷넷 이야기
글쓴 사람
홈페이지
첨부 파일
 

윈도우 환경에서 curl.exe를 이용한 elasticsearch 6.x 기본 사용법

사용을 위해 elasticsearch를 설치해야겠죠? ^^ 윈도우 10 운영체제에 다음과 같이 간단하게 설치할 수 있습니다.

1. Java 8 (x64) 설치 (JDK 또는 JRE)

2. https://www.elastic.co/downloads/elasticsearch로부터 ".zip" 파일 다운로드
 
    6.3.2 버전
    https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-6.3.2.zip

3. bin\elasticsearch.bat 파일을 메모장에서 편집(자신의 환경에 맞게 경로 설정)

    SET JAVA_HOME=C:\Program Files\Java\jdk1.8.0_131

4. bin\elasticsearch.bat 파일 실행

5. 다음의 명령어를 실행해서 정상 동작하는지 확인

    curl http://localhost:9200/

    그 결과로 아래와 같은 식의 내용이 출력되면 OK!

    {
      "name" : "Vld1Cby",
      "cluster_name" : "elasticsearch",
      "cluster_uuid" : "WYC...[생략]...WXQ",
      "version" : {
        "number" : "6.3.2",
        "build_flavor" : "default",
        "build_type" : "zip",
        "build_hash" : "053779d",
        "build_date" : "2018-07-20T05:20:23.451332Z",
        "build_snapshot" : false,
        "lucene_version" : "7.3.1",
        "minimum_wire_compatibility_version" : "5.6.0",
        "minimum_index_compatibility_version" : "5.0.0"
      },
      "tagline" : "You Know, for Search"
    }

이것으로 설치가 모두 끝났습니다. ^^




이제 사용법을 알아야 하겠죠? ^^

근데, 사용법이 정말 쉽습니다. 약간의 웹 검색만 해보면 대충 알 수 있을 정도입니다. 물론 고급 사용자의 위치까지 가려면 어느 정도 더 공부를 해야겠지만 초기 개념만 잡는 식이라면 쉽게 테스트하면서 익힐 수 있습니다.

기존의 관계형 데이터베이스 사용자를 위해 DB와 비교해서 설명하면 대충 다음과 같습니다.

elasticsearch의 index == DB의 데이터베이스
elasticsearch의 type == DB의 테이블

그리고 이를 위한 RESTful 쿼리가 다음과 같은 형식으로 제공됩니다.

http://host:port/(index)/(type)/(action|id)

여기서 host:port는 elasticsearch를 localhost에서 테스트하는 경우 (특별히 바꾸지 않았다면) 다음과 같이 정해집니다.

http://localhost:9200/

(index)와 (type)은 명시적으로 생성해 주거나 아니면, 그냥 데이터를 전달해서 스키마를 elasticsearch가 자동으로 추론하도록 만들 수 있습니다. 예를 들어, 여러분들이 가진 데이터 중에 "회원 목록"이 있다고 가정해 보겠습니다. 그리고 회원에 대한 DB 스키마는 다음과 같습니다.

name: string
age: int
address: string
registered: date

자동 추론 방법으로 (index)/(type)을 생성하고 싶다면 다음과 같이 그냥 데이터를 HTTP PUT 메서드를 이용해 elasticsearch에 던지면 됩니다.

curl -XPUT "http://localhost:9200/my_org/member/1" -H "Content-Type: application/json" -d 
"{ 
    "name" : "tester", 
    "age": 16, 
    "address": "seoul KOREA", 
    "registered" : "2017-04-29T10:16:00" 
}"

curl -XPUT "http://localhost:9200/my_org/member/1" -H "Content-Type: application/json"  -d "{ \"name\" : \"tester\", \"age\": 16, \"address\": \"seoul KOREA\", \"registered\" : \"2017-04-29T10:16:00\" }"

{"_index":"my_org","_type":"member","_id":"1","_version":1,"result":"created","_shards":{"total":2,"successful":1,"failed":0},"_seq_no":0,"_primary_term":1}

// 서버 로그
[2018-08-09T09:26:19,168][INFO ][o.e.c.m.MetaDataMappingService] [Vld1Cby] [my_org/g55350WDSDaHKWMBm9Yi8Q] create_mapping [member]

그럼, elasticsearch는 URL의 (index)에 해당하는 "my_org" 인덱스가 있는지 검사하고 없으면 생성합니다. 그다음 URL의 (type)에 해당하는 스키마가 있는지 역시 검사해 보고 없으면 HTTP PUT의 Body로 들어온 JSON 데이터를 보고 스키마를 유추해 "member"라는 이름으로 생성해 둡니다. 마지막의 (action|id)는 해당 데이터에 대한 식별자가 됩니다.

혹시 저 회원의 주소(address)가 변경되었다면 어떻게 해야 할까요? 당연히 (index), (type), (action|id)만 알고 있다면 다음과 같은 식으로 덮어쓰는 것이 가능합니다.

curl -XPUT "http://localhost:9200/my_org/member/1" -H "Content-Type: application/json" -d 
"{ 
    "name" : "tester", 
    "age": 16, 
    "address": "daejeon KOREA", 
    "registered":"2017-04-29T10:16:00" 
}"

C:\temp> curl -XPUT "http://localhost:9200/my_org/member/1" -H "Content-Type: application/json" -d "{ \"name\" : \"tester\", \"age\": 16, \"address\": \"daejeon KOREA\", \"registered\":\"2017-04-29T10:16:00\" }"

{"_index":"my_org","_type":"member","_id":"1","_version":2,"result":"updated","_shards":{"total":2,"successful":1,"failed":0},"_seq_no":1,"_primary_term":1}

혹은, 특정 필드만 변경되었다면 그것만 전달하는 것도 가능합니다.

curl -XPUT "http://localhost:9200/my_org/member/1" -H "Content-Type: application/json" -d "{ \"address\": \"dae3jeon KOREA\" }"

{"_index":"my_org","_type":"member","_id":"1","_version":2,"result":"updated","_shards":{"total":2,"successful":1,"failed":0},"_seq_no":1,"_primary_term":1}

정보를 가져오는 것도 GET 명령어로 가능합니다.

curl -XGET "http://localhost:9200/my_org/member/1"

{"_index":"my_org","_type":"member","_id":"1","_version":1,"found":true,"_source":{ "name" : "tester", "age": 16, "address": "dae3jeon KOREA", "registered":"2017-04-29T10:16:00" }}

대충 어떤 식인지 아시겠죠? ^^




elasticsearch가 추론 기능이 있다고는 하지만 당연히 완벽하지 않습니다. 예를 들어, text 타입으로 판정되는 field에 대해서는 색인 작업을 하는 것이 기본 설정입니다. 따라서, "member" 타입의 경우 "name", "address"는 모두 색인 작업을 거치게 됩니다. 그런데, 만약 여기서 "name" 필드가 색인 작업이 필요 없다고 가정해 보겠습니다. 그렇다면 성능을 위해서는 당연히 "name" 필드의 문자열에 대해서는 색인 작업을 하지 않아도 됩니다. 이런 식으로 개발자가 이미 해당 스키마를 잘 알고 있는 경우 최적화된 (type)을 지정해 주는 것이 가능합니다.

실습을 위해 이전에 설정한 인덱스(DB)를 삭제해 보겠습니다.

curl -XDELETE "http://localhost:9200/my_org/"

{"acknowledged":true}

// 서버 로그
[2018-08-09T09:39:46,322][INFO ][o.e.c.m.MetaDataDeleteIndexService] [Vld1Cby] [my_org/g55350WDSDaHKWMBm9Yi8Q] deleting index

자, 다시 처음부터 시작한다고 가정하고 (index)를 먼저 생성합니다. (아래는 기본값으로 index를 생성하는데, 고급 사용자라면 좀 더 사용자 정의할 수 있는 설정들이 있습니다.)

curl -XPUT "http://localhost:9200/my_org/" -H "Content-Type: application/json" -d "{
    "my_org": {
        "settings" : {
            "index" : {
            }
        }
    }
}"

curl -XPUT "http://localhost:9200/my_org/" -H "Content-Type: application/json" -d "{ \"my_org\": { \"settings\" : { \"index\" : { } } } }"

{"acknowledged":true,"shards_acknowledged":true,"index":"my_org"}

// 서버 로그
[2018-08-09T10:05:33,163][INFO ][o.e.c.m.MetaDataCreateIndexService] [Vld1Cby] [my_org] creating index, cause [api], templates [], shards [5]/[1], mappings []

그다음 해당 (index)에 소속된 (type)인 member에 대해 스키마를 지정해 줍니다.

curl -XPUT "http://localhost:9200/my_org/member/_mapping" -H "Content-Type: application/json" -d "{
    "member" : {
        "properties" : {
            "name" : {"type" : "text", "index" : "false"},
            "age" : {"type" : "integer"},
            "address" : {"type" : "text"},
            "registered" : {"type" : "date"}
        }
    }
}"

curl -XPUT "http://localhost:9200/my_org/member/_mapping" -H "Content-Type: application/json" -d "{ \"member\" : { \"properties\" : { \"name\" : {\"type\" : \"text\", \"index\" : \"false\"}, \"age\" : {\"type\" : \"integer\"}, \"address\" : {\"type\" : \"text\"}, \"registered\" : {\"type\" : \"date\"} } } }"

{"acknowledged":true}

// 서버 로그
[2018-08-09T10:20:05,995][INFO ][o.e.c.m.MetaDataMappingService] [Vld1Cby] [my_org/RNr83v64ROSaqqTcvamZoA] create_mapping [member]

해당 type이 잘 정의가 되었는지 다음과 같이 확인할 수 있습니다.

curl -XGET "http://localhost:9200/my_org/member/_mapping"

{"my_org":{"mappings":{"member":{"properties":{"address":{"type":"text"},"age":{"type":"integer"},"name":{"type":"text","index":false},"registered":{"type":"date"}}}}}}

// 없는 경우,
{
    "error":
        {
            "root_cause":
                [
                    {
                        "type":"type_missing_exception",
                        "reason":"type[[member]] missing",
                        "index_uuid":"_na_","index":"_all"
                    }
                ],
                "type":"type_missing_exception",
                "reason":"type[[member]] missing",
                "index_uuid":"_na_",
                "index":"_all"
        },
        "status":404
}

(index)와 (type) 스키마가 생성되었으니, 이제 예전과 똑같이 데이터를 넣어주면 됩니다.

curl -XPUT "http://localhost:9200/my_org/member/1" -H "Content-Type: application/json" -d "{  
    "name" : "tester",
    "age": 16,
    "address": "daejeon KOREA",
    "registered":"2017-04-29T10:16:00"
}"

curl -XPUT "http://localhost:9200/my_org/member/1" -H "Content-Type: application/json" -d "{ \"name\" : \"tester\", \"age\": 16, \"address\": \"daejeon KOREA\", \"registered\":\"2017-04-29T10:16:00\" }"

{"_index":"my_org","_type":"member","_id":"1","_version":1,"result":"created","_shards":{"total":2,"successful":1,"failed":0},"_seq_no":0,"_primary_term":1}

참고로, 타입(type)을 삭제하는 것은 불가능합니다.

Delete Mapping
; https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-delete-mapping.html

It is no longer possible to delete the mapping for a type. Instead you should delete the index and recreate it with the new mappings.

삭제하려고 했을 때의 반환 메시지는 다음과 같습니다.

curl -XDELETE "http://localhost:9200/my_org/member/_mapping"

{
    "error":"Incorrect HTTP method for uri [/my_org/member/_mapping] and method [DELETE], allowed: [GET, PUT, POST]",
    "status":405
}

curl -XDELETE "http://localhost:9200/my_org/member"
{
    "error":"Incorrect HTTP method for uri [/my_org/member] and method [DELETE], allowed: [POST]",
    "status":405
}

어차피 index 하나에 type 하나만을 생성할 수 있으므로 type을 지울 의도라면 index를 지우는 걸로 처리할 수 있습니다.




마지막으로, 검색 엔진을 설치한 최종 목적인 "검색"을 해봐야 할 것입니다.

가령, 주소(address)가 "daejon"을 포함하고 있는 사람을 검색하고 싶다면 다음과 같이 HTTP 쿼리를 날리면 됩니다.

curl -XGET "http://localhost:9200/my_org/member/_search" -H "Content-Type: application/json" -d "{
    "query": {
        "match": { "address": "daejeon" }
    }
}"

curl -XGET "http://localhost:9200/my_org/member/_search" -H "Content-Type: application/json" -d "{ \"query\": { \"match\": { \"address\": \"daejeon\" } } }"

{"took":87,"timed_out":false,"_shards":{"total":5,"successful":5,"skipped":0,"failed":0},"hits":{"total":1,"max_score":0.2876821,"hits":[{"_index":"my_org","_type":"member","_id":"1","_score":0.2876821,"_source":{ "name" : "tester", "age": 16, "address": "daejeon KOREA", "registered":"2017-04-29T10:16:00" }}]}}

보는 바와 같이 "hits"의 "total" 속성을 통해 몇 건의 데이터가 검색되었는지 알 수 있습니다. 반면, 검색 결과가 없다면 다음과 같은 응답을 받게 됩니다.

curl -XGET "http://localhost:9200/my_org/member/_search" -H "Content-Type: application/json" -d "{ \"query\": { \"match\": { \"address\": \"dae3jeon\" } } }"

{"took":9,"timed_out":false,"_shards":{"total":5,"successful":5,"skipped":0,"failed":0},"hits":{"total":0,"max_score":null,"hits":[]}}

보다 자세한 검색 옵션은 다음의 글을 참조하세요. ^^

엘라스틱서치 쿼리 DSL 기초
; http://bakyeono.net/post/2016-08-20-elasticsearch-querydsl-basic.html

이것으로 전체적인 CRUD 작업을 한 번씩 해봤으니 감이 잡히실 거라고 봅니다. ^^ 생각보다 그다지 어렵지 않죠? 아마도 그래서 더 ElasticSearch가 유명해진 것이 아닌가 싶습니다.

이외에, 웹 UI로 ElasticSearch를 편하게 관리할 수 있는 ElasticSearch plug-in이 있습니다. (도움말로 봐서는 Elasticsearch 버전 6 이후는 지원이 안되는 것 같습니다.)

ElasticSearch 5.0 Plugin Head 설치
; http://jjig810906.tistory.com/5




(이하의 글은 오류나 시행착오 내용입니다.)

제 컴퓨터에 다음과 같은 설정을 했더니,

영문 설정의 Windows 10 명령행 창(cmd.exe)의 한글 지원
; https://www.sysnet.pe.kr/2/0/11559

elasticsearch.bat 실행 시 다음과 같은 오류가 발생합니다.

2018-08-09 09:06:00,629 main ERROR Unable to inject fields into builder class for plugin type class org.apache.logging.log4j.core.appender.ConsoleAppender, element Console. java.nio.charset.UnsupportedCharsetException: cp65001
        at java.nio.charset.Charset.forName(Charset.java:531)
        at org.apache.logging.log4j.util.PropertiesUtil.getCharsetProperty(PropertiesUtil.java:146)
        at org.apache.logging.log4j.util.PropertiesUtil.getCharsetProperty(PropertiesUtil.java:134)
        at org.apache.logging.log4j.core.appender.ConsoleAppender$Target.getCharset(ConsoleAppender.java:85)
        at org.apache.logging.log4j.core.appender.ConsoleAppender$Target$1.getDefaultCharset(ConsoleAppender.java:71)
        ...[생략]...
        at org.elasticsearch.bootstrap.Elasticsearch.main(Elasticsearch.java:91)
        at org.elasticsearch.bootstrap.Elasticsearch.main(Elasticsearch.java:84)

Unable to get Charset 'sun.stdout.encoding', using default UTF-8
java.nio.charset.UnsupportedCharsetException: cp65001
        at java.nio.charset.Charset.forName(Charset.java:531)
        at org.apache.logging.log4j.util.PropertiesUtil.getCharsetProperty(PropertiesUtil.java:172)
        at org.apache.logging.log4j.core.appender.ConsoleAppender$Target.getCharset(ConsoleAppender.java:89)
        ...[생략]...
        at org.elasticsearch.bootstrap.Elasticsearch.main(Elasticsearch.java:93)
        at org.elasticsearch.bootstrap.Elasticsearch.main(Elasticsearch.java:86)

윈도우에서의 65001 지원을 아직 모르는 것 같습니다. ^^ 일단, 다음과 같이 elasticsearch.bat 파일을 수정하는 걸로 임시 조치할 수 있습니다.

@echo off

chcp 949
SET JAVA_HOME=C:\Program Files\Java\jdk1.8.0_161

SETLOCAL enabledelayedexpansion
TITLE Elasticsearch 5.4.0

SET params='%*'
...[생략]...




오픈 소스 쪽 응용 프로그램을 다루다 보면, 마이크로소프트의 "하위 호환성"을 지켜주는 것이 얼마나 대단한 것인지를 알게 되는데요. elasticsearch를 5.x 버전에서 다루다가 6.x로 올렸더니 예전에 작성해 둔 스크립트들을 실행 중에 다음과 같은 오류가 발생했습니다.

"error": 
    {
        "root_cause":
            [
                {
                    "type":"mapper_parsing_exception",
                    "reason":"No handler for type [string] declared on field [name]"
                }
            ],
            "type":"mapper_parsing_exception",
            "reason":"No handler for type [string] declared on field [name]"},
            "status":400
    }"

"error":
    {
        "root_cause":
            [
                {
                    "type":"illegal_argument_exception",
                    "reason":"Could not convert [name.index] to boolean"
                }
            ],
            "type":"illegal_argument_exception",
            "reason":"Could not convert [name.index] to boolean",
            "caused_by":
                {
                    "type":"illegal_argument_exception",
                    "reason":"Failed to parse value [not_analyzed] as only [true] or [false] are allowed."
                }
        },
        "status":400
    }

물론, 검색하면 다 나옵니다.

No handler for type [string] declared on field [name]
; https://stackoverflow.com/questions/47452770/no-handler-for-type-string-declared-on-field-name

index 지정의 string 타입이 없어졌으니 "text"를 사용하라는 것과, "not_analyzed" 대신 false를 사용하라는 식입니다.




하위 호환성이 깨진 것 중 또 하나 의미 있는 것이 있습니다. 본문에서 index == db, type == table이라고 설명했는데요, 그래서 index 하나에 다중 type을 정의할 수 있어 보이지만 이 정책이 ES 버전 6부터 index 하나에 type 하나만을 정의할 수 있도록 바뀌었습니다.

그래서 다음과 같이 my_org 인덱스에 member를 생성했다면,

curl -XPUT "http://localhost:9200/my_org/" -H "Content-Type: application/json" -d "{ \"my_org\": { \"settings\" : { \"index\" : { } } } }"

curl -XPUT "http://localhost:9200/my_org/member/_mapping" -H "Content-Type: application/json" -d "{ \"member\" : { \"properties\" : { \"name\" : {\"type\" : \"text\", \"index\" : \"false\"}, \"age\" : {\"type\" : \"integer\"}, \"address\" : {\"type\" : \"text\"}, \"registered\" : {\"type\" : \"date\"} } } }"

이후, 동일한 인덱스에 다른 type을 생성하려고 하면 다음과 같은 오류가 발생합니다.

curl -XPUT "http://localhost:9200/my_org/test/_mapping?pretty" -H "Content-Type: application/json" -d "{  \"test\" : { \"properties\" : { \"qwer\" : {\"type\" : \"text\", \"index\" : \"false\"} } } }"

{
  "error" : {
    "root_cause" : [
      {
        "type" : "illegal_argument_exception",
        "reason" : "Rejecting mapping update to [my_org] as the final mapping would have more than 1 type: [test, member]"
      }
    ],
    "type" : "illegal_argument_exception",
    "reason" : "Rejecting mapping update to [my_org] as the final mapping would have more than 1 type: [test, member]"
  },
  "status" : 400
}

Can't create two Types to same index elasticsearch & Kibana
; https://stackoverflow.com/questions/47632846/cant-create-two-types-to-same-index-elasticsearch-kibana

누가 알겠습니까? 향후에는 index, table 따로 정의하던 것을 하나로 합칠지도 모릅니다. 그러다 다시 index 따로 table 따로 정의할 수 있게 만들어 서로 조합할 수 있게 할지도.




[이 글에 대해서 여러분들과 의견을 공유하고 싶습니다. 틀리거나 미흡한 부분 또는 의문 사항이 있으시면 언제든 댓글 남겨주십시오.]

[연관 글]





[최초 등록일: ]
[최종 수정일: 8/26/2018 ]

Creative Commons License
이 저작물은 크리에이티브 커먼즈 코리아 저작자표시-비영리-변경금지 2.0 대한민국 라이센스에 따라 이용하실 수 있습니다.
by SeongTae Jeong, mailto:techsharer@outlook.com

비밀번호

댓글 쓴 사람
 




... 16  [17]  18  19  20  21  22  23  24  25  26  27  28  29  30  ...
NoWriterDateCnt.TitleFile(s)
11719정성태10/4/20182127.NET Framework: 796. C# - 인증서를 윈도우에 설치하는 방법
11718정성태10/4/20181240개발 환경 구성: 404. (opkg가 설치된) Synology NAS(DS216+II)에 cmake 설치
11717정성태10/3/20181453사물인터넷: 48. 넷두이노의 C# 네트워크 프로그램
11716정성태10/3/20181863사물인터넷: 47. Raspberry PI Zero (W)에 FTDI 장치 연결 후 C/C++로 DTR 제어파일 다운로드1
11715정성태10/3/20181912사물인터넷: 46. Raspberry PI Zero (W)에 docker 설치
11714정성태10/2/20181471사물인터넷: 45. Raspberry PI에 ping을 hostname으로 하는 방법
11713정성태10/2/20182981개발 환경 구성: 403. Synology NAS(DS216+II)에 docker 설치 후 .NET Core 2.1 응용 프로그램 실행하는 방법
11712정성태6/26/20193624.NET Framework: 795. C# - 폰트 목록을 한글이 아닌 영문으로 구하는 방법 [3]
11711정성태10/2/20182467오류 유형: 490. 윈도우 라이선스 키 입력 오류 0xc004f050, 0xc004e028
11710정성태10/5/20181987.NET Framework: 794. C# - 같은 모양, 다른 값의 한글 자음을 비교하는 호환 분해 [5]
11709정성태12/7/20181340개발 환경 구성: 402. .NET Core 콘솔 응용 프로그램을 docker로 실행/디버깅하는 방법
11708정성태12/7/20182402개발 환경 구성: 401. .NET Core 콘솔 응용 프로그램을 배포(publish) 시 docker image 자동 생성 [1]파일 다운로드1
11707정성태9/30/20181345오류 유형: 489. ASP.NET Core를 docker에서 실행 시 "Failed with a critical error." 오류 발생
11706정성태9/29/20181613개발 환경 구성: 400. Synology NAS(DS216+II)에서 실행한 gcc의 Segmentation fault
11705정성태9/29/20182697개발 환경 구성: 399. Synology NAS(DS216+II)에 gcc 컴파일러 설치
11704정성태9/29/20183074기타: 73. Synology NAS 신호음(beep) 끄기 [1]파일 다운로드1
11703정성태10/16/20182012개발 환경 구성: 398. Blazor 환경 구성 후 빌드 속도가 너무 느리다면? [1]
11702정성태9/26/20181287사물인터넷: 44. 넷두이노(Netduino)의 네트워크 설정 방법
11701정성태9/26/20181923개발 환경 구성: 397. 공유기를 일반 허브로 활용하는 방법파일 다운로드1
11700정성태9/21/20181619Graphics: 25. Unity - shader의 직교 투영(Orthographic projection) 행렬(UNITY_MATRIX_P)을 수작업으로 구성
11699정성태9/21/20181448오류 유형: 488. Add-AzureAccount 실행 시 "No subscriptions are associated with the logged in account in Azure Service Management (RDFE)." 오류
11698정성태9/21/20181621오류 유형: 487. 윈도우 성능 데이터를 원격 SQL에 저장하는 경우 "Call to SQLAllocConnect failed with %1." 오류 발생
11697정성태9/20/20181619Graphics: 24. Unity - unity_CameraWorldClipPlanes 내장 변수 의미
11696정성태9/19/20181620.NET Framework: 793. C# - REST API를 이용해 NuGet 저장소 제어파일 다운로드1
11695정성태9/21/20182671Graphics: 23. Unity - shader의 원근 투영(Perspective projection) 행렬(UNITY_MATRIX_P)을 수작업으로 구성
11694정성태9/17/20181280오류 유형: 486. nuget push 호출 시 405 Method Not Allowed 오류 발생
... 16  [17]  18  19  20  21  22  23  24  25  26  27  28  29  30  ...