PolarSearch, PolarDB'nin dağıtık arama hizmetidir; hem tam metin aramayı hem de vektör aramasını destekler. OpenSearch üzerine inşa edilen bu hizmet, Elasticsearch ekosistemiyle uyumludur ve PolarDB veritabanlarıyla sıkı entegre olur. PolarSearch, veri alımınızı basitleştiren tek duraklı bir çözüm sunar.
Bu kılavuz, Elasticsearch veya OpenSearch hakkında temel bilginiz olduğunu varsayar. Daha fazla bilgi için OpenSearch Belgeleri kaynağına bakın.
Ön koşullar
Küme yapılandırma gereksinimleri
Ürün Sürümü: Enterprise Edition.
Seriler: Cluster Edition.
-
Veritabanı Motoru: MySQL 8.0.1 veya MySQL 8.0.2.
NotYukarıda listelenen veritabanı motorları için özel küçük sürüm gereksinimi bulunmamaktadır. Daha fazla bilgi için Sürüm numarasını sorgulama konusuna bakın.
-
Veritabanı motoru:
(çekirdek küçük sürümü 2.0.18.3.2.0 veya üzeri)
(çekirdek küçük sürümü 2.0.17.9.6.0 veya üzeri)
(çekirdek küçük sürümü 2.0.16.11.15.0 veya üzeri)
(çekirdek küçük sürümü 2.0.15.17.8.0 veya üzeri)
(çekirdek küçük sürümü 2.0.14.22.43.0 veya üzeri)
Desteklenen bölgeler ve kullanılabilirlik alanları
PolarSearch aşağıdaki kullanılabilirlik alanlarında desteklenir:
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Ek kullanılabilirlik alanları için desteğe ihtiyacınız varsa bir destek talebi oluşturun.
Faturalama
PolarSearch, özel arama düğümleri kullanarak arama işlevi sağlar ve bu düğümler için ücretlendirilir. Arama düğümleri Normal hesaplama düğümleri için faturalandırma esaslarına göre faturalandırılır. Buna ek olarak, arama düğümlerindeki dizinler ve veriler depolama alanı tüketir; bu da ilgili depolama ücretlerine ve tabidir.
PolarSearch arama düğümleri ekleme
-
Ön koşullar bölümündeki gereksinimleri karşılayan mevcut bir kümeye arama düğümleri ekleyebilirsiniz.
PolarDB konsolunda oturum açın. Sol gezinme bölmesinde Clusters öğesine tıklayın. Kümenin konuşlandırıldığı Region seçeneğini belirleyin ve ardından hedef kümeyi bulun.
Basic Information sayfasını açmak için küme kimliğine tıklayın.
Database Nodes bölümünde Add/Remove Node seçeneğine tıklayın.
Add/Remove Node iletişim kutusunda arama düğümleri eklemeyi seçin. Arama düğümü sayısı en az 2 olmalıdır.
Arama düğümü hesapları oluşturma
Yönetici hesabını ayarlama
Eklediğiniz hesap bir standart hesaptır.
Bu standart hesap, PolarSearch için yönetici hesabı olarak görev yapar.
PolarDB konsolunda oturum açın. Sol gezinme bölmesinde Clusters öğesine tıklayın. Kümenin konuşlandırıldığı Region seçeneğini belirleyin ve ardından hedef kümeyi bulun.
Basic Information sayfasını açmak için küme kimliğine tıklayın.
Database Nodes bölümünde Search Node üzerine gelin ve Set Database Account seçeneğine tıklayın.
-
Görüntülenen iletişim kutusunda mevcut bir standart hesabı seçebilir veya yeni bir hesap oluşturabilir, ardından hesap parolasını girebilirsiniz.
ÖnemliVeritabanı hesap adı, parolasının alt dizesi olamaz. Kontrol büyük/küçük harfe duyarlı değildir. Örneğin,
search_testadlı bir veritabanı hesabı için parolaSEARCH_test@123olamaz ancakSEARCHtest@123veyaSEARCH@_testolabilir.
Standart hesapları ayarlama
Standart hesapların izinleri dizin bazında yapılandırılabilir. Bu ayarları Dashboard veya REST API kullanarak iki şekilde yapabilirsiniz.
Dashboard yapılandırması
Hesabın security_rest_api_access rolüne sahip olması gerekir. Aksi takdirde Security sayfası görüntülenmez.
-
Kullanıcı oluşturma:
Sol gezinme bölmesinde sayfasına gidin, Internal users seçeneğini belirleyin ve ardından Create internal user seçeneğine tıklayın.
Kullanıcı oluşturma sayfasında kullanıcıyı oluşturmak için bir kullanıcı adı ve parola girin. Örneğin,
testuseradında veUSER@test123parolasına sahip bir kullanıcı oluşturun, ardından Create seçeneğine tıklayın.
-
Rol oluşturma
Sol gezinme bölmesinde sayfasına gidin, Roles seçeneğini belirleyin ve ardından Create role seçeneğine tıklayın.
-
Rol izinleri, eylem grupları ekleyerek yapılandırabileceğiniz küme izinlerini ve dizin izinlerini içerir. Index alanında bir dizin adı belirtin veya bir dizi dizin adıyla eşleşmesi için
*joker karakterini kullanın. Index permissions bölümünde salt okunur veya okuma/yazma gibi belirli izinleri seçin.Örnek: Tam küme izinlerine (sınırsız, tam izinlere eşdeğerdir) sahip olan ve
indextestönekiyle başlayan tüm dizinler için salt okunur izni verenonlyreadroleadlı bir rol oluşturun.Buna ek olarak, dizin izinleri Document level security (JSON sorgu ifadeleri aracılığıyla erişilebilir belge kapsamını kısıtlar) ve Field level security (erişilebilir alanları kısıtlar) yapılandırmalarını destekler.
-
Bir rolü bir kullanıcıyla eşleştirme
Sol gezinme bölmesinde sayfasına gidin, Roles seçeneğini belirleyin ve ardından hedef role tıklayın.
-
Mapped users sekmesinde bir kullanıcı eşlemesi ekleyin. Bir kullanıcı birden fazla rolle eşleştirilebilir ve eşleştirilen tüm rollerin izinlerini devralır.
Örnek:
onlyreadrolerolünütestuserkullanıcıyla eşleştirin. Bu işlem,testuserkullanıcısınaonlyreadrolerolünün izinlerini verir.onlyreadrolerolünün Map user sayfasında Users alanındatestuserkullanıcısını ekleyin ve eşlemeyi tamamlamak için Map seçeneğine tıklayın.
REST API yapılandırması
Arama düğümleri, API'ler kullanarak tam erişim kontrolünü destekler. Daha fazla bilgi için OpenSearch API belgelerine bakın.
-
Kullanıcı oluşturma
curl -X PUT "http://<endpoint>:<port>/_plugins/_security/api/internalusers/<new_user>" \ --user "<user_name>:<passwd>" \ -H "Content-Type: application/json" \ -d '{ "password": "<new_password>", "backend_roles": [], "attributes": {} }'Örnek:
testuseradında veUSER@test123parolasına sahip bir kullanıcı oluşturun.curl -X PUT "http://<endpoint>:<port>/_plugins/_security/api/internalusers/testuser" \ --user "<user_name>:<passwd>" \ -H "Content-Type: application/json" \ -d '{ "password": "USER@test123", "backend_roles": [], "attributes": {} }' -
Rol oluşturma
curl -X PUT "http://<endpoint>:<port>/_plugins/_security/api/roles/<role_name>" \ --user "<user_name>:<passwd>" \ -H "Content-Type: application/json" \ -d '{ "cluster_permissions": ["*"], "index_permissions": [ { "index_patterns": ["*"], "allowed_actions": ["*"] } ] }'index_patterns: Yapılandırılacak dizinleri belirtir. Birden çok dizini aynı anda yapılandırmak için*joker karakterini kullanabilirsiniz.allowed_actions: Verilecek izinleri belirtir; örneğinreadvewrite.
Örnek: Tam küme izinlerine sahip olan ve
indextestönekiyle başlayan tüm dizinler için salt okunur izni verenonlyreadroleadlı bir rol oluşturun.curl -X PUT "http://<endpoint>:<port>/_plugins/_security/api/roles/onlyreadrole" \ --user "<user_name>:<passwd>" \ -H "Content-Type: application/json" \ -d '{ "cluster_permissions": ["*"], "index_permissions": [ { "index_patterns": ["indextest*"], "allowed_actions": ["read"] } ] }' -
Bir rolü eşleştirme
curl -X PUT "http://<endpoint>:<port>/_plugins/_security/api/rolesmapping/<role_name>" \ --user "<user_name>:<passwd>" \ -H "Content-Type: application/json" \ -d '{ "backend_roles": [], "hosts": [], "users": ["<new_user>"] }'Örnek:
onlyreadrolerolünütestuserkullanıcıyla eşleştirin. Bu işlem,testuserkullanıcısınaonlyreadrolerolünün izinlerini verir.curl -X PUT "http://<endpoint>:<port>/_plugins/_security/api/rolesmapping/onlyreadrole" \ --user "<user_name>:<passwd>" \ -H "Content-Type: application/json" \ -d '{ "backend_roles": [], "hosts": [], "users": ["testuser"] }'
Bağlantı uç noktalarını elde etme
Arama uç noktası
Database Nodes bölümünde bir Search Node üzerine gelerek ortamınıza karşılık gelen özel veya genel uç noktayı elde edin.
Dashboard uç noktası
Database Nodes bölümünde bir Search Node üzerine gelerek ortamınıza karşılık gelen özel veya genel Dashboard uç noktasını elde edin.
PolarSearch'e bağlanma
Arama uç noktası üzerinden bağlanma
Dizinleri ve verileri API'ler kullanarak yönetmeyi tercih ediyorsanız PolarSearch'e arama uç noktası üzerinden bağlanabilirsiniz. Aşağıdaki örnek, bir ECS örneğinden nasıl bağlanılacağını göstermektedir.
-
Bir küme için izin listelerini yapılandırma: ECS örneğinizin IP adresini PolarDB for MySQL kümesi izin listesine ekleyin.
NotECS örneğiniz ve PolarDB for MySQL kümeniz aynı VPC içindeyse ECS örneğinin özel IP adresini izin listesine ekleyin.
ECS örneğiniz ve PolarDB for MySQL kümeniz aynı VPC içinde değilse ECS örneğinin genel IP adresini izin listesine ekleyin.
-
PolarSearch'e bağlanma: Aşağıdaki komutu çalıştırın. Komut küme bilgilerini döndürürse bağlantı başarılıdır.
<endpoint>:<port>değerini PolarSearch arama uç noktası ile ve<user_name>:<passwd>değerini PolarSearch yönetici hesabı ile değiştirin.curl http://<endpoint>:<port>/ -u <user_name>:<passwd>
Dashboard üzerinden bağlanma
PolarSearch'ü grafik kullanıcı arayüzü kullanarak yönetmeyi tercih ediyorsanız Dashboard üzerinden erişebilirsiniz. Aşağıdaki örnek, yerel bir ortamdaki tarayıcıyı kullanır:
Bir küme için izin listelerini yapılandırma: Yerel makinenizin genel IP adresini PolarDB for MySQL kümesi izin listesine ekleyin.
-
Tarayıcıda PolarSearch konsolunda oturum açın:
Tarayıcınızın adres çubuğuna
http://<endpoint>:<port>yazın ve Enter tuşuna basın.<endpoint>:<port>değerini PolarSearch için genel Dashboard uç noktası ile değiştirin.Oturum açma sayfasında Kibana uyumlu PolarSearch konsoluna erişmek için PolarSearch yönetici hesabı kimlik bilgilerini girin.
Örnekler
Bu bölümdeki tüm örnekler bir ECS örneğinde komut satırından gerçekleştirilir.
PolarSearch, OpenSearch 2.19.0 SDK ve REST API ile tamamen uyumludur. Diğer sürümlerin kullanılması uyumluluk sorunlarına neden olabilir. Daha fazla bilgi için OpenSearch kaynağına bakın.
Dizin oluşturma
Arama düğümündeki bir dizin, ilişkisel veritabanındaki bir tabloya benzer. Elasticsearch uyumlu REST API kullanarak veya doğrudan Dashboard'da komutlar çalıştırarak dizin oluşturabilirsiniz. Aşağıda örnekler verilmiştir:
CLI
curl -XPUT "http://<endpoint>:<port>/articles" \
--user "<user_name>:<passwd>" \
-H 'Content-Type: application/json' \
-d '{
"settings": {
"number_of_shards": 1,
"number_of_replicas": 1
},
"mappings": {
"properties": {
"title": {
"type": "text"
},
"content": {
"type": "text"
},
"author": {
"type": "keyword"
}
}
}
}'
Dashboard
PUT articles
{
"settings": {
"number_of_shards": 1,
"number_of_replicas": 1
},
"mappings": {
"properties": {
"title": {
"type": "text"
},
"content": {
"type": "text"
},
"author": {
"type": "keyword"
}
}
}
}
Veri içe aktarma
CLI
curl -XPOST "http://<endpoint>:<port>/articles/_bulk" \
--user "<user_name>:<passwd>" \
-H 'Content-Type: application/json' \
-d '
{"index": {}}
{"title": "Introduction to PolarSearch", "content": "PolarSearch is a powerful search engine.", "author": "Allen"}
{"index": {}}
{"title": "Advanced Search Techniques", "content": "Learn how to use full-text search and filters in PolarDB.", "author": "Lang"}
{"index": {}}
{"title": "Elasticsearch vs PolarSearch", "content": "A comparison of Elasticsearch and PolarSearch features.", "author": "Zhao"}
'
Dashboard
POST articles/_bulk
{"index": {}}
{"title": "Introduction to PolarSearch", "content": "PolarSearch is a powerful search engine.", "author": "Allen"}
{"index": {}}
{"title": "Advanced Search Techniques", "content": "Learn how to use full-text search and filters in PolarDB.", "author": "Lang"}
{"index": {}}
{"title": "Elasticsearch vs PolarSearch", "content": "A comparison of Elasticsearch and PolarSearch features.", "author": "Zhao"}
Arama sorgusu çalıştırma
Veriler içe aktarıldıktan sonra SDK, REST API veya Dashboard kullanarak tam metin araması yapabilirsiniz. Aşağıdaki örneklerde bunun nasıl yapılacağı gösterilmektedir:
CLI
curl -XGET "http://<endpoint>:<port>/articles/_search" \
--user "<user_name>:<passwd>" \
-H 'Content-Type: application/json' \
-d '
{
"query": {
"match": {
"content": "PolarSearch"
}
}
}'
Dashboard
GET articles/_search
{
"query": {
"match": {
"content": "PolarSearch"
}
}
}
Arama sorgu sözdizimi hakkında daha fazla bilgi için OpenSearch belgelerine bakın.
Vektör dizini oluşturma
CLI
curl -XPUT "http://<endpoint>:<port>/my-vector-index" \
--user "<user_name>:<passwd>" \
-H "Content-Type:application/json" \
-d '
{
"settings": {
"index": {
"knn": true
}
},
"mappings": {
"properties": {
"vector_field": {
"type": "knn_vector",
"dimension": 4
},
"metadata": {
"type": "text"
}
}
}
}
'
Dashboard
PUT my-vector-index
{
"settings": {
"index": {
"knn": true
}
},
"mappings": {
"properties": {
"vector_field": {
"type": "knn_vector",
"dimension": 4
},
"metadata": {
"type": "text"
}
}
}
}
Vektör verisi ekleme
CLI
curl -XPOST "http://<endpoint>:<port>/my-vector-index/_bulk" \
--user "<user_name>:<passwd>" \
-H "Content-Type:application/json" \
-d '
{"index": {}}
{"vector_field": [0.1, 0.5, -0.3, 0.8], "metadata": "Document 1"}
{"index": {}}
{"vector_field": [-0.2, 0.7, 0.4, -0.1], "metadata": "Document 2"}
'
Dashboard
POST my-vector-index/_bulk
{"index": {}}
{"vector_field": [0.1, 0.5, -0.3, 0.8], "metadata": "Document 1"}
{"index": {}}
{"vector_field": [-0.2, 0.7, 0.4, -0.1], "metadata": "Document 2"}
Vektör araması
CLI
curl -XGET "http://<endpoint>:<port>/my-vector-index/_search" \
--user "<user_name>:<passwd>" \
-H "Content-Type:application/json" \
-d '
{
"size": 2,
"query": {
"knn": {
"vector_field": {
"vector": [0.1, 0.5, -0.3, 0.8],
"k": 2
}
}
}
}
'
Dashboard
GET my-vector-index/_search
{
"size": 2,
"query": {
"knn": {
"vector_field": {
"vector": [0.1, 0.5, -0.3, 0.8],
"k": 2
}
}
}
}