From 12625dd2745ca4e8bf9b245b4941164c245845cb Mon Sep 17 00:00:00 2001 From: Konstantin Kuklin Date: Mon, 15 Sep 2014 16:36:19 +0400 Subject: [PATCH] added docs about open index #8 --- README.md | 2 ++ README.rus.md | 2 ++ docs/eng/OpenIndex.md | 40 ++++++++++++++++++++++++++++++++++++++++ docs/eng/Select.md | 2 +- docs/rus/OpenIndex.md | 38 ++++++++++++++++++++++++++++++++++++++ 5 files changed, 83 insertions(+), 1 deletion(-) create mode 100644 docs/eng/OpenIndex.md create mode 100644 docs/rus/OpenIndex.md diff --git a/README.md b/README.md index 9733378..d9ea241 100644 --- a/README.md +++ b/README.md @@ -55,6 +55,8 @@ $writer = new \HS\Writer('localhost', 9999); Queries ------------ +- [Open Index](docs/eng/OpenIndex.md) + - [Select](docs/eng/Select.md) - [Insert](docs/eng/Insert.md) diff --git a/README.rus.md b/README.rus.md index 9378538..883ea57 100644 --- a/README.rus.md +++ b/README.rus.md @@ -49,6 +49,8 @@ $writer = new \HS\Writer('localhost', 9999); Запросы ------------ +- [Open Index](docs/rus/OpenIndex.md) + - [Select](docs/rus/Select.md) - [Insert](docs/rus/Insert.md) diff --git a/docs/eng/OpenIndex.md b/docs/eng/OpenIndex.md new file mode 100644 index 0000000..5e44d34 --- /dev/null +++ b/docs/eng/OpenIndex.md @@ -0,0 +1,40 @@ +Open index +------------ + +Open a connection to the read socket, and authorize with the password `passwordRead` + +```php +$reader = new \HS\Reader('localhost', 9998, 'passwordRead'); +``` + +When you open the index you must use a numeric identifier. If the identifier was not used, it will simply be assigned +new index, if you have already used this index number, the new index just overwrite the old one. + +Therefore it is very important to store information about all open indexes in the current connection, not to open several times indexes. +An example of a method that checks and not open if we already has index, which we need, if so, just returns us to the identifier +if not, it opens a new index, and returns us to its identifier. + +```php +$indexId = $reader->getIndexId( + 'database', + 'tableName', + 'PRIMARY', + array('key', 'text') +); +``` + +If we just need to open the subscript c number 12 (for example), and we don't want to check: + +```php +$indexIndexQuery = $reader->openIndex( + '12' + 'database', + 'tableName', + 'PRIMARY', + array('key', 'text'), + array('num') +); +``` + +Here we open the index with identifier 12, columns `key`,` text`, and the column to filter `num`. +Method returns us to the class OpenIndexQuery. \ No newline at end of file diff --git a/docs/eng/Select.md b/docs/eng/Select.md index 064163a..e063231 100644 --- a/docs/eng/Select.md +++ b/docs/eng/Select.md @@ -1,7 +1,7 @@ Select from opened index ------------ -Open a connection to a read socket, and to authorize with the password `passwordRead` +Open a connection to the read socket, and authorize with the password `passwordRead` ```php $reader = new \HS\Reader('localhost', 9998, 'passwordRead'); ``` diff --git a/docs/rus/OpenIndex.md b/docs/rus/OpenIndex.md new file mode 100644 index 0000000..9725f2a --- /dev/null +++ b/docs/rus/OpenIndex.md @@ -0,0 +1,38 @@ +Открываем Индекс +------------ + +Открываем соединение на сокет только для чления и авторизовываемся с паролем `passwordRead` +```php +$reader = new \HS\Reader('localhost', 9998, 'passwordRead'); +``` + +При открытии индекса используется числовой идентификатор. Если этот идентификатор еще не использовался, то ему просто будет присвоен +новый индекс, если же он уже использовался, то новый индекс просто перезапишет старый. + +Поэтому очень важно хранить данные обо всех открытых индексах в рамках текущего подключения, чтобы не открывать по несколько раз индексы. +Пример команды, которая проверяет, а не открыт ли у нас уже индекс, который нам нужен, если да, то просто возвращает нам идентификатор, +если нет, то открывает новый индекс и возвращает нам его идентификатор. +```php +$indexId = $reader->getIndexId( + 'database', + 'tableName', + 'PRIMARY', + array('key', 'text') +); +``` + +Если нам нужно просто открыть индекс c номер 12(например), и мы ничего не хотим проверять: + +```php +$indexIndexQuery = $reader->openIndex( + '12' + 'database', + 'tableName', + 'PRIMARY', + array('key', 'text'), + array('num') +); +``` + +Здесь мы открываем индекс c номером 12, колонками `key`, `text`, а так же колонкой для фильтров `num`. +Метод вернет нам класс OpenIndexQuery. \ No newline at end of file