<commit_before>.. highlightlang:: none

grntest
=======

名前
----

grntest - groongaテストプログラム

書式
----

::

  grntest  [options...] [script] [db]

説明
----

grntestは、groonga汎用テストツールです。

groongaを単独のプロセスとして利用する場合はもちろん、サーバプログラムとして利用する場合の動作確認や実行速度測定が可能です。

grntest を利用するために必要なデータファイルは、ftp.groonga.orgから必要に応じダウンロードしますので、groonga及びgrntestが動作し、インターネットに接続できる環境であればgroongaコマンドの知識がなくてもgroongaの動作を確認できます。

現在は、linux 及びWindows上で動作します。make installしてもインストールは行われません。

オプション
----------
.. cmdoption:: -i, --host <ip/hostname>

  接続するgroongaサーバを、ipアドレスまたはホスト名で指定します。指定先にgroongaサーバが立ち上がっていない場合、接続不能となることに注意してください。このオプションを指定しない場合、grntestは自動的にlocalhostのgroongaサーバを起動して接続します。


.. cmdoption:: -p, --port <port number>

  自動的に起動するgroongaサーバ、または明示的に指定した接続先のgroonga サーバが利用するポート番号を指定します。接続先のgroongaサーバが利用しているポートと、このオプションで指定したポート番号が異なる場合、接続不能となることに注意してください。


.. cmdoption:: --dir

  ftp.groonga.org に用意されているスクリプトファイルを表示します。

.. cmdoption:: --noftp

  通常grntestはftp.groonga.orgとftp通信を行い、scriptファイルの同期やログファイルの送信を行います。--noftp オプションを指定するとftp 通信を一切行わないようになります。存在しないスクリプトファイルを指定した場合、エラーとなることに注意してください。

.. cmdoption:: --log-output-dir

  デフォルトでは、grntest終了後のログファイルの出力先ははカレントディレクトリです。このオプションを利用すると、任意のディレクトリに出力先を変更することができます。

引数
----

.. cmdoption:: script

  grntestの動作方法(以下、grntest命令と呼びます)を記述したテキストファイルです。拡張子は.scrです。

.. cmdoption:: db

  grntestが利用するgroonga データベースです。指定されたデータベースが存在しない場合、grntestが新規に作成します。またgroonga サーバを自動的に起動する場合もこの引数で指定したデータベースが利用されます。接続するgroonga サーバを明示的に指定した場合に利用するデータベースは、接続先サーバが使用中のデータベースになることに注意してください。


使い方
------
まず、シェル上(Windowsならコマンドプロンプト上)で

   grntest test.scr 任意のDB名

とタイプしてください。もしgrntestが正常に動作すれば、

   test-ユーザ名-数字.log

というファイルが作成されるはずです。作成されない場合、、このドキュメントの「トラブルシューティング」の章を参照してください。


スクリプトファイル
------------------

スクリプトファイルは、grntest命令を記述したテキストファイルです。
";"セミコロンを利用して、一行に複数のgrntest命令を記述することができます。一行に複数のgrntest命令がある場合、各命令は並列に実行されます。
"#"で始まる行はコメントとして扱われます。



grntest命令
^^^^^^^^^^^

現在サポートされているgrntest命令は以下の8つです。

  do_local コマンドファイル [スレッド数] [繰り返し数]

    コマンドファイルをgrntest単体で実行します。スレッド数が指定されている場合、複数のスレッドで同じコマンドファイルを同時に実行します。繰り返し数が指定されてい場合、コマンドファイルの内容を繰り返し実行します。スレッド数、繰り返し数とも省略時は1です。1スレッドで複数回動作させたい場合は、do_local コマンドファイル 1 [繰り返し数]と明示的に指定してください。

  do_gqpt コマンドファイル [スレッド数] [繰り返し数]

    コマンドファイルをgroongaサーバで実行します。スレッド数や繰り返し数の意味はdo_localの場合と同じです。
<commit_msg>remove needless ','.<commit_after>.. highlightlang:: none

grntest
=======

名前
----

grntest - groongaテストプログラム

書式
----

::

  grntest  [options...] [script] [db]

説明
----

grntestは、groonga汎用テストツールです。

groongaを単独のプロセスとして利用する場合はもちろん、サーバプログラムとして利用する場合の動作確認や実行速度測定が可能です。

grntest を利用するために必要なデータファイルは、ftp.groonga.orgから必要に応じダウンロードしますので、groonga及びgrntestが動作し、インターネットに接続できる環境であればgroongaコマンドの知識がなくてもgroongaの動作を確認できます。

現在は、linux 及びWindows上で動作します。make installしてもインストールは行われません。

オプション
----------
.. cmdoption:: -i, --host <ip/hostname>

  接続するgroongaサーバを、ipアドレスまたはホスト名で指定します。指定先にgroongaサーバが立ち上がっていない場合、接続不能となることに注意してください。このオプションを指定しない場合、grntestは自動的にlocalhostのgroongaサーバを起動して接続します。


.. cmdoption:: -p, --port <port number>

  自動的に起動するgroongaサーバ、または明示的に指定した接続先のgroonga サーバが利用するポート番号を指定します。接続先のgroongaサーバが利用しているポートと、このオプションで指定したポート番号が異なる場合、接続不能となることに注意してください。


.. cmdoption:: --dir

  ftp.groonga.org に用意されているスクリプトファイルを表示します。

.. cmdoption:: --noftp

  通常grntestはftp.groonga.orgとftp通信を行い、scriptファイルの同期やログファイルの送信を行います。--noftp オプションを指定するとftp 通信を一切行わないようになります。存在しないスクリプトファイルを指定した場合、エラーとなることに注意してください。

.. cmdoption:: --log-output-dir

  デフォルトでは、grntest終了後のログファイルの出力先ははカレントディレクトリです。このオプションを利用すると、任意のディレクトリに出力先を変更することができます。

引数
----

.. cmdoption:: script

  grntestの動作方法(以下、grntest命令と呼びます)を記述したテキストファイルです。拡張子は.scrです。

.. cmdoption:: db

  grntestが利用するgroonga データベースです。指定されたデータベースが存在しない場合、grntestが新規に作成します。またgroonga サーバを自動的に起動する場合もこの引数で指定したデータベースが利用されます。接続するgroonga サーバを明示的に指定した場合に利用するデータベースは、接続先サーバが使用中のデータベースになることに注意してください。


使い方
------
まず、シェル上(Windowsならコマンドプロンプト上)で

   grntest test.scr 任意のDB名

とタイプしてください。もしgrntestが正常に動作すれば、

   test-ユーザ名-数字.log

というファイルが作成されるはずです。作成されない場合、このドキュメントの「トラブルシューティング」の章を参照してください。


スクリプトファイル
------------------

スクリプトファイルは、grntest命令を記述したテキストファイルです。
";"セミコロンを利用して、一行に複数のgrntest命令を記述することができます。一行に複数のgrntest命令がある場合、各命令は並列に実行されます。
"#"で始まる行はコメントとして扱われます。



grntest命令
^^^^^^^^^^^

現在サポートされているgrntest命令は以下の8つです。

  do_local コマンドファイル [スレッド数] [繰り返し数]

    コマンドファイルをgrntest単体で実行します。スレッド数が指定されている場合、複数のスレッドで同じコマンドファイルを同時に実行します。繰り返し数が指定されてい場合、コマンドファイルの内容を繰り返し実行します。スレッド数、繰り返し数とも省略時は1です。1スレッドで複数回動作させたい場合は、do_local コマンドファイル 1 [繰り返し数]と明示的に指定してください。

  do_gqpt コマンドファイル [スレッド数] [繰り返し数]

    コマンドファイルをgroongaサーバで実行します。スレッド数や繰り返し数の意味はdo_localの場合と同じです。

{'fraction_non_alphanumeric': 0.10649177412183193, 'fraction_numerical': 0.0017785682525566918, 'mean_word_length': 7.0339285714285715, 'pattern_counts': {'":': 0, '<': 7, '<?xml version=': 0, '>': 7, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '4978633', 'n_tokens_mistral': 3538, 'n_tokens_neox': 3295, 'n_words': 166}