Załącznik B - opcje wywołania xqry

Program xqry jest integralną częścią systemu. Dzieli z systemem xretractor wspólny obszar w pamięci używany do komunikacji. Narzędzie xqry służy do komunikacji z procesem przetwarzania planów realizacji zapytań i odbierania danych z pętli zapytań.

Po wywołaniu programu za pomocą polecenia -h przedstawi się nam następujący obraz:

$ xqry -h
xqry - data query tool.

Usage: xqry [option]

Allowed options:
  -s [ --select ] arg         show this stream
  -t [ --detail ] arg         show details of this stream
  -a [ --adhoc ] arg          adhoc query mode
  -m [ --tlimitqry ] arg (=0) limit of elements, 0 - no limit
  -l [ --hello ]              diagnostic - hello db world
  -k [ --kill ]               kill xretractor server
  -d [ --dir ]                list of queries
  -y [ --diryaml ]            list of queries in yaml format
  -r [ --raw ]                raw output mode (default)
  -g [ --graphite ]           graphite output mode
  -f [ --influxdb ]           influxDB output mode
  -p [ --gnuplot ] arg        x,y - gnuplot output mode
  -h [ --help ]               produce help message
  -c [ --needctrlc ]          force ctl+c for stop this tool
Branch: issue_31-doc:2707ce0, Code compiler: GNU Ver. 13.3.0, Build time: 2512211449, Type: Debug
Log: /tmp/xqry.log
This software is licensed under the MIT License and is provided ‘as is’,
without warranty of any kind. For more information, see the LICENSE file.

Poniższa tabela przestawia opisz poszczególnych opcji.

Opcja	Znaczenie
select	Odebrania danych z danego strumienia udostępnianego przez proces xretractor
detail	Przedstawienie szczegółów na temat danego strumienia danych. Przykładowa odpowiedź: --- apiVersion: xqry/v1 stream: name: str4 delta: 1 query: SELECT (str4[0]+1)*2 STREAM str4 FROM core0>1 fields: str4.str4_0: type: INTEGER
adhoc	Dołączenie zapytania do systemu w biegu
tlimitqry	Ograniczenie ilościowe odbieranych od systemu rezultatów. Bardzo potrzebna funkcjonalność w złączeniu z opcją -k do celów testowych
hello	Weryfikacja funkcji kanału komunikacyjnego z systemem
kill	Żądanie zatrzymania działania procesu xretractor
dir	Wylistowanie wszystkich zapytań realizowanych w procesie realizacji zapytań przez system xretractor w formie tekstowej
diryaml	Wylistowanie wszystkich zapytań realizowanych w procesie realizacji zapytań przez system xretractor w formacie yaml
raw	Tryb tekstowy odpowiedzi systemu. Dane prezentowane są bez zbędnych dekoracji
graphite	Tryb odpowiedzi przygotowujący dane dla systemu graphite
influxdb	Tryb odpowiedzi przygotowujący dane dla systemu influxdb
gnuplot	Przygotowanie agregatów dla bezpośredniego wywoływania strumienia danych dla programu gnuplot
help	Wyświetlenie tekstu pomocy
needctrlc	W normlanym trybie pracy – dowolny klawisz zatrzyma proces odbioru danych. W tym trybie, konieczne jest użycie ctrl+c

Informacje poniżej listy dostępnych opcji narzędzia są identyczne z tymi opisywanymi w poprzednim załączniku dla narzędzia xretractor.