node sonic channel

узел-звуковой-канал

Интеграция Sonic Channel для Node. Используется в сочетании с Sonic, быстрым, легким и бессхемным поисковым механизмом.

Sonic Channel позволяет вам управлять своим поисковым индексом Sonic из вашего кода NodeJS. Запрашивайте свой индекс и получайте результаты поиска, помещайте записи в свой индекс и извлекайте их программным способом.

?? Изготовлено в Нанте, Франция.

Кто его использует?

Свежий

Вы используете sonic-channel и хотите, чтобы вас там разместили? Свяжитесь со мной.

Как установить?

Включите sonic-channel в зависимости package.json .

Альтернативно вы можете запустить npm install sonic-channel --save .

Как использовать?

1️⃣ Поиск канала

1. Создайте соединение

node-sonic-channel может быть создан в режиме поиска следующим образом:

 var SonicChannelSearch = require ( "sonic-channel" ) . Search ;

var sonicChannelSearch = new SonicChannelSearch ( {
  host : "::1" ,            // Or '127.0.0.1' if you are still using IPv4
  port : 1491 ,             // Default port is '1491'
  auth : "SecretPassword"  // Authentication password (if any)
} ) . connect ( {
  connected : function ( ) {
    // Connected handler
    console . info ( "Sonic Channel succeeded to connect to host (search)." ) ;
  } ,

  disconnected : function ( ) {
    // Disconnected handler
    console . error ( "Sonic Channel is now disconnected (search)." ) ;
  } ,

  timeout : function ( ) {
    // Timeout handler
    console . error ( "Sonic Channel connection timed out (search)." ) ;
  } ,

  retrying : function ( ) {
    // Retry handler
    console . error ( "Trying to reconnect to Sonic Channel (search)..." ) ;
  } ,

  error : function ( error ) {
    // Failure handler
    console . error ( "Sonic Channel failed to connect to host (search)." , error ) ;
  }
} ) ; 

2. Запросить поисковый индекс

Используйте тот же экземпляр sonicChannelSearch для запроса индекса поиска:

 sonicChannelSearch . query ( "messages" , "default" , "valerian saliou" )
  . then ( function ( results ) {
    // Query results come there
  } )
  . catch ( function ( error ) {
    // Query errors come there
  } ) ; 

3. Демонтажное соединение

Если вам нужно разорвать постоянное соединение с Sonic, используйте:

 sonicChannelSearch . close ( )
  . then ( function ( ) {
    // Close success handler
  } )
  . catch ( function ( error ) {
    // Close errors come there
  } ) ;

---

2️⃣ Канал приема

1. Создайте соединение

node-sonic-channel может быть создан в режиме приема следующим образом:

 var SonicChannelIngest = require ( "sonic-channel" ) . Ingest ;

var sonicChannelIngest = new SonicChannelIngest ( {
  host : "::1" ,            // Or '127.0.0.1' if you are still using IPv4
  port : 1491 ,             // Default port is '1491'
  auth : "SecretPassword"  // Authentication password (if any)
} ) . connect ( {
  connected : function ( ) {
    // Connected handler
    console . info ( "Sonic Channel succeeded to connect to host (ingest)." ) ;
  } ,

  disconnected : function ( ) {
    // Disconnected handler
    console . error ( "Sonic Channel is now disconnected (ingest)." ) ;
  } ,

  timeout : function ( ) {
    // Timeout handler
    console . error ( "Sonic Channel connection timed out (ingest)." ) ;
  } ,

  retrying : function ( ) {
    // Retry handler
    console . error ( "Trying to reconnect to Sonic Channel (ingest)..." ) ;
  } ,

  error : function ( error ) {
    // Failure handler
    console . error ( "Sonic Channel failed to connect to host (ingest)." , error ) ;
  }
} ) ; 

2. Управление индексом поиска

Используйте тот же экземпляр sonicChannelIngest , чтобы отправить текст в индекс поиска:

 sonicChannelIngest . push ( "messages" , "default" , "conversation:1" , "I met Valerian Saliou yesterday. Great fun!" )
  . then ( function ( ) {
    // Push success handler
  } )
  . catch ( function ( error ) {
    // Push errors come there
  } ) ; 

3. Демонтажное соединение

Если вам нужно разорвать постоянное соединение с Sonic, используйте:

 sonicChannelIngest . close ( )
  . then ( function ( ) {
    // Close success handler
  } )
  . catch ( function ( error ) {
    // Close errors come there
  } ) ;

---

3️⃣ Канал управления

1. Создайте соединение

node-sonic-channel может быть создан в режиме управления следующим образом:

 var SonicChannelControl = require ( "sonic-channel" ) . Control ;

var sonicChannelControl = new SonicChannelControl ( {
  host : "::1" ,            // Or '127.0.0.1' if you are still using IPv4
  port : 1491 ,             // Default port is '1491'
  auth : "SecretPassword"  // Authentication password (if any)
} ) . connect ( {
  connected : function ( ) {
    // Connected handler
    console . info ( "Sonic Channel succeeded to connect to host (control)." ) ;
  } ,

  disconnected : function ( ) {
    // Disconnected handler
    console . error ( "Sonic Channel is now disconnected (control)." ) ;
  } ,

  timeout : function ( ) {
    // Timeout handler
    console . error ( "Sonic Channel connection timed out (control)." ) ;
  } ,

  retrying : function ( ) {
    // Retry handler
    console . error ( "Trying to reconnect to Sonic Channel (control)..." ) ;
  } ,

  error : function ( error ) {
    // Failure handler
    console . error ( "Sonic Channel failed to connect to host (control)." , error ) ;
  }
} ) ; 

2. Администрирование вашего сервера Sonic

Вы можете использовать тот же экземпляр sonicChannelControl для администрирования вашего сервера Sonic.

3. Демонтажное соединение

Если вам нужно разорвать постоянное соединение с Sonic, используйте:

 sonicChannelControl . close ( )
  . then ( function ( ) {
    // Close success handler
  } )
  . catch ( function ( error ) {
    // Close errors come there
  } ) ; 

Список методов канала

Подробную информацию о значениях аргументов см. в спецификации протокола Sonic Channel.

Поиск канала

• sonicChannelSearch.query(collection_id<string>, bucket_id<string>, terms_text<string>, [options{limit<number>, offset<number>, lang<string>}<object>]?) ➡️ Promise(results<object>, error<object>)
• sonicChannelSearch.suggest(collection_id<string>, bucket_id<string>, word_text<string>, [options{limit<number>}<object>]?) ➡️ Promise(results<object>, error<object>)
• sonicChannelSearch.list(collection_id<string>, bucket_id<string>, [options{limit<number>, offset<number>}<object>]?) ➡️ Promise(results<object>, error<object>)

Канал приема

• sonicChannelIngest.push(collection_id<string>, bucket_id<string>, object_id<string>, text<string>, [options{lang<string>}<object>]?) ➡️ Promise(_, error<object>)
• sonicChannelIngest.pop(collection_id<string>, bucket_id<string>, object_id<string>, text<string>) ➡️ Promise(count<number>, error<object>)
• sonicChannelIngest.count<number>(collection_id<string>, [bucket_id<string>]?, [object_id<string>]?) ➡️ Promise(count<number>, error<object>)
• sonicChannelIngest.flushc(collection_id<string>) ➡️ Promise(count<number>, error<object>)
• sonicChannelIngest.flushb(collection_id<string>, bucket_id<string>) ➡️ Promise(count<number>, error<object>)
• sonicChannelIngest.flusho(collection_id<string>, bucket_id<string>, object_id<string>) ➡️ Promise(count<number>, error<object>)

Канал управления

• sonicChannelControl.trigger(action<string>, [data<string>]?) ➡️ Promise(_, error<object>)
• sonicChannelControl.info() ➡️ Promise(results<object>, error<object>)

Что такое Соник?

Хотите знать, что такое Соник? Посмотрите valeriansaliou/sonic .

Как это связано с Соником?

node-sonic-channel поддерживает постоянные TCP-соединения с сетевыми интерфейсами Sonic, которые прослушивают ваш работающий экземпляр Sonic. В случае отключения node-sonic-channel от Sonic он повторит попытку подключения, как только соединение будет установлено снова.

Вы можете настроить детали подключения вашего экземпляра Sonic при инициализации node-sonic-channel из вашего кода; через хост и порт Sonic.