README.org
October 19, 2018 ยท View on GitHub
-
csvq emacs extension
This package is an emacs extension for [[https://github.com/mithrandie/csvq][csvq (https://github.com/mithrandie/csvq)]]
-
Variables
- csvq-log-buffer :: Buffer name to write logs or csvq execution.
- csvq-default-format :: Default format for the csvq-insert function.
- Functions
-
csvq :: Execute csvq and write the results to the csvq-log-buffer.
-
csvq-ops :: Execute csvq with specific options and write the results to the csvq-log-buffer.
-
csvq-insert :: Execute csvq and insert the results to the current buffer.
-
csvq-insert-ops :: Execute csvq with specific options and insert the results to the current buffer.
-
csvq-create :: Execute csvq and insert the results to the specified buffer.
-
csvq-create-ops :: Execute csvq with specific options and insert the results to the specified buffer.
-
csvq-org :: Execute csvq to the current Org-mode table and write the results to the csvq-log-buffer.
-
csvq-org-ops :: Execute csvq with specific options to the current Org-mode table and write the results to the csvq-log-buffer.
-
csvq-org-create :: Execute csvq to the current Org-mode table and insert the results to the specified buffer.
-
csvq-org-create-ops :: Execute csvq with specific options to the current Org-mode table and insert the results to the specified buffer.
-
csvq-org-replace :: Execute csvq to the current Org-mode table and replace the table with the results.
-
csvq-org-update :: Execute csvq to the current Org-mode table and replace the table with the auto-selected result.
-
csvq-calc :: Execute calc subcommand of csvq. A string of current active region is used as a value to be calculated.
- Query and Options
** Query
If an active resion exists, then the string in the region is used as a query to execute. Otherwise you can input a query in the emacs mini buffer after calling a function.
You can also use the [[https://mithrandie.github.io/csvq/reference/built-in.html#source][SOURCE statement]] in a query to execute a query or statements written in a file.
** Options
You can specify [[https://mithrandie.github.io/csvq/reference/command.html#options][csvq command options]] with the functions named "*-ops".
Some command options can also be specified in a query by using [[https://mithrandie.github.io/csvq/reference/flag.html][SET FLAG statement]].
- Org-mode Tables
In a csvq execution called by csvq-org-* functions, the data of the org-mode table is stored in a temporary table named as "STDIN". You can manipulate the data by executing queries to the STDIN table.