Skip to content

Commit 2ef8c65

Browse files
softarksamdark
softark
authored and
samdark
committed
guide-ja added [ci skip] (yiisoft#227)
* docs/guide-ja translation WIP [ci skip] * docs/guide-ja adding translations WIP [ci skip] * docs/guide-ja added translatiions [ci skip]
1 parent 8d481d9 commit 2ef8c65

14 files changed

+1046
-0
lines changed

‎docs/guide-ja/README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
Yii2 キュー・エクステンション
2+
=============================
3+
4+
キューによってタスクを非同期に走らせるためのエクステンション。
5+
6+
導入
7+
----
8+
9+
* [基本的な使用方法](usage.md)
10+
* [エラーと再試行可能ジョブ](retryable.md)
11+
* [ワーカを開始する](worker.md)
12+
13+
キュー・ドライバ
14+
----------------
15+
16+
* [同期](driver-sync.md)
17+
* [ファイル](driver-file.md)
18+
* [データベース](driver-db.md)
19+
* [Redis](driver-redis.md)
20+
* [RabbitMQ](driver-amqp.md)
21+
* [AMQP Interop](driver-amqp-interop.md)
22+
* [Beanstalk](driver-beanstalk.md)
23+
* [Gearman](driver-gearman.md)
24+
25+
開発ツール
26+
----------
27+
28+
* [デバッグ](debug.md)
29+
* [Gii コード・ジェネレータ](gii.md)

‎docs/guide-ja/debug.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
デバッグ
2+
========
3+
4+
開発中は、Yii2 デバッグ・モジュールのためのパネルを追加したいと思うことも有るでしょう。
5+
このパネルは、キューにあるタスクのカウンタとリストを表示します。
6+
7+
このパネルが表示されるためには、`yiisoft/yii2-debug` モジュールがアプリケーションにインストールされていなければなりません。
8+
9+
以下のようにアプリケーションを構成して下さい。
10+
11+
```php
12+
return [
13+
'modules' => [
14+
'debug' => [
15+
'class' => \yii\debug\Module::class,
16+
'panels' => [
17+
'queue' => \yii\queue\debug\Panel::class,
18+
],
19+
],
20+
],
21+
];
22+
```

‎docs/guide-ja/driver-amqp-interop.md

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
AMQP Interop
2+
============
3+
4+
このドライバは RabbitMQ のキューによって動作します。
5+
6+
[amqp interop](https://github.com/queue-interop/queue-interop#amqp-interop) 互換のトランスポート、例えば `enqueue/amqp-lib` パッケージを必要とします。
7+
8+
利点:
9+
10+
* amqp interop 互換のトランスポートであれば、何でも動作します。例えば、
11+
12+
* [PHP amqp extension](https://github.com/pdezwart/php-amqp) に基づく [enqueue/amqp-ext](https://github.com/php-enqueue/amqp-ext)
13+
* [php-amqplib/php-amqplib](https://github.com/php-amqplib/php-amqplib) に基づく [enqueue/amqp-lib](https://github.com/php-enqueue/amqp-lib)
14+
* [bunny](https://github.com/jakubkulhan/bunny) に基づく [enqueue/amqp-bunny](https://github.com/php-enqueue/amqp-bunny)
15+
16+
* 優先度をサポート
17+
* 遅延をサポート
18+
* TTR をサポート
19+
* 試行回数をサポート
20+
* 新しいオプション: vhost, connection_timeout, qos_prefetch_count 等々
21+
* Secure (SSL) AMQP 接続をサポート
22+
* DSN を設定できる: 例えば、amqp:, amqps: または amqp://user:pass@localhost:1000/vhost
23+
24+
構成例:
25+
26+
```php
27+
return [
28+
'bootstrap' => [
29+
'queue', // コンポーネントが自身のコンソール・コマンドを登録します
30+
],
31+
'components' => [
32+
'queue' => [
33+
'class' => \yii\queue\amqp_interop\Queue::class,
34+
'port' => 5672,
35+
'user' => 'guest',
36+
'password' => 'guest',
37+
'queueName' => 'queue',
38+
'driver' => yii\queue\amqp_interop\Queue::ENQUEUE_AMQP_LIB,
39+
40+
// または
41+
'dsn' => 'amqp://guest:guest@localhost:5672/%2F',
42+
43+
// または、上記と同じ
44+
'dsn' => 'amqp:',
45+
],
46+
],
47+
];
48+
```
49+
50+
コンソール
51+
----------
52+
53+
キューに入れられたジョブを実行するためにコンソール・コマンドが使用されます。
54+
55+
```sh
56+
yii queue/listen [timeout]
57+
```
58+
59+
`listen` コマンドが無限にキューを調べ続けるデーモンを起動します。キューに新しいタスクがあると、即座に取得され、実行されます。
60+
`timeout` パラメータはキューを調べる間のスリープの秒数を指定するものです。
61+
62+
このコマンドを [supervisor](worker.md#supervisor) または [systemd](worker.md#systemd) によって適切にデーモン化するのが、最も効率的な方法です。

‎docs/guide-ja/driver-amqp.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
RabbitMQ ドライバ
2+
=================
3+
4+
**注意:** このドライバは 2.0.2 以降、非推奨となっており、2.1 では削除される予定です。
5+
代替として [amqp_interop](driver-amqp-interop.md) ドライバの使用を検討して下さい。
6+
7+
このドライバは RabbitMQ のキューによって動作します。
8+
9+
`php-amqplib/php-amqplib` パッケージを必要とします。
10+
11+
構成例:
12+
13+
```php
14+
return [
15+
'bootstrap' => [
16+
'queue', // コンポーネントが自身のコンソール・コマンドを登録します
17+
],
18+
'components' => [
19+
'queue' => [
20+
'class' => \yii\queue\amqp\Queue::class,
21+
'host' => 'localhost',
22+
'port' => 5672,
23+
'user' => 'guest',
24+
'password' => 'guest',
25+
'queueName' => 'queue',
26+
],
27+
],
28+
];
29+
```
30+
31+
コンソール
32+
----------
33+
34+
キューに入れられたジョブを実行するためにコンソール・コマンドが使用されます。
35+
36+
```sh
37+
yii queue/listen [timeout]
38+
```
39+
40+
`listen` コマンドが無限にキューを調べ続けるデーモンを起動します。キューに新しいタスクがあると、即座に取得され、実行されます。
41+
`timeout` パラメータはキューを調べる間のスリープの秒数を指定するものです。
42+
43+
このコマンドを [supervisor](worker.md#supervisor) または [systemd](worker.md#systemd) によって適切にデーモン化するのが、最も効率的な方法です。

‎docs/guide-ja/driver-beanstalk.md

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
Beanstalk ドライバ
2+
==================
3+
4+
このドライバは Beanstalk のキューによって動作します。
5+
6+
構成例:
7+
8+
```php
9+
return [
10+
'bootstrap' => [
11+
'queue', // コンポーネントが自身のコンソール・コマンドを登録します
12+
],
13+
'components' => [
14+
'queue' => [
15+
'class' => \yii\queue\beanstalk\Queue::class,
16+
'host' => 'localhost',
17+
'port' => 11300,
18+
'tube' => 'queue',
19+
],
20+
],
21+
];
22+
```
23+
24+
コンソール
25+
----------
26+
27+
キューに入れられたジョブの実行と管理のためにコンソール・コマンドが使用されます。
28+
29+
```sh
30+
yii queue/listen [timeout]
31+
```
32+
33+
`listen` コマンドは無限にキューを調べ続けるデーモンを起動します。キューに新しいタスクがあると、即座に取得され、実行されます。
34+
`timeout` パラメータはキューを調べる間のスリープの秒数を指定するものです。
35+
36+
このコマンドを [supervisor](worker.md#supervisor) または [systemd](worker.md#systemd) によって適切にデーモン化するのが、最も効率的な方法です。
37+
38+
```sh
39+
yii queue/run
40+
```
41+
42+
`run` コマンドは、キューが空になるまでループして、タスクを取得し、実行します。
43+
[cron](worker.md#cron) に向いた方法です。
44+
45+
`run` および `listen` のコマンドは下記のオプションを持っています。
46+
47+
- `--verbose`, `-v`: 実行の状態をコンソールに表示します。
48+
- `--isolate`: ジョブ実行の饒舌モード。有効な場合、各ジョブの実行結果が表示されます。
49+
- `--color`: 饒舌モードでハイライトを有効にします。
50+
51+
```sh
52+
yii queue/info
53+
```
54+
55+
`info` コマンドはキューの状態について情報を表示します。
56+
57+
```sh
58+
yii queue/remove [id]
59+
```
60+
61+
`remove` コマンドはキューからジョブを削除します。

‎docs/guide-ja/driver-db.md

Lines changed: 118 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,118 @@
1+
データベース・ドライバ
2+
======================
3+
4+
データベース・ドライバはキューのデータを保存するのにデータベースを使用します。
5+
6+
構成例:
7+
8+
```php
9+
return [
10+
'bootstrap' => [
11+
'queue', // コンポーネントが自身のコンソール・コマンドを登録します
12+
],
13+
'components' => [
14+
'db' => [
15+
'class' => \yii\db\Connection::class,
16+
// ...
17+
],
18+
'queue' => [
19+
'class' => \yii\queue\db\Queue::class,
20+
'db' => 'db', // DB 接続コンポーネントまたはその構成情報
21+
'tableName' => '{{%queue}}', // テーブル名
22+
'channel' => 'default', // キュー・チャンネル・キー
23+
'mutex' => \yii\mutex\MysqlMutex::class, // クエリ同期のための mutex
24+
],
25+
],
26+
];
27+
```
28+
29+
データベースにテーブルを追加する必要があります。MySQL のためのスキーマ例:
30+
31+
```SQL
32+
CREATE TABLE `queue` (
33+
`id` int(11) NOT NULL AUTO_INCREMENT,
34+
`channel` varchar(255) NOT NULL,
35+
`job` blob NOT NULL,
36+
`pushed_at` int(11) NOT NULL,
37+
`ttr` int(11) NOT NULL,
38+
`delay` int(11) NOT NULL DEFAULT 0,
39+
`priority` int(11) unsigned NOT NULL DEFAULT 1024,
40+
`reserved_at` int(11) DEFAULT NULL,
41+
`attempt` int(11) DEFAULT NULL,
42+
`done_at` int(11) DEFAULT NULL,
43+
PRIMARY KEY (`id`),
44+
KEY `channel` (`channel`),
45+
KEY `reserved_at` (`reserved_at`),
46+
KEY `priority` (`priority`)
47+
) ENGINE=InnoDB
48+
```
49+
50+
マイグレーションが [src/drivers/db/migrations](../../src/drivers/db/migrations) から取得できます。
51+
52+
アプリケーションにマイグレーションを追加するためには、コンソールの構成ファイルを編集して、
53+
[名前空間化されたマイグレーション](http://www.yiiframework.com/doc-2.0/guide-db-migrations.html#namespaced-migrations) を構成して下さい。
54+
55+
```php
56+
'controllerMap' => [
57+
// ...
58+
'migrate' => [
59+
'class' => 'yii\console\controllers\MigrateController',
60+
'migrationPath' => null,
61+
'migrationNamespaces' => [
62+
// ...
63+
'yii\queue\db\migrations',
64+
],
65+
],
66+
],
67+
```
68+
69+
そして、`migrate/up` コマンドを発行します。
70+
71+
```sh
72+
yii migrate/up
73+
```
74+
75+
コンソール
76+
----------
77+
78+
キューに入れられたジョブの実行と管理のためにコンソール・コマンドが使用されます。
79+
80+
```sh
81+
yii queue/listen [timeout]
82+
```
83+
84+
`listen` コマンドは無限にキューを調べ続けるデーモンを起動します。キューに新しいタスクがあると、即座に取得され、実行されます。
85+
`timeout` パラメータはキューを調べる間のスリープの秒数を指定するものです。
86+
87+
このコマンドを [supervisor](worker.md#supervisor) または [systemd](worker.md#systemd) によって適切にデーモン化するのが、最も効率的な方法です。
88+
89+
```sh
90+
yii queue/run
91+
```
92+
93+
`run` コマンドは、キューが空になるまでループして、タスクを取得し、実行します。
94+
[cron](worker.md#cron) に向いた方法です。
95+
96+
`run` および `listen` のコマンドは下記のオプションを持っています。
97+
98+
- `--verbose`, `-v`: 実行の状態をコンソールに表示します。
99+
- `--isolate`: ジョブ実行の饒舌モード。有効な場合、各ジョブの実行結果が表示されます。
100+
- `--color`: 饒舌モードでハイライトを有効にします。
101+
102+
```sh
103+
yii queue/info
104+
```
105+
106+
`info` コマンドはキューの状態について情報を表示します。
107+
108+
```sh
109+
yii queue/clear
110+
```
111+
112+
`clear` コマンドはキューをクリアします。
113+
114+
```sh
115+
yii queue/remove [id]
116+
```
117+
118+
`remove` コマンドはキューからジョブを削除します。

0 commit comments

Comments
 (0)