1343 |

1344 |

Sonicclient Copyright Ahmed T. Youssef nim Sonic client TODO: check help.

1345 |

1346 |

Types

1347 |

SonicChannel {...}{.pure.} = enum 1350 | Ingest, Search, Control: 1352 | 1353 | 1354 |
Sonic = ref object of SonicBase[Socket]: 1358 | 1359 | 1360 |
AsyncSonic = ref object of SonicBase[AsyncSocket]: 1364 | 1365 | 1366 |

1369 |

1370 |

Procs

1371 |

proc startSession(this: AsyncSonic): Future[void] {...}{.raises: [FutureError], 1374 | tags: [RootEffect].}

1376 | 1377 | 1378 |

proc startSession(this: Sonic): void {...}{.raises: [TimeoutError, OSError, SslError], tags: [ 1381 | ReadIOEffect, TimeEffect, WriteIOEffect].}

1383 | ## started. FIXME extract protocol bufsize 1384 | 1385 |

proc open(host = "localhost"; port = 1491; password = ""; channel: SonicChannel; 1388 | ssl = false; timeout = 0): Sonic {...}{.raises: [OSError, SslError, TimeoutError], tags: [ 1389 | ReadIOEffect, TimeEffect, WriteIOEffect].}

1391 | 1392 | 1393 |

proc openAsync(host = "localhost"; port = 1491; password = ""; channel: SonicChannel; 1396 | ssl = false; timeout = 0): Future[AsyncSonic] {...}{.raises: [FutureError], 1397 | tags: [RootEffect].}

1399 | Open an asynchronous connection to a Sonic server. 1400 | 1401 |

proc receiveManaged(this: AsyncSonic; size = 1): Future[string] {...}{. 1404 | raises: [FutureError], tags: [RootEffect].}

1406 | 1407 | 1408 |

proc receiveManaged(this: Sonic; size = 1): string {...}{. 1411 | raises: [TimeoutError, OSError, SslError, SonicServerError], 1412 | tags: [ReadIOEffect, TimeEffect].}

1414 | 1415 | 1416 |

proc execCommand(this: AsyncSonic; command: string; args: seq[string]): Future[string] {...}{. 1419 | raises: [FutureError], tags: [RootEffect].}

1421 | 1422 | 1423 |

proc execCommand(this: Sonic; command: string; args: seq[string]): string {...}{. 1426 | raises: [SslError, OSError, TimeoutError, SonicServerError], 1427 | tags: [WriteIOEffect, ReadIOEffect, TimeEffect].}

1429 | 1430 | 1431 |

proc execCommand(this: AsyncSonic; command: string): Future[string] {...}{. 1434 | raises: [FutureError], tags: [RootEffect].}

1436 | 1437 | 1438 |

proc execCommand(this: Sonic; command: string): string {...}{. 1441 | raises: [SslError, OSError, TimeoutError, SonicServerError], 1442 | tags: [WriteIOEffect, ReadIOEffect, TimeEffect].}

1444 | 1445 | 1446 |

proc ping(this: AsyncSonic): Future[bool] {...}{.raises: [FutureError], tags: [RootEffect].}

1450 | Send ping command to the server Returns: bool True if successfully reaching the server. 1451 | 1452 |

proc ping(this: Sonic): bool {...}{.raises: [SslError, OSError, TimeoutError, 1455 | SonicServerError], 1456 | tags: [WriteIOEffect, ReadIOEffect, TimeEffect].}

1458 | Send ping command to the server Returns: bool True if successfully reaching the server. 1459 | 1460 |

proc quit(this: AsyncSonic): Future[string] {...}{.raises: [FutureError], 1463 | tags: [RootEffect].}

1465 | Quit the channel and closes the connection. 1466 | 1467 |

proc quit(this: Sonic): string {...}{.raises: [SslError, OSError, TimeoutError, 1470 | SonicServerError], 1471 | tags: [WriteIOEffect, ReadIOEffect, TimeEffect].}

1473 | Quit the channel and closes the connection. 1474 | 1475 |

proc help(this: AsyncSonic; arg: string): Future[string] {...}{.raises: [FutureError], 1478 | tags: [RootEffect].}

1480 | Sends Help query. 1481 | 1482 |

proc help(this: Sonic; arg: string): string {...}{.raises: [SslError, OSError, TimeoutError, 1485 | SonicServerError], tags: [WriteIOEffect, ReadIOEffect, TimeEffect].}

1487 | Sends Help query. 1488 | 1489 |

proc push(this: AsyncSonic; collection, bucket, objectName, text: string; lang = ""): Future[ 1492 | bool] {...}{.raises: [FutureError], tags: [RootEffect].}

1494 |

Push search data in the index

collection: index collection (ie. what you search in, eg. messages, products, etc.)
bucket: index bucket name (ie. user-specific search classifier in the collection if you have any eg. user-1, user-2, .., otherwise use a common bucket name eg. generic, procault, common, ..)
objectName: object identifier that refers to an entity in an external database, where the searched object is stored (eg. you use Sonic to index CRM contacts by name; full CRM contact data is stored in a MySQL database; in this case the object identifier in Sonic will be the MySQL primary key for the CRM contact)
text: search text to be indexed can be a single word, or a longer text; within maximum length safety limits
lang: ISO language code

1501 |

Returns:: bool True if search data are pushed in the index.

1504 |

1506 | 1507 | 1508 |

proc push(this: Sonic; collection, bucket, objectName, text: string; lang = ""): bool {...}{. 1511 | raises: [SslError, OSError, TimeoutError, SonicServerError], 1512 | tags: [WriteIOEffect, ReadIOEffect, TimeEffect].}

1514 |

Push search data in the index

collection: index collection (ie. what you search in, eg. messages, products, etc.)
bucket: index bucket name (ie. user-specific search classifier in the collection if you have any eg. user-1, user-2, .., otherwise use a common bucket name eg. generic, procault, common, ..)
objectName: object identifier that refers to an entity in an external database, where the searched object is stored (eg. you use Sonic to index CRM contacts by name; full CRM contact data is stored in a MySQL database; in this case the object identifier in Sonic will be the MySQL primary key for the CRM contact)
text: search text to be indexed can be a single word, or a longer text; within maximum length safety limits
lang: ISO language code

1521 |

Returns:: bool True if search data are pushed in the index.

1524 |

1526 | 1527 | 1528 |

proc pop(this: AsyncSonic; collection, bucket, objectName, text: string): Future[int] {...}{. 1531 | raises: [FutureError], tags: [RootEffect].}

1533 |

Pop search data from the index

collection: index collection (ie. what you search in, eg. messages, products, etc.)
bucket: index bucket name (ie. user-specific search classifier in the collection if you have any eg. user-1, user-2, .., otherwise use a common bucket name eg. generic, procault, common, ..)
objectName: object identifier that refers to an entity in an external database, where the searched object is stored (eg. you use Sonic to index CRM contacts by name; full CRM contact data is stored in a MySQL database; in this case the object identifier in Sonic will be the MySQL primary key for the CRM contact)
text: search text to be indexed can be a single word, or a longer text; within maximum length safety limits

1539 |

Returns:: int

1542 |

1544 | 1545 | 1546 |

proc pop(this: Sonic; collection, bucket, objectName, text: string): int {...}{.raises: [ 1549 | SslError, OSError, TimeoutError, SonicServerError, OverflowError, ValueError], 1550 | tags: [WriteIOEffect, ReadIOEffect, TimeEffect].}

1552 |

Pop search data from the index

collection: index collection (ie. what you search in, eg. messages, products, etc.)
bucket: index bucket name (ie. user-specific search classifier in the collection if you have any eg. user-1, user-2, .., otherwise use a common bucket name eg. generic, procault, common, ..)
objectName: object identifier that refers to an entity in an external database, where the searched object is stored (eg. you use Sonic to index CRM contacts by name; full CRM contact data is stored in a MySQL database; in this case the object identifier in Sonic will be the MySQL primary key for the CRM contact)
text: search text to be indexed can be a single word, or a longer text; within maximum length safety limits

1558 |

Returns:: int

1561 |

1563 | 1564 | 1565 |

proc count(this: AsyncSonic; collection, bucket, objectName: string): Future[int] {...}{. 1568 | raises: [FutureError], tags: [RootEffect].}

1570 |

Count indexed search data

collection: index collection (ie. what you search in, eg. messages, products, etc.)
bucket: index bucket name (ie. user-specific search classifier in the collection if you have any eg. user-1, user-2, .., otherwise use a common bucket name eg. generic, procault, common, ..)
objectName: object identifier that refers to an entity in an external database, where the searched object is stored (eg. you use Sonic to index CRM contacts by name; full CRM contact data is stored in a MySQL database; in this case the object identifier in Sonic will be the MySQL primary key for the CRM contact)

1575 |

1577 |

Returns: int count of index search data.

1578 | 1579 | 1580 |

proc count(this: Sonic; collection, bucket, objectName: string): int {...}{.raises: [ 1583 | OverflowError, ValueError, SslError, OSError, TimeoutError, SonicServerError], 1584 | tags: [WriteIOEffect, ReadIOEffect, TimeEffect].}

1586 |

Count indexed search data

collection: index collection (ie. what you search in, eg. messages, products, etc.)
bucket: index bucket name (ie. user-specific search classifier in the collection if you have any eg. user-1, user-2, .., otherwise use a common bucket name eg. generic, procault, common, ..)
objectName: object identifier that refers to an entity in an external database, where the searched object is stored (eg. you use Sonic to index CRM contacts by name; full CRM contact data is stored in a MySQL database; in this case the object identifier in Sonic will be the MySQL primary key for the CRM contact)

1591 |

1593 |

Returns: int count of index search data.

1594 | 1595 | 1596 |

proc flushCollection(this: AsyncSonic; collection: string): Future[int] {...}{. 1599 | raises: [FutureError], tags: [RootEffect].}

1601 |

Flush all indexed data from a collection

collection index collection (ie. what you search in, eg. messages, products, etc.)

1604 |

Returns:
1605 |
int number of flushed data
1606 |
1607 |

1608 |

1610 | 1611 | 1612 |

proc flushCollection(this: Sonic; collection: string): int {...}{.raises: [OverflowError, 1615 | ValueError, SslError, OSError, TimeoutError, SonicServerError], 1616 | tags: [WriteIOEffect, ReadIOEffect, TimeEffect].}

1618 |

Flush all indexed data from a collection

collection index collection (ie. what you search in, eg. messages, products, etc.)

1621 |

Returns:
1622 |
int number of flushed data
1623 |
1624 |

1625 |

1627 | 1628 | 1629 |

proc flushBucket(this: AsyncSonic; collection, bucket: string): Future[int] {...}{. 1632 | raises: [FutureError], tags: [RootEffect].}

1634 |

Flush all indexed data from a bucket in a collection

collection: index collection (ie. what you search in, eg. messages, products, etc.)
bucket: index bucket name (ie. user-specific search classifier in the collection if you have any eg. user-1, user-2, .., otherwise use a common bucket name eg. generic, procault, common, ..)

1638 |

Returns:: int number of flushed data

1641 |

1643 | 1644 | 1645 |

proc flushBucket(this: Sonic; collection, bucket: string): int {...}{.raises: [OverflowError, 1648 | ValueError, SslError, OSError, TimeoutError, SonicServerError], 1649 | tags: [WriteIOEffect, ReadIOEffect, TimeEffect].}

1651 |

Flush all indexed data from a bucket in a collection

collection: index collection (ie. what you search in, eg. messages, products, etc.)
bucket: index bucket name (ie. user-specific search classifier in the collection if you have any eg. user-1, user-2, .., otherwise use a common bucket name eg. generic, procault, common, ..)

1655 |

Returns:: int number of flushed data

1658 |

1660 | 1661 | 1662 |

proc flushObject(this: AsyncSonic; collection, bucket, objectName: string): Future[int] {...}{. 1665 | raises: [FutureError], tags: [RootEffect].}

1667 |

Flush all indexed data from an object in a bucket in collection

collection: index collection (ie. what you search in, eg. messages, products, etc.)
bucket: index bucket name (ie. user-specific search classifier in the collection if you have any eg. user-1, user-2, .., otherwise use a common bucket name eg. generic, procault, common, ..)
objectName: object identifier that refers to an entity in an external database, where the searched object is stored (eg. you use Sonic to index CRM contacts by name; full CRM contact data is stored in a MySQL database; in this case the object identifier in Sonic will be the MySQL primary key for the CRM contact)

1672 |

Returns:: int number of flushed data

1675 |

1677 | 1678 | 1679 |

proc flushObject(this: Sonic; collection, bucket, objectName: string): int {...}{.raises: [ 1682 | OverflowError, ValueError, SslError, OSError, TimeoutError, SonicServerError], 1683 | tags: [WriteIOEffect, ReadIOEffect, TimeEffect].}

1685 |

Flush all indexed data from an object in a bucket in collection

collection: index collection (ie. what you search in, eg. messages, products, etc.)
bucket: index bucket name (ie. user-specific search classifier in the collection if you have any eg. user-1, user-2, .., otherwise use a common bucket name eg. generic, procault, common, ..)
objectName: object identifier that refers to an entity in an external database, where the searched object is stored (eg. you use Sonic to index CRM contacts by name; full CRM contact data is stored in a MySQL database; in this case the object identifier in Sonic will be the MySQL primary key for the CRM contact)

1690 |

Returns:: int number of flushed data

1693 |

1695 | 1696 | 1697 |

proc flush(this: AsyncSonic; collection: string; bucket = ""; objectName = ""): Future[int] {...}{. 1700 | raises: [FutureError], tags: [RootEffect].}

1702 |

Flush indexed data in a collection, bucket, or in an object.

collection: index collection (ie. what you search in, eg. messages, products, etc.)
bucket: index bucket name (ie. user-specific search classifier in the collection if you have any eg. user-1, user-2, .., otherwise use a common bucket name eg. generic, procault, common, ..)
objectName: object identifier that refers to an entity in an external database, where the searched object is stored (eg. you use Sonic to index CRM contacts by name; full CRM contact data is stored in a MySQL database; in this case the object identifier in Sonic will be the MySQL primary key for the CRM contact)

1707 |

Returns:: int number of flushed data

1710 |

1712 | 1713 | 1714 |

proc flush(this: Sonic; collection: string; bucket = ""; objectName = ""): int {...}{.raises: [ 1717 | OverflowError, ValueError, SslError, OSError, TimeoutError, SonicServerError], 1718 | tags: [WriteIOEffect, ReadIOEffect, TimeEffect].}

1720 |

Flush indexed data in a collection, bucket, or in an object.

collection: index collection (ie. what you search in, eg. messages, products, etc.)
bucket: index bucket name (ie. user-specific search classifier in the collection if you have any eg. user-1, user-2, .., otherwise use a common bucket name eg. generic, procault, common, ..)
objectName: object identifier that refers to an entity in an external database, where the searched object is stored (eg. you use Sonic to index CRM contacts by name; full CRM contact data is stored in a MySQL database; in this case the object identifier in Sonic will be the MySQL primary key for the CRM contact)

1725 |

Returns:: int number of flushed data

1728 |

1730 | 1731 | 1732 |

proc query(this: AsyncSonic; collection, bucket, terms: string; limit = 10; 1735 | offset: int = 0; lang = ""): Future[seq[string]] {...}{.raises: [FutureError], 1736 | tags: [RootEffect].}

1738 |

Query the database

collection index collection (ie. what you search in, eg. messages, products, etc.)
bucket index bucket name (ie. user-specific search classifier in the collection if you have any eg. user-1, user-2, .., otherwise use a common bucket name eg. generic, procault, common, ..)
terms text for search terms
limit a positive integer number; set within allowed maximum & minimum limits
offset a positive integer number; set within allowed maximum & minimum limits
lang an ISO 639-3 locale code eg. eng for English (if set, the locale must be a valid ISO 639-3 code; if not set, the locale will be guessed from text).

1746 |

Returns:: list list of objects ids.

1749 |

1751 | 1752 | 1753 |

proc query(this: Sonic; collection, bucket, terms: string; limit = 10; offset: int = 0; 1756 | lang = ""): seq[string] {...}{.raises: [SslError, OSError, TimeoutError, 1757 | SonicServerError], 1758 | tags: [WriteIOEffect, ReadIOEffect, TimeEffect].}

1760 |

Query the database

collection index collection (ie. what you search in, eg. messages, products, etc.)
bucket index bucket name (ie. user-specific search classifier in the collection if you have any eg. user-1, user-2, .., otherwise use a common bucket name eg. generic, procault, common, ..)
terms text for search terms
limit a positive integer number; set within allowed maximum & minimum limits
offset a positive integer number; set within allowed maximum & minimum limits
lang an ISO 639-3 locale code eg. eng for English (if set, the locale must be a valid ISO 639-3 code; if not set, the locale will be guessed from text).

1768 |

Returns:: list list of objects ids.

1771 |

1773 | 1774 | 1775 |

proc suggest(this: AsyncSonic; collection, bucket, word: string; limit = 10): Future[ 1778 | seq[string]] {...}{.raises: [FutureError], tags: [RootEffect].}

1780 |

auto-completes word.

collection index collection (ie. what you search in, eg. messages, products, etc.)
bucket index bucket name (ie. user-specific search classifier in the collection if you have any eg. user-1, user-2, .., otherwise use a common bucket name eg. generic, procault, common, ..)
word word to autocomplete
limit a positive integer number; set within allowed maximum & minimum limits (procault: {None})

1786 |

Returns:: list list of suggested words.

1789 |

1791 | 1792 | 1793 |

proc suggest(this: Sonic; collection, bucket, word: string; limit = 10): seq[string] {...}{. 1796 | raises: [SslError, OSError, TimeoutError, SonicServerError], 1797 | tags: [WriteIOEffect, ReadIOEffect, TimeEffect].}

1799 |

auto-completes word.

collection index collection (ie. what you search in, eg. messages, products, etc.)
bucket index bucket name (ie. user-specific search classifier in the collection if you have any eg. user-1, user-2, .., otherwise use a common bucket name eg. generic, procault, common, ..)
word word to autocomplete
limit a positive integer number; set within allowed maximum & minimum limits (procault: {None})

1805 |

Returns:: list list of suggested words.

1808 |

1810 | 1811 | 1812 |

proc trigger(this: AsyncSonic; action = ""): Future[string] {...}{.raises: [FutureError], 1815 | tags: [RootEffect].}

1817 |

Trigger an action: action text for action

1820 | 1821 | 1822 |

proc trigger(this: Sonic; action = ""): string {...}{. 1825 | raises: [SslError, OSError, TimeoutError, SonicServerError], 1826 | tags: [WriteIOEffect, ReadIOEffect, TimeEffect].}

1828 |

Trigger an action: action text for action

1831 | 1832 | 1833 |

1836 | 1837 |

sonic

Types

Procs