sphinxql

sphinxql

كتب SPHINXQL Builder لـ Node.js في TypeScript. اجعل الاستعلامات السهلة تجنب كتابة سلاسل sphinxql الخام دائما ما تستطيع. بشكل افتراضي ، يستخدم معلمات الاستعلام التي هربت ، والتفكير دائمًا في الأمان.

إنه مستوحى بشدة في بناء PHP sphinxql-Query Builder وأيضًا منشئ الاستعلام البليغ (Laravel Framework)

العميل المستخدم لإنشاء اتصال هو 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 Search أو Sphinx لإجراء فكرة جيدة عن كيفية استخدام واجهة برمجة التطبيقات هذه.

أين وتطابق طرق

• أين (ColumnExpr: سلسلة ، المشغل: سلسلة ، قيمة؟: أي)
• حيث (العمود: سلسلة ، القيم: أي [])
• Wherenotin (العمود: سلسلة ، القيم: أي [])
• بين (العمود: السلسلة ، القيمة 1: أي ، القيمة 2: أي)
• تطابق (الحقول: سلسلة [] | سلسلة ، القيمة: سلسلة ، EscapeValue: Boolean = true)
• OrMatch (الحقول: String [] | String ، Value: String ، EscapeValue: Boolean = True)

مثال هنا:

 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. لمزيد من المعلومات ، تفضل بزيارة وثائق المعاملات للبحث عن Manticore.

واجهة برمجة تطبيقات المعاملات بسيطة وقائمة الطرق أدناه:

• Connection.getQueryBuilder (). Transaction.Begin ()
• connection.getQueryBuilder (). Transaction.start () // نفسه الذي يبدأ ()
• connection.getQueryBuilder (). Transaction.Commit ()
• connection.getQueryBuilder (). Transaction.Rollback ()

كل هذه الأساليب تُرجع كائن الوعد.

مثال بسيط يعمل مع المعاملات:

 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 ) ;

استعلامات الدُفعات (استفسارات متعددة)

بادئ ذي بدء ، تحتاج إلى معرفة قيود الاستعلامات المتعددة في Manticore/Sphinx. كما قال Manticore Search و 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 ) ) ;

المزيد من أساليب sphinxql

• OptimizeIndex (الفهرس: سلسلة): وعد
• eachIndex (Diskindex: String): ackingIndexStatement
• Truncate (rtindex: سلسلة): truncateStatement
• RELOADINDEX (فهرس: سلسلة): realoadindexstatement

إرفاق فهرس (exceniNdexStatement)

اقرأ عن فهرس إرفاق في Manticore Documantation لاستخدام هذا البيان ، انظر المثال أدناه:

 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 (flushrtindexstatement)

اقرأ عن Flush Rtindex لاستخدام هذا البيان انظر المثال أدناه):

 connection . getQueryBuilder ( )
  . flushRTIndex ( 'my_rt_index' )
  . execute ( )
  . then ( ( result , fields ) => {
    console . log ( result ) ;
  } )
  . catch ( err => {
    console . log ( err ) ;
  } ) ; 

تقطيع rtindex (truncateStatement)

اقرأ عن Truncate Rtindex في Manticore Documantation لاستخدام هذا البيان انظر المثال أدناه:

 connection . getQueryBuilder ( )
  . truncate ( 'my_rt_index' )
  . withReconfigure ( )  // this method is optional
  . execute ( )
  . then ( ( result , fields ) => {
    console . log ( result ) ;
  } )
  . catch ( err => {
    console . log ( err ) ;
  } ) ; 

مؤشر إعادة التحميل

اقرأ عن مؤشر إعادة التحميل في Manticore Documantation لاستخدام هذا البيان انظر المثال أدناه:

 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 ) ;
  } ) ; 

استفسارات التصحيح

جميع العبارات لها طريقة نهائية تستخدم داخليًا لتنفيذ الاستعلامات. هذه الطريقة متوفرة في الخارج باستخدام Cender () وإرجاع سلسلة مع الاستعلام النهائي.

 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