SPHINXQL Запрос Builder для Node.js написал в TypeScript. Сделайте легкие запросы, избегая всегда писать необработанные струны Sphinxql, которые вы можете. По умолчанию он использует сбежавшие параметры запроса, всегда думая о безопасности.
Он сильно вдохновлен в PHP sphinxql-Query-Builder, а также красноречивом строителе запросов (Laravel Framework Orm)
Клиент, используемый для создания соединения, - это MySQL2, который сосредоточен на производительности.
Вы должны использовать node.js> = 6.x
Просто запустите команду NPM:
npm install --save sphinxqlЧтобы создать простое соединение (не самое рекомендуемое, используйте соединение пула) и напишите свой первый запрос, просто сделайте это:
const { Sphinxql , Expression } = require ( 'sphinxql' ) ;
const sphql = Sphinxql . createConnection ( {
host : 'localhost' ,
port : 9306
} ) ;
sphql . getQueryBuilder ( )
. select ( '*' )
. from ( 'books' )
. match ( 'title' , 'harry potter' )
. where ( 'created_at' , '<' , Expression . raw ( 'YEAR()' ) )
. between ( Expression . raw ( `YEAR(created_at)` ) , 2014 , 2019 )
. orderBy ( { 'date_published' : 'ASC' , 'price' : 'DESC' } )
. limit ( 10 )
. execute ( )
. then ( ( result , fields ) => {
console . log ( result ) ;
} )
. catch ( err => {
console . log ( err ) ;
} ) ; Существует два возможных способа создания соединения между вашим приложением и сервером Manticore/Sphinx. Первым и самым простым является использование метода createConnection .
const { Sphinxql } = require ( 'sphinxql' ) ;
const sphql = Sphinxql . createConnection ( {
host : 'localhost' ,
port : 9306
} ) ; Второй вариант использует метод createPoolConnection . Эта методология позволяет вам иметь несколько открытых соединений с Manticore/Sphinx, повторно использующим предыдущие соединения. Чтобы узнать больше о пулах соединений MySQL2 (разрешенные параметры для создания и конфигурации пула) прочитайте документацию MySQL2 об использовании пулов соединений. Эта техника использует больше памяти, так что имейте в виду.
const { Sphinxql } = require ( 'sphinxql' ) ;
// Create the connection pool. The pool-specific settings are the defaults
const sphql = Sphinxql . createPoolConnection ( {
host : 'localhost' ,
port : 9306 ,
waitForConnections : true ,
connectionLimit : 10 ,
queueLimit : 0
} ) ;Этот раздел разделен во многих частях, но если вы использовали sphinxql до или SQL, вы можете увидеть этот раздел, также очень простым для вас. В любом случае, я настоятельно рекомендую прочитать «Поиск Manticore» или «Документацию по сфинкс», чтобы представить хорошее представление о том, как использовать этот API.
Пример здесь:
sphql . getQueryBuilder ( )
. select ( 'id' , 'author_id' , 'publication_date' )
. from ( 'books' )
. match ( '*' , '"harry potter"' , false )
. whereIn ( 'lang' , [ 'en' , 'sp' , 'fr' ] )
. between ( Expression . raw ( `YEAR(publication_date)` ) , 2008 , 2015 )
. execute ( )
. then ( ( result , fields ) => {
console . log ( result ) ;
} )
. catch ( err => {
console . log ( err ) ;
} ) ; Вы можете цепорить несколько параметров, используя параметр «Метод». Глава метода:
Пример с опцией:
sphql . getQueryBuilder ( )
. select ( 'id' , 'author_id' , 'publication_date' )
. from ( 'books' )
. match ( '*' , '"harry potter"' , false )
. between ( Expression . raw ( `YEAR(publication_date)` ) , 2008 , 2015 )
. orderBy ( { 'publication_date' : 'ASC' , 'price' : 'DESC' } )
. limit ( 10 )
. option ( 'rank_fields' , 'title content' )
. option ( 'field_weights' , { title : 100 , content : 1 } )
. execute ( )
. then ( ( result , fields ) => {
console . log ( result ) ;
} )
. catch ( err => {
console . log ( err ) ;
} ) ; // Тодо
Заявление вставки создается так:
const document = {
id : 1 ,
content : 'this is the first post for the blog...' ,
title : 'First post'
} ;
connection . getQueryBuilder ( )
. insert ( 'my_rtindex' , document )
. execute ( )
. then ( ( result , fields ) => {
console . log ( result ) ;
} )
. catch ( err => {
console . log ( err ) ;
} ) ;Или использование массива пар клавишных значений для вставки нескольких значений в один и тот же запрос
const document = [ {
id : 1 ,
content : 'this is the first post for the blog...' ,
title : 'First post'
} , {
id : 2 ,
content : 'this is the second post for the blog...' ,
title : 'Second post'
} ] ;
connection . getQueryBuilder ( )
. insert ( 'my_rtindex' , document )
. execute ( )
. then ( ( result ) => {
console . log ( result ) ;
} )
. catch ( err => {
console . log ( err ) ;
} ) ;Заменяет документ, используя идентификатор DOC или вставка. Аналогично операции вставки только изменение вставки для замены.
const document = {
id : 1 ,
content : 'this is the first post for the blog...' ,
title : 'UPDATE! First post'
} ;
connection . getQueryBuilder ( )
. replace ( 'my_rtindex' , document )
. execute ( )
. then ( ( result ) => {
console . log ( result ) ;
} )
. catch ( err => {
console . log ( err ) ;
} ) ; const document = {
content : 'UPDATE! it's an old post. this is the first post for the blog...' ,
title : 'First post (edit)'
} ;
connection . getQueryBuilder ( )
. update ( 'my_rtindex' )
. set ( document )
. match ( 'fullname' , 'John' )
. where ( 'salary' , '<' , 3000 )
. execute ( )
. then ( ( result , fields ) => {
console . log ( result ) ;
} )
. catch ( err => {
console . log ( err ) ;
} ) ;Этот пакет также поставляется с поддержкой транзакций. Помните, что транзакции доступны только для индексов RT. Для получения дополнительной информации посетите документацию транзакций для поиска Mantyore.
API транзакций прост, а список методов здесь ниже:
Все эти методы возвращает объект обещания.
Простой пример, работающий с транзакциями:
const document = {
id : 1 ,
content : 'this is the first post for the blog...' ,
title : 'First post'
} ;
const insertDocumentAndCommit = async ( doc ) => {
await connection . getQueryBuilder ( ) . transaction . begin ( ) ;
connection . getQueryBuilder ( )
. insert ( 'my_rtindex' , doc )
. execute ( )
. then ( ( result , fields ) => {
console . log ( result ) ;
} )
. catch ( err => {
console . log ( err ) ;
} ) ;
await connection . getQueryBuilder ( ) . transaction . commit ( ) ;
return true ;
}
insertDocumentAndCommit ( document ) ;Прежде всего, вам нужно знать ограничения многочисленных запросов в Mantyore/Sphinx. Поскольку поиск Mantyore и документация Sphinx заявила, что существует поддержка только для следующих утверждений, используемых в партии:
Сказал это, сейчас момент для написания кода. Существует класс, очередь , который реализует только необходимые методы, полезно для запуска нескольких запросов. Чтобы включить многооперации, которые вы должны указать в вашем объекте конфигурации для создания подключения .
const { Sphinxql } = require ( 'sphinxql' ) ;
const sphql = Sphinxql . createConnection ( {
host : 'localhost' ,
port : 9306 ,
multipleStatements : true
} ) ;Теперь давайте создадим очередь и обработаем ее:
const { Queue , Sphinxql } = require ( 'sphinxql' ) ;
const sphql = Sphinxql . createConnection ( {
host : 'localhost' ,
port : 9306 ,
multipleStatements : true
} ) ;
const queue = new Queue ( sphql . getConnection ( ) ) ;
queue
. push ( sphql . getQueryBuilder ( ) . select ( '*' ) . from ( 'rt' ) . where ( 'id' , '=' , 1 ) )
. push (
sphql . getQueryBuilder ( )
. select ( 'id' , 'author_id' , 'publication_date' )
. from ( 'books' )
. match ( '*' , '"harry potter"' , false )
) ;
queue . process ( )
. then ( results => {
console . log ( results . results . length ) // 2
} )
. catch ( err => console . log ( err ) ) ;Читайте об индексе приложения в Manticore Decumantation, чтобы использовать это утверждение, см. Пример ниже:
connection . getQueryBuilder ( )
. attachIndex ( 'my_disk_index' )
. to ( 'my_rt_index' )
. withTruncate ( ) // this method is optional
. execute ( )
. then ( ( result , fields ) => {
console . log ( result ) ;
} )
. catch ( err => {
console . log ( err ) ;
} ) ; Прочитайте о Flush Rtindex, чтобы использовать это оператор. См. Пример ниже):
connection . getQueryBuilder ( )
. flushRTIndex ( 'my_rt_index' )
. execute ( )
. then ( ( result , fields ) => {
console . log ( result ) ;
} )
. catch ( err => {
console . log ( err ) ;
} ) ; Читайте о уселении rtindex в Мантироре, чтобы использовать это утверждение. См. Пример ниже:
connection . getQueryBuilder ( )
. truncate ( 'my_rt_index' )
. withReconfigure ( ) // this method is optional
. execute ( )
. then ( ( result , fields ) => {
console . log ( result ) ;
} )
. catch ( err => {
console . log ( err ) ;
} ) ; Прочитайте об индексе перезагрузки в Мантироре, чтобы использовать это утверждение, см. Пример ниже:
connection . getQueryBuilder ( )
. reloadIndex ( 'my_index' )
. from ( '/home/mighty/new_index_files' ) // this method is optional
. then ( ( result , fields ) => {
console . log ( result ) ;
} )
. catch ( err => {
console . log ( err ) ;
} ) ;Запустите необработанные запросы, используя метод запроса, который доступен после вызова метода GetQueryBuilder. Этот метод разрешает подготовленный оператор, используя? (знак вопроса), где вы хотите избежать значения.
connection . getQueryBuilder ( )
. query ( `SELECT * FROM sales WHERE MATCH(@title "italian lamp") AND tags IN (?, ?)` , [ 'home' , 'italian style' ] )
. then ( ( result , fields ) => {
console . log ( result ) ;
} )
. catch ( err => {
console . log ( err ) ;
} ) ; Все операторы имеют окончательный метод, который используется внутренне для выполнения запросов. Этот метод доступен снаружи с помощью Generate () и возвращает строку с окончательным запросом.
const sphinxqlQuery = connection . getQueryBuilder ( )
. select ( 'user_id' , 'product_id' , Expression . raw ( 'SUM(product_price) as total' ) . getExpression ( ) )
. from ( 'rt_sales' )
. facet ( ( f ) => {
return f
. fields ( [ 'category_id' ] )
. by ( [ 'category_id' ] )
} )
. facet ( ( f ) => {
return f
. field ( 'brand_id' )
. orderBy ( Expression . raw ( 'facet()' ) )
. limit ( 5 )
} )
. generate ( ) ;
console . log ( sphinxqlQuery ) ; // SELECT user_id, product_id, SUM(product_price) as total FROM rt_sales FACET category_id BY category_id FACET brand_id ORDER BY facet() DESC LIMIT 5