Skip to content

Commit

Permalink
Merge pull request #134 from Arhell/docs
Browse files Browse the repository at this point in the history
update docs folder links
  • Loading branch information
bizley authored Sep 8, 2023
2 parents 33295a5 + 22651a7 commit 9e5da67
Show file tree
Hide file tree
Showing 12 changed files with 19 additions and 19 deletions.
4 changes: 2 additions & 2 deletions docs/guide-ja/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
Yii 2 Sphinx エクステンション
=============================

このエクステンションは Yii 2 フレームワークに [Sphinx](http://sphinxsearch.com/docs) 全文検索エンジンのサポートを追加します。
このエクステンションは、[実行時インデックス](http://sphinxsearch.com/docs/current.html#rt-indexes) も含めて、Sphinx の全ての機能をサポートしています。
このエクステンションは Yii 2 フレームワークに [Sphinx](https://sphinxsearch.com/docs) 全文検索エンジンのサポートを追加します。
このエクステンションは、[実行時インデックス](https://sphinxsearch.com/docs/current.html#rt-indexes) も含めて、Sphinx の全ての機能をサポートしています。

始めよう
--------
Expand Down
2 changes: 1 addition & 1 deletion docs/guide-ja/distributed-indexes.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
========================

このエクステンションは Sphinx のインデックス構造 (フィールド名と型) を取得するのに `DESCRIBE` クエリを使用します。
しかし、[分散されたインデックス](http://sphinxsearch.com/docs/current.html#distributed) の場合は、何時でもそれが出来るとは限りません。
しかし、[分散されたインデックス](https://sphinxsearch.com/docs/current.html#distributed) の場合は、何時でもそれが出来るとは限りません。
そのようなインデックスのスキーマは、その宣言に少なくとも一つは利用可能なローカルのインデックスが含まれていなければ、取得できません。
例えば、

Expand Down
4 changes: 2 additions & 2 deletions docs/guide-ja/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

## Composer パッケージを取得する

このエクステンションをインストールするのに推奨される方法は [composer](http://getcomposer.org/download/) によるものです。
このエクステンションをインストールするのに推奨される方法は [composer](https://getcomposer.org/download/) によるものです。

下記のコマンドを実行してください。

Expand All @@ -26,7 +26,7 @@ php composer.phar require --prefer-dist yiisoft/yii2-sphinx

## 構成

このエクステンションは、MySQL プロトコルと [SphinxQL](http://sphinxsearch.com/docs/current.html#sphinxql) クエリ言語を使用して Sphinx 検索デーモンとやりとりをします。
このエクステンションは、MySQL プロトコルと [SphinxQL](https://sphinxsearch.com/docs/current.html#sphinxql) クエリ言語を使用して Sphinx 検索デーモンとやりとりをします。
Sphinx の "searchd" が MySQL プロトコルをサポートするように設定するために、下記の構成情報を追加しなければなりません。

```
Expand Down
2 changes: 1 addition & 1 deletion docs/guide-ja/usage-meta.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
クエリのメタ情報を取得する
==========================

Sphinx では、[SHOW META](http://sphinxsearch.com/docs/current.html#sphinxql-show-meta) SphinxQL 文によって、最後に実行されたクエリの統計的な情報を取得することが出来ます。
Sphinx では、[SHOW META](https://sphinxsearch.com/docs/current.html#sphinxql-show-meta) SphinxQL 文によって、最後に実行されたクエリの統計的な情報を取得することが出来ます。
この情報は、通常、追加の `SELECT COUNT(*) ...` クエリを発行せずにインデックス中の総行数を取得するのに使用されます。
`SHOW META` のクエリは何時でも手動で実行することが出来ますが、`yii\sphinx\Query` を使えば、
余計な労力を費やさずとも、自動でこれを実行することが出来ます。
Expand Down
4 changes: 2 additions & 2 deletions docs/guide-ru/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
Расширение Sphinx для Yii 2
==========================

Это расширение добавляет полнотекстовый поисковый движок [Sphinx](http://sphinxsearch.com/docs) для фреймворка Yii 2.
Он поддерживает все функции Sphinx, включая [Real-time индексы](http://sphinxsearch.com/docs/current.html#rt-indexes).
Это расширение добавляет полнотекстовый поисковый движок [Sphinx](https://sphinxsearch.com/docs) для фреймворка Yii 2.
Он поддерживает все функции Sphinx, включая [Real-time индексы](https://sphinxsearch.com/docs/current.html#rt-indexes).

Как начать
---------------
Expand Down
2 changes: 1 addition & 1 deletion docs/guide-ru/distributed-indexes.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
================================

Это расширение использует запрос `DESCRIBE` для получения информации о структуре индекса Sphinx (имена полей и типы).
Однако для [распределенных индексов](http://sphinxsearch.com/docs/current.html#distributed) это не всегда возможно.
Однако для [распределенных индексов](https://sphinxsearch.com/docs/current.html#distributed) это не всегда возможно.
Схема такого индекса может быть найдена только, если его объявление содержит в списке один доступный локальный индекс.
Например:

Expand Down
4 changes: 2 additions & 2 deletions docs/guide-ru/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

## Получение с помощью Composer

Предпочтительный способ установки расширения через [composer](http://getcomposer.org/download/).
Предпочтительный способ установки расширения через [composer](https://getcomposer.org/download/).

Для этого запустите

Expand All @@ -25,7 +25,7 @@ php composer.phar require --prefer-dist yiisoft/yii2-sphinx

## Конфигурация

Это расширение взаимодействует с демоном поиска Sphinx, используя протокол MySQL и язык запросов [SphinxQL](http://sphinxsearch.com/docs/current.html#sphinxql).
Это расширение взаимодействует с демоном поиска Sphinx, используя протокол MySQL и язык запросов [SphinxQL](https://sphinxsearch.com/docs/current.html#sphinxql).
Чтобы настроить Sphinx "searchd" для поддержки протокола MySQL, необходимо добавить следующую конфигурацию:

```
Expand Down
4 changes: 2 additions & 2 deletions docs/guide-ru/usage-meta.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Извлечение META информации
===============================

Sphinx позволяет получать статистическую информацию о последнем выполненном запросе с помощью инструкции [SHOW META](http://sphinxsearch.com/docs/current.html#sphinxql-show-meta) SphinxQL.
Sphinx позволяет получать статистическую информацию о последнем выполненном запросе с помощью инструкции [SHOW META](https://sphinxsearch.com/docs/current.html#sphinxql-show-meta) SphinxQL.
Эта информация обычно используется для получения общего количества строк в индексе без дополнительного запроса `SELECT COUNT (*) ...`.
Хотя вы всегда можете запустить такой запрос вручную, `yii\sphinx\Query` позволяет вам делать это автоматически без дополнительных усилий.
Все, что вам нужно сделать, это включить `yii\sphinx\Query::showMeta` и использовать `yii\sphinx\Query::search()` для извлечения всех строк и метаинформации:
Expand All @@ -18,4 +18,4 @@ $meta = $results['meta'];
$totalItemCount = $results['meta']['total'];
```

> Note: Общее количество элементов, которое может быть извлечено из 'meta', ограничено опцией sphinx `max_matches`. Если ваш индекс содержит больше записей, чем значение `max_matches` (обычно - 1000), вы должны либо поднять` max_matches` через [[Query::options]], либо использовать [[Query::count()]], чтобы получить количество записей.
> Note: Общее количество элементов, которое может быть извлечено из 'meta', ограничено опцией sphinx `max_matches`. Если ваш индекс содержит больше записей, чем значение `max_matches` (обычно - 1000), вы должны либо поднять` max_matches` через [[Query::options]], либо использовать [[Query::count()]], чтобы получить количество записей.
4 changes: 2 additions & 2 deletions docs/guide/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
Sphinx Extension for Yii 2
==========================

This extension adds [Sphinx](http://sphinxsearch.com/docs) full text search engine extension for the Yii 2 framework.
It supports all Sphinx features including [Real-time Indexes](http://sphinxsearch.com/docs/current.html#rt-indexes).
This extension adds [Sphinx](https://sphinxsearch.com/docs) full text search engine extension for the Yii 2 framework.
It supports all Sphinx features including [Real-time Indexes](https://sphinxsearch.com/docs/current.html#rt-indexes).

Getting Started
---------------
Expand Down
2 changes: 1 addition & 1 deletion docs/guide/distributed-indexes.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Working with distributed indexes
================================

This extension uses `DESCRIBE` query in order to fetch information about Sphinx index structure (field names and types).
However for the [distributed indexes](http://sphinxsearch.com/docs/current.html#distributed) it is not always possible.
However for the [distributed indexes](https://sphinxsearch.com/docs/current.html#distributed) it is not always possible.
Schema of such index can be found only, if its declaration contains at list one available local index.
For example:

Expand Down
4 changes: 2 additions & 2 deletions docs/guide/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ higher is required.

## Getting Composer package

The preferred way to install this extension is through [composer](http://getcomposer.org/download/).
The preferred way to install this extension is through [composer](https://getcomposer.org/download/).

Either run

Expand All @@ -26,7 +26,7 @@ to the require section of your composer.json.

## Configuration

This extension interacts with Sphinx search daemon using MySQL protocol and [SphinxQL](http://sphinxsearch.com/docs/current.html#sphinxql) query language.
This extension interacts with Sphinx search daemon using MySQL protocol and [SphinxQL](https://sphinxsearch.com/docs/current.html#sphinxql) query language.
In order to setup Sphinx "searchd" to support MySQL protocol following configuration should be added:

```
Expand Down
2 changes: 1 addition & 1 deletion docs/guide/usage-meta.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Fetching query META information
===============================

Sphinx allows fetching statistical information about last performed query via [SHOW META](http://sphinxsearch.com/docs/current.html#sphinxql-show-meta) SphinxQL statement.
Sphinx allows fetching statistical information about last performed query via [SHOW META](https://sphinxsearch.com/docs/current.html#sphinxql-show-meta) SphinxQL statement.
This information is commonly used to get total count of rows in the index without extra `SELECT COUNT(*) ...` query.
Although you can always run such query manually, `yii\sphinx\Query` allows you to do this automatically without extra efforts.
All you need to do is enable `yii\sphinx\Query::showMeta` and use `yii\sphinx\Query::search()` to fetch all rows and
Expand Down

0 comments on commit 9e5da67

Please sign in to comment.