Załącznik A – opcje wywołania xretractor

Program o nazwie xretractor jest podstawowym procesem przetwarzania danych. Możliwe jest wywołanie go bezpośrednio z powłoki. Przygotowany jest do uruchomienia autonomicznego jako proces demona systemd (proces rozwoju w toku).

Program xretractor ma dwa podstawowe tryby pracy. W pierwszym trybie kompiluje wskazany plik z zapytaniami i przechodzi do realizacji planu przetwarzania zapytań. W drugim trybie jedynie kompiluje i udostępnia narzędzia wizualizujące zbudowane plany realizacji zapytań.

Pierwszy tryb osiąga się poprzez wydanie polecenia bez opcji ‘onlycompile’ w drugi tryb wchodzimy dołączając do linii wywołania tą opcję.

Wywołanie listy pomocy z opcją -h przedstawia inną listę dla jednego i drugiego trybu. Należy zwrócić uwagę w którym trybie dana opcja funkcjonuje, gdyż skróty opcji się nakładają.

$ xretractor -h
xretractor - compiler & data processing tool.

Usage: xretractor queryfile [option]

Available options:
  -h [ --help ]               Show program options
  -c [ --onlycompile ]        compile only mode
  -q [ --queryfile ] arg      query set file
  -r [ --quiet ]              no output on screen, skip presenter
  -s [ --status ]             check service status
  -v [ --verbose ]            verbose mode (show stream params)
  -x [ --xqrywait ]           wait with processing for first query
  -k [ --noanykey ]           do not wait for any key to terminate
  -m [ --tlimitqry ] arg (=0) query limit, 0 - no limit
Branch: issue_31-doc:2707ce0, Code compiler: GNU Ver. 13.3.0, Build time: 2512211449, Type: Debug
Log: /tmp/xretractor.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 przedstawia wyjaśnienie poszczególnych opcji.

Opcja	Znaczenie
help	Wyświetlenie tekstu podpowiedzi. Różne dla opcji onlycompile lub bez
onlycompile	Przełączenie narzędzia w tryb ‘tylko kompilacja’. W tym trybie nie jest uruchamiania pętla realizacji zapytań.
queryfile	Nazwa pliku z danymi do kompilacji i uruchomienia
status	Sprawdzenie czy inny proces xretractor nie funkcjonuje lub pozostawił po sobie pliki zabezpieczające wielokrotne uruchomienie.
verbose	Wprowadzenie procesu w tryb zwiększonej komunikatywności. Pozostałość po okresie rozwojowym. Potencjalnie zostanie zachowana.
xqrywait	Wprowadzenie systemu w tryb – skompiluj zapytania i poczekaj na pierwsze zapytanie z procesu xqry w celu uruchomienia pętli realizacji zapytań.
noanykey	Włączenie procesu xretractor w trybie – dowolny klawisz nie przerywa procesu przetwarzania danych. Bez tej opcji dowolny klawisz, przerwie pętlę realizacji zapytań.
tlimitqry	Ograniczenie ilościowe w pętli realizacji zapytań.

Druga lista przedstawia się następująco:

$ xretractor -h -c
xretractor - compiler & data processing tool.

Usage: xretractor -c queryfile [option]

Available options:
  -h [ --help ]          show help options
  -c [ --onlycompile ]   compile only mode
  -q [ --queryfile ] arg query set file
  -r [ --quiet ]         no output on screen, skip presenter
  -d [ --dot ]           create dot output
  -m [ --csv ]           create csv output
  -f [ --fields ]        show fields in dot file
  -t [ --tags ]          show tags in dot file
  -s [ --streamprogs ]   show stream programs in dot file
  -u [ --rules ]         show rules in dot file
  -i [ --hideruleprog ]  hide rule program in rules (-u) output
  -p [ --transparent ]   make dot background transparent
  -w [ --diagram ] arg   create diagram output
Branch: issue_31-doc:2707ce0, Code compiler: GNU Ver. 13.3.0, Build time: 2512211449, Type: Debug
Log: /tmp/xretractor.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.

Tutaj występują opcje związane z tworzeniem diagramów, wykresów lub zrzutów diagnostycznych szeroko wyjaśnianych w tym opracowaniu.

Opcja	Znaczenie
help	Wyświetlenie tekstu podpowiedzi. Różne dla opcji onlycompile lub bez (podobnie jak w poprzedniej wersji)_
onlycompile	Przełączenie narzędzia w tryb ‘tylko kompilacja’. W tym trybie nie jest uruchamiania pętla realizacji zapytań. W tej tabeli przedstawiono opcje dla tej opcji włączonej.
queryfile	Nazwa pliku z danymi do kompilacji.
quiet	W przypadku chęci przetestowania tylko procesu kompilacji, bez potrzeby prezentowania wyników należy użyć opcji quiet – „cisza”. Wewnątrz systemu zamieszczenie tej opcji powoduje, że reszta opcji związanych z prezentacją danych nie jest uruchamiana. Ta opcja została dołączona dla celów rozwojowych.
dot	Proces xretractor w trakcie kompilacji tworzy hierarchiczne struktury danych. W celach prezentacji wytworzonych zależności możemy stworzyć po kompilacji plik tekstowy z którego można zbudować opisy graficzne. Opisy te są przekazywane do narzędzia Dot/Graphivz z którego można zbudować rysunki opisujące wytworzone zależności.
csv	Jeśli chcemy wytworzyć pliki opisujące wytworzone hierarchiczne struktury danych w postaci danych oddzielonych przecinkami. Należy użyć tej opcji.
fields	Dołączenie tej opcji spowoduje umieszczenie pól i ich typów w każdym tworzonym strumieniu danych.
tags	Dołączenie tej opcji spowoduje umieszczenie wytworzonych programów w wewnętrznym języku systemu tworzących pola poszczególnych zapytań. Ta opcja musi zostać wywołana z opcją fields. Gdyż wizualnie zostaną połączone pola z ich programami.
streamprogs	Dołączenie tej opcji spowoduje umieszczenie wytworzonych programów w wewnętrznym języku systemu tworzących strumienie poszczególnych zapytań. Przedstawione zostaną programy dla algebry strumieniowej.
rules	Dołączenie reguł alarmowania do wykresu
hideruleprog	Schowanie programów opisujących warunki alarmowania.
transparent	Wygenerowanie wykresu w wersji przeźroczystej
diagram	Wygenerowanie diagramów kulkowych. Diagramy kulkowe przyjmują argument w postaci typ:ilość_cykli. Typ to 0 lub 1 – określa, czy diagramy prezentują znaczniki czasu, Ilość_cykli – informuje ile cykli zaprezentować na diagramie kulkowym

Na dole linii znajduje się skrócona informacja o sposobie wytworzenia kodu.

Branch: issue_31-doc:2707ce0,
Code compiler: GNU Ver. 13.3.0,
Build time: 2512211449,
Type: Debug

Powyższa linia oznacza, że program został zbudowany na odnodze repozytorium o nazwie issue_31-doc w pozycji oznaczonej kluczem 2707ce0. Skompilowano kod na maszynie wyposażonej w kompilator GCC GNU w wersji 13.3.0, 21 grudnia 2025 o godzinie 14:49. Kod skompilowano w trybie Debug.

Linia poniżej informuje, gdzie szukać logów uruchomienia – w tym przypadku plik tekstowy /log/xretractor.log przechowuje historię wywołania i procesów zachodzących wewnątrz systemu. Trzeba go sprzątać regularnie. W trakcie rozwoju oprogramowania pozwalam na jego ciągły wzrost.

Ostatnia linii to informacja o zastosowanej licencji dla tego kodu. Licencja MIT jest licencją umożliwiającą bezpieczne użycie kodu w zastosowaniach korporacyjnych.