I denna snabba handledning kommer vi att titta på Elasticsearch, specifikt hur man skapar index i Elasticsearch -motorn. Även om du inte behöver någon omfattande kunskap om ELK -stacken för att följa denna handledning, kan det vara fördelaktigt att ha grundläggande förståelse för följande ämnen:
- Med hjälp av terminalen, specifikt, cURL
- Grundläggande kunskaper om API: er och JSON
- Skicka HTTP -begäran
NOTERA: Denna handledning förutsätter också att du har Elasticsearch installerat och kört på ditt system.
Vad är Elasticsearch -index?
Utan att förenkla eller överkomplicera saker är ett Elasticsearch -index en samling relaterade JSON -dokument.
Som nämnts i ett tidigare inlägg är Elasticsearch -index JSON -objekt - betraktas som basenhet för lagring i Elasticsearch. Dessa relaterade JSON -dokument lagras i en enda enhet som utgör ett index. Tänk på Elasticsearch -dokument som tabeller i en relationsdatabas.
Låt oss relatera ett Elasticsearch -index som en databas i SQL -världen.
- MySQL => Databaser => Tabeller => Kolumner/rader
- Elasticsearch => Index => Typer => JSON -dokument med egenskaper
Hur man skapar ett Elasticsearch Index
Elasticsearch använder ett kraftfullt och intuitivt REST API för att avslöja sina tjänster. Med den här funktionen kan du använda HTTP -förfrågningar för att utföra operationer i Elasticsearch -klustret. Därför kommer vi att använda skapa index -API för att skapa ett nytt index.
För den här guiden kommer vi att använda cURL för att skicka förfrågningar och bevara integritet och användbarhet för alla användare. Men om du stöter på fel med cURL, överväg att använda Kibana Console.
Syntaxen för att skapa ett nytt index i Elasticsearch -klustret är:
PUT /För att skapa ett index är det bara att skicka indexnamnet utan andra parametrar, vilket skapar ett index med standardinställningar.
Du kan också ange olika funktioner i indexet, till exempel i indexkroppen:
- Inställningarna för indexet
- Index alias
- Kartläggningar för indexfält
Indexnamnet är en obligatorisk parameter; annars får du ett fel för URIL (/)
curl -X PUT lokal värd: 9200{'error': 'Felaktig HTTP -metod för uri [/] och metod [PUT], tillåten: [DELETE, HEAD, GET]', 'status': 405}
För att skapa ett nytt index med namnet single_index skickar vi begäran:
PUT /single_indexFör cURL, använd kommandot:
curl -X PUT 'localhost: 9200/single_index? pretty'Detta kommando ska resultera i HTTP -status 200 OK och ett meddelande med kvitterat: true som:
{erkänt: sant,
'shards_acknowledged': sant,
'index': 'single_index'
}
Begäran ovan skapar ett index single_index med standardinställningar eftersom vi inte angav några konfigurationer.
Regler för namngivning av index
När du skapar namn för Elasticsearch -index måste du följa följande namnstandarder:
- Indexnamnet måste endast vara gemener.
- Indexnamnen kan inte börja med ett bindestreck (-), ett understreck (_) eller ett tilläggstecken (+)
- Namnen kan inte vara. eller ..
- Indexnamn kan inte innehålla specialtecken som: , /, *,?,,, |, `` (Mellanslagstecken), ,, #
- Längden på indexnamn måste vara mindre än 255 byte. Multi-byte-tecken räknas i indexnamnets totala längd. Till exempel, om ett enda tecken är 8 byte långt, är den totala återstående längden på namnet 255 - 8
- I den senaste versionen av Elasticsearch, namn som börjar med a. är reserverade för dolda index och interna index som används av Elasticsearch -plugins.
Hur man skapar en indexkropp
När du använder PUT -begäran för att skapa ett index kan du skicka olika argument som definierar inställningarna för indexet du vill ha skapat. Värden som du kan ange i kroppen inkluderar:
- Alias: Anger aliasnamn för indexet du vill ha skapat; denna parameter är valfri.
- Inställningar: Detta definierar konfigurationsalternativen för indexet du vill ha skapat. Om du inte anger några parametrar skapas indexet med standardkonfigurationer.
- Kartläggningar: Detta definierar mappningen för fält i indexet. Specifikationerna du kan inkludera i mappningar inkluderar:
- Fältnamnet
- Datatypen
- Kartläggningsparametern
För ett exempel på att skapa ett index med kroppskonfigurationer, överväg begäran nedan:
PUT /single_index_with_body{
'inställningar': {
'number_of_shards': 2,
'number_of_replicas': 2
},
kartläggningar: {
'egenskaper': {
'field1': {'type': 'object'}
}
}
}
För en begäran om motsvarande cURL:
curl -XPUT 'http: // localhost: 9200/single_index_with_body' -H 'Content -Type: application/json' -d '{' settings ': {' number_of_shards ': 2,' number_of_replicas ': 2},' mappings ' : {'properties': {'field1': {'type': 'object'}}}} 'Ovanstående begäran skapar ett nytt index med namnet single_index_with_body med 2 antal skärvor och 2 repliker. Det skapar också en mappning med ett fält med namnfält1 och skriver som ett JSON -objekt.
När du skickar begäran får du ett svar med status för förfrågan som:
{erkänt: sant,
'shards_acknowledged': sant,
'index': 'single_index_with_body'
}
Acknowledged visar om indexet skapades framgångsrikt i klustret, medan shards_acknowledged visar om det erforderliga antalet shard -kopior startades för varje shard i det angivna indexet innan timeout.
Hur man visar Elasticsearch Index
Om du vill visa informationen om indexet du skapade kan du använda en liknande begäran om att skapa ett index, men använd HTTP -metoden istället för PUT som:
GET /single_index_with_bodyFör cURL,
curl -XGET http: // localhost: 9200/single_index_with_bodyDetta kommando ger dig detaljerad information om det begärda indexet som:
{'single_index_with_body': {
'alias': {},
'mappings': {
'egenskaper' : {
'fält1': {
'type': 'objekt'
}
}
},
'inställningar' : {
'index': {
'routing': {
'tilldelning': {
'inkludera': {
'_tier_preference': 'data_content'
}
}
},
'number_of_shards': '2',
'provided_name': 'single_index_with_body',
'creation_date': '1611045687208',
'number_of_replicas': '2',
'uuid': '3TRkO7xmQcSUOOGtb6pXVA',
'version': {
'created': '7100299'
}
}
}
}
}
Slutsats
Den här guiden diskuterade hur du arbetar med Elasticsearch för att skapa index -API för att skapa nya index. Vi diskuterade också hur man skapar lämpliga namn för index och konfigurationsinställningar.
Genom att använda den här guiden kan du nu skapa och visa index med Elasticsearch API.