docs: extract concrect writers info into dedicated sections

Author: AndreyMarkinPPC

docs/usage/bq-writer.md

@@ -0,0 +1,134 @@
+!!! important
+    To save data to BigQuery install `garf-io` with BigQuery support
+
+    ```bash
+    pip install garf-io[bq]
+    ```
+
+
+`bq` writer allows you to save `GarfReport` to BigQuery table.
+
+/// tab | cli
+```bash
+garf query.sql --source API_SOURCE \
+  --output bq
+```
+///
+
+/// tab | python
+```python
+from garf_core import report
+from garf_io.writers import bigquery_writer
+
+# Create example report
+sample_report = report.GarfReport(results=[[1]], column_names=['one'])
+
+writer = bigquery_writer.BigQueryWriter()
+writer.write(sample_report, 'query')
+```
+///
+
+## Parameters
+### Project
+
+By default reports are saved to `GOOGLE_CLOUD_PROJECT`.
+You can overwrite it with `project` parameter.
+
+/// tab | cli
+```bash hl_lines="3"
+garf query.sql --source API_SOURCE \
+  --output bq \
+  --bq.project=PROJECT_ID
+```
+///
+
+/// tab | python
+```python hl_lines="7"
+from garf_core import report
+from garf_io.writers import bigquery_writer
+
+# Create example report
+sample_report = report.GarfReport(results=[[1]], column_names=['one'])
+
+writer = bigquery_writer.BigQueryWriter(project="PROJECT_ID")
+writer.write(sample_report, 'query')
+```
+///
+
+### Dataset
+
+By default reports are saved to `garf` dataset.
+You can overwrite it with `dataset` parameter.
+
+/// tab | cli
+```bash hl_lines="3"
+garf query.sql --source API_SOURCE \
+  --output bq \
+  --bq.dataset=DATASET
+```
+///
+
+/// tab | python
+```python hl_lines="7"
+from garf_core import report
+from garf_io.writers import bigquery_writer
+
+# Create example report
+sample_report = report.GarfReport(results=[[1]], column_names=['one'])
+
+writer = bigquery_writer.BigQueryWriter(dataset="DATASET")
+writer.write(sample_report, 'query')
+```
+///
+
+### Location
+
+By default reports are saved to `US` location.
+You can overwrite it with `location` parameter.
+
+/// tab | cli
+```bash hl_lines="3"
+garf query.sql --source API_SOURCE \
+  --output bq \
+  --bq.location=LOCATION
+```
+///
+
+/// tab | python
+```python hl_lines="7"
+from garf_core import report
+from garf_io.writers import bigquery_writer
+
+# Create example report
+sample_report = report.GarfReport(results=[[1]], column_names=['one'])
+
+writer = bigquery_writer.BigQueryWriter(location="LOCATION")
+writer.write(sample_report, 'query')
+```
+///
+
+### Write disposition
+
+By default reports overwrite any existing data.
+You can overwrite it with [`write_disposition`](https://cloud.google.com/bigquery/docs/reference/auditlogs/rest/Shared.Types/BigQueryAuditMetadata.WriteDisposition) parameter.
+
+/// tab | cli
+```bash hl_lines="3"
+garf query.sql --source API_SOURCE \
+  --output bq \
+  --bq.write_disposition=DISPOSITION
+```
+///
+
+/// tab | python
+```python hl_lines="7"
+from garf_core import report
+from garf_io.writers import bigquery_writer
+
+# Create example report
+sample_report = report.GarfReport(results=[[1]], column_names=['one'])
+
+writer = bigquery_writer.BigQueryWriter(write_disposition="DISPOSITION")
+writer.write(sample_report, 'query')
+```
+///

docs/usage/console-writer.md

@@ -0,0 +1,78 @@
+`console` writer allows you to print `GarfReport` to standard output in the terminal.
+
+/// tab | cli
+```bash
+garf query.sql --source API_SOURCE \
+  --output console
+```
+///
+
+/// tab | python
+```python
+from garf_core import report
+from garf_io.writers import console_writer
+
+# Create example report
+sample_report = report.GarfReport(results=[[1]], column_names=['one'])
+
+writer = console_writer.ConsoleWriter()
+writer.write(sample_report, 'query')
+```
+///
+
+##Parameters
+
+### Format
+
+For `console` writer you can specify the output format:
+
+* `table` - rich table (default).
+* `json` - JSON.
+* `jsonl` - JSON lines
+
+/// tab | cli
+```bash hl_lines="3"
+garf query.sql --source API_SOURCE \
+  --output console \
+  --console.format=json
+```
+///
+
+/// tab | python
+```python hl_lines="7"
+from garf_core import report
+from garf_io.writers import console_writer
+
+# Create example report
+sample_report = report.GarfReport(results=[[1]], column_names=['one'])
+
+writer = console_writer.ConsoleWriter(format='json')
+writer.write(sample_report, 'query')
+```
+///
+
+### Page size
+
+If you're using `console` writer with `table` format option, you can specify
+`page_size` parameter to print N rows to the console.
+
+/// tab | cli
+```bash hl_lines="3"
+garf query.sql --source API_SOURCE \
+  --output console \
+  --console.page-size=100
+```
+///
+
+/// tab | python
+```python hl_lines="7"
+from garf_core import report
+from garf_io.writers import console_writer
+
+# Create example report
+sample_report = report.GarfReport(results=[[1]], column_names=['one'])
+
+writer = console_writer.ConsoleWriter(page_size=100)
+writer.write(sample_report, 'query')
+```
+///

docs/usage/csv-writer.md

@@ -0,0 +1,51 @@
+`csv` writer allows you to save `GarfReport` as a CSV file to local or remote storage.
+
+/// tab | cli
+```bash
+garf query.sql --source API_SOURCE \
+  --output csv
+```
+///
+
+/// tab | python
+```python
+from garf_core import report
+from garf_io.writers import csv_writer
+
+# Create example report
+sample_report = report.GarfReport(results=[[1]], column_names=['one'])
+
+writer = csv_writer.CsvWriter()
+writer.write(sample_report, 'query')
+```
+///
+
+## Parameters
+
+### Destination folder
+
+For `csv` writer you can specify the local or remote folder to store results.
+I.e. if you want to write results to Google Cloud Storage bucket `gs://PROJECT_ID/bucket`,
+you need to provide `destination_folder` parameter.
+
+
+/// tab | cli
+```bash hl_lines="3"
+garf query.sql --source API_SOURCE \
+  --output csv \
+  --csv.destination-folder=gs://PROJECT_ID/bucket
+```
+///
+
+/// tab | python
+```python
+from garf_core import report
+from garf_io.writers import csv_writer
+
+# Create example report
+sample_report = report.GarfReport(results=[[1]], column_names=['one'])
+
+writer = csv_writer.CsvWriter(destination_folder='gs://PROJECT_ID/bucket/')
+writer.write(sample_report, 'query')
+```
+///

docs/usage/json-writer.md

@@ -0,0 +1,79 @@
+`json` writer allows you to save `GarfReport` as JSON or JSONL file to local or remote storage.
+
+/// tab | cli
+```bash
+garf query.sql --source API_SOURCE \
+  --output json
+```
+///
+
+/// tab | python
+```python
+from garf_core import report
+from garf_io.writers import json_writer
+
+# Create example report
+sample_report = report.GarfReport(results=[[1]], column_names=['one'])
+
+writer = json_writer.JsonWriter()
+writer.write(sample_report, 'query')
+```
+///
+
+## Parameters
+
+### Destination folder
+
+You can specify the local or remote folder to store results.
+I.e. if you want to write results to Google Cloud Storage bucket `gs://PROJECT_ID/bucket`,
+you need to provide `destination_folder` parameter.
+
+
+/// tab | cli
+```bash hl_lines="3"
+garf query.sql --source API_SOURCE \
+  --output json \
+  --json.destination-folder=gs://PROJECT_ID/bucket
+```
+///
+
+/// tab | python
+```python
+from garf_core import report
+from garf_io.writers import json_writer
+
+# Create example report
+sample_report = report.GarfReport(results=[[1]], column_names=['one'])
+
+writer = json_writer.JsonWriter(destination_folder='gs://PROJECT_ID/bucket/')
+writer.write(sample_report, 'query')
+```
+///
+
+### Format
+
+You can specify the output format:
+
+* `json` - JSON (default)
+* `jsonl` - JSON lines
+
+/// tab | cli
+```bash hl_lines="3"
+garf query.sql --source API_SOURCE \
+  --output json \
+  --json.format=jsonl
+```
+///
+
+/// tab | python
+```python hl_lines="7"
+from garf_core import report
+from garf_io.writers import json_writer
+
+# Create example report
+sample_report = report.GarfReport(results=[[1]], column_names=['one'])
+
+writer = json_writer.JsonWriter(format='jsonl')
+writer.write(sample_report, 'query')
+```
+///

docs/usage/sheets-writer.md

@@ -0,0 +1,29 @@
+!!! important
+    To save data to Google Sheets install `garf-io` with Google Sheets support
+
+    ```bash
+    pip install garf-io[sheets]
+    ```
+
+
+`sheets` writer allows you to save `GarfReport` to Google Sheets.
+
+/// tab | cli
+```bash
+garf query.sql --source API_SOURCE \
+  --output sheets
+```
+///
+
+/// tab | python
+```python
+from garf_core import report
+from garf_io.writers import sheets_writer
+
+# Create example report
+sample_report = report.GarfReport(results=[[1]], column_names=['one'])
+
+writer = sheets_writer.SheetsWriter()
+writer.write(sample_report, 'query')
+```
+///