fix: Use correct write_options parameter in examples (#87)

powersj · web-flow · commit 6cf2b3e9afb7 · 2024-05-03T08:57:41.000+02:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,12 @@
+<!-- markdownlint-disable MD024 -->
+# Change Log
+
 ## 0.5.0 [unreleased]
 
+### Bugfix
+
+- [#87](https://github.com/InfluxCommunity/influxdb3-python/pull/87): Fix examples to use `write_options` instead of the object name `WriteOptions`
+
 ### Others
 
 - [#84](https://github.com/InfluxCommunity/influxdb3-python/pull/84): Enable packaging type information - `py.typed`
diff --git a/Examples/batching_example.py b/Examples/batching_example.py
@@ -49,7 +49,7 @@ def retry(self, conf, data: str, exception: InfluxDBError):
 wco = write_client_options(success_callback=callback.success,
                            error_callback=callback.error,
                            retry_callback=callback.retry,
-                           WriteOptions=write_options
+                           write_options=write_options
                            )
 # Opening InfluxDB client with a batch size of 5k points or flush interval
 # of 10k ms and gzip compression
diff --git a/Examples/community/custom_url.py b/Examples/community/custom_url.py
@@ -30,7 +30,7 @@ def retry(self, conf, data: str, exception: InfluxDBError):
 wco = write_client_options(success_callback=callback.success,
                            error_callback=callback.error,
                            retry_callback=callback.retry,
-                           WriteOptions=write_options
+                           write_options=write_options
                            )
 
 client = InfluxDBClient3(
diff --git a/Examples/community/database_transfer.py b/Examples/community/database_transfer.py
@@ -38,7 +38,7 @@ def retry(self, conf, data: str, exception: InfluxDBError):
 wco = write_client_options(success_callback=callback.success,
                            error_callback=callback.error,
                            retry_callback=callback.retry,
-                           WriteOptions=write_options
+                           write_options=write_options
                            )
 # Opening InfluxDB client with a batch size of 5k points or flush interval
 # of 10k ms and gzip compression
diff --git a/Examples/file-import/csv_write.py b/Examples/file-import/csv_write.py
@@ -27,7 +27,7 @@ def retry(self, conf, data: str, exception: InfluxDBError):
 wco = write_client_options(success_callback=callback.success,
                            error_callback=callback.error,
                            retry_callback=callback.retry,
-                           WriteOptions=write_options
+                           write_options=write_options
                            )
 
 with InfluxDBClient3.InfluxDBClient3(
diff --git a/Examples/file-import/feather_write.py b/Examples/file-import/feather_write.py
@@ -27,7 +27,7 @@ def retry(self, conf, data: str, exception: InfluxDBError):
 wco = write_client_options(success_callback=callback.success,
                            error_callback=callback.error,
                            retry_callback=callback.retry,
-                           WriteOptions=write_options
+                           write_options=write_options
                            )
 
 with InfluxDBClient3.InfluxDBClient3(
diff --git a/Examples/file-import/json_write.py b/Examples/file-import/json_write.py
@@ -27,7 +27,7 @@ def retry(self, conf, data: str, exception: InfluxDBError):
 wco = write_client_options(success_callback=callback.success,
                            error_callback=callback.error,
                            retry_callback=callback.retry,
-                           WriteOptions=write_options
+                           write_options=write_options
                            )
 
 with InfluxDBClient3.InfluxDBClient3(
diff --git a/Examples/file-import/orc_write.py b/Examples/file-import/orc_write.py
@@ -27,7 +27,7 @@ def retry(self, conf, data: str, exception: InfluxDBError):
 wco = write_client_options(success_callback=callback.success,
                            error_callback=callback.error,
                            retry_callback=callback.retry,
-                           WriteOptions=write_options
+                           write_options=write_options
                            )
 
 with InfluxDBClient3.InfluxDBClient3(
diff --git a/Examples/file-import/parquet_write.py b/Examples/file-import/parquet_write.py
@@ -27,7 +27,7 @@ def retry(self, conf, data: str, exception: InfluxDBError):
 wco = write_client_options(success_callback=callback.success,
                            error_callback=callback.error,
                            retry_callback=callback.retry,
-                           WriteOptions=write_options
+                           write_options=write_options
                            )
 
 with InfluxDBClient3.InfluxDBClient3(
diff --git a/Examples/file-import/write_file_parse_options.py b/Examples/file-import/write_file_parse_options.py
@@ -27,7 +27,7 @@ def retry(self, conf, data: str, exception: InfluxDBError):
 wco = write_client_options(success_callback=callback.success,
                            error_callback=callback.error,
                            retry_callback=callback.retry,
-                           WriteOptions=write_options
+                           write_options=write_options
                            )
 
 with InfluxDBClient3.InfluxDBClient3(
diff --git a/Examples/pokemon-trainer/cookbook.ipynb b/Examples/pokemon-trainer/cookbook.ipynb
@@ -19,7 +19,7 @@
    "outputs": [],
    "source": [
     "\n",
-    "# Here we include all the imports required from influxdb_client_3 \n",
+    "# Here we include all the imports required from influxdb_client_3\n",
     "from influxdb_client_3 import InfluxDBClient3, InfluxDBError, WriteOptions, write_client_options\n",
     "import pandas as pd\n",
     "import random"
@@ -75,7 +75,7 @@
     "wco = write_client_options(success_callback=callback.success,\n",
     "                          error_callback=callback.error,\n",
     "                          retry_callback=callback.retry,\n",
-    "                          WriteOptions=write_options \n",
+    "                          write_options=write_options\n",
     "                        )"
    ]
   },
@@ -655,7 +655,7 @@
     "query = '''SHOW COLUMNS FROM caught'''\n",
     "\n",
     "# We can use the query method to run a query against the database.\n",
-    "# Under the hood this creates a flight ticket and uses the FlightClient to run the query. \n",
+    "# Under the hood this creates a flight ticket and uses the FlightClient to run the query.\n",
     "# For this example we are using the pandas mode, which will return a pandas DataFrame.\n",
     "# Language also allows us to specify the query language, in this case we are using SQL.\n",
     "table = client.query(query=query, language='sql', mode='pandas')\n",
@@ -1702,7 +1702,7 @@
     "query = '''SELECT count(\"name\") FROM caught WHERE time > now() - 1h GROUP BY trainer'''\n",
     "\n",
     "# We can use the query method to run a query against the database.\n",
-    "# Under the hood this creates a flight ticket and uses the FlightClient to run the query. \n",
+    "# Under the hood this creates a flight ticket and uses the FlightClient to run the query.\n",
     "# For this example we are using the pandas mode, which will return a pandas DataFrame.\n",
     "# Language also allows us to specify the query language, in this case we are using SQL.\n",
     "table = client.query(query=query, language='influxql', mode='pandas')\n",
@@ -3104,7 +3104,7 @@
     "query = '''SELECT count(\"name\") FROM caught WHERE time > now() - 1h GROUP BY trainer,type1'''\n",
     "\n",
     "# We can use the query method to run a query against the database.\n",
-    "# Under the hood this creates a flight ticket and uses the FlightClient to run the query. \n",
+    "# Under the hood this creates a flight ticket and uses the FlightClient to run the query.\n",
     "# For this example we are using the pandas mode, which will return a pandas DataFrame.\n",
     "# Language also allows us to specify the query language, in this case we are using SQL.\n",
     "table = client.query(query=query, language='influxql' , mode='pandas')\n",
diff --git a/Examples/pokemon-trainer/write-batching-flight-calloptions.py b/Examples/pokemon-trainer/write-batching-flight-calloptions.py
@@ -33,7 +33,7 @@ def retry(self, conf, data: str, exception: InfluxDBError):
 wco = write_client_options(success_callback=callback.success,
                            error_callback=callback.error,
                            retry_callback=callback.retry,
-                           WriteOptions=write_options
+                           write_options=write_options
                            )
 
 client = InfluxDBClient3(
diff --git a/Examples/pokemon-trainer/write-batching.py b/Examples/pokemon-trainer/write-batching.py
@@ -30,7 +30,7 @@ def retry(self, conf, data: str, exception: InfluxDBError):
 wco = write_client_options(success_callback=callback.success,
                            error_callback=callback.error,
                            retry_callback=callback.retry,
-                           WriteOptions=write_options
+                           write_options=write_options
                            )
 
 client = InfluxDBClient3(
diff --git a/README.md b/README.md
@@ -32,7 +32,7 @@
 
 - `pyarrow` (automatically installed)
 - `pandas` (optional)
-  
+
 
 ## Installation
 
@@ -113,7 +113,7 @@ write_options = WriteOptions(batch_size=500,
 wco = write_client_options(success_callback=callback.success,
                           error_callback=callback.error,
                           retry_callback=callback.retry,
-                          WriteOptions=write_options 
+                          write_options=write_options
                         )
 
 with  InfluxDBClient3.InfluxDBClient3(
@@ -126,11 +126,11 @@ with  InfluxDBClient3.InfluxDBClient3(
     client.write_file(
         file='./out.csv',
         timestamp_column='time', tag_columns=["provider", "machineID"])
-    
+
     client.write_file(
         file='./out.json',
         timestamp_column='time', tag_columns=["provider", "machineID"], date_unit='ns' )
-    
+
 
 ```
 
@@ -144,7 +144,7 @@ client._write_api.write(bucket="pokemon-codex", record=pd_df, data_frame_measure
 client._write_api.write(bucket="pokemon-codex", record=pl_df, data_frame_measurement_name='caught', data_frame_tag_columns=['trainer', 'id', 'num'], data_frame_timestamp_column='timestamp')
 ```
 
-## Querying 
+## Querying
 
 ### Querying with SQL
 ```python
@@ -196,4 +196,4 @@ table = client.query(
 
 print(table.to_pandas())
 ```
-You may also include your own root certificate via this manor aswell. 
+You may also include your own root certificate via this manor aswell.

Original file line number	Diff line number	Diff line change
`@@ -49,7 +49,7 @@ def retry(self, conf, data: str, exception: InfluxDBError):`
`49`	`49`	`wco = write_client_options(success_callback=callback.success,`
`50`	`50`	`error_callback=callback.error,`
`51`	`51`	`retry_callback=callback.retry,`
`52`		`- WriteOptions=write_options`
	`52`	`+ write_options=write_options`
`53`	`53`	`)`
`54`	`54`	`# Opening InfluxDB client with a batch size of 5k points or flush interval`
`55`	`55`	`# of 10k ms and gzip compression`
Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@ def retry(self, conf, data: str, exception: InfluxDBError):`
`30`	`30`	`wco = write_client_options(success_callback=callback.success,`
`31`	`31`	`error_callback=callback.error,`
`32`	`32`	`retry_callback=callback.retry,`
`33`		`- WriteOptions=write_options`
	`33`	`+ write_options=write_options`
`34`	`34`	`)`
`35`	`35`
`36`	`36`	`client = InfluxDBClient3(`
Original file line number	Diff line number	Diff line change
`@@ -38,7 +38,7 @@ def retry(self, conf, data: str, exception: InfluxDBError):`
`38`	`38`	`wco = write_client_options(success_callback=callback.success,`
`39`	`39`	`error_callback=callback.error,`
`40`	`40`	`retry_callback=callback.retry,`
`41`		`- WriteOptions=write_options`
	`41`	`+ write_options=write_options`
`42`	`42`	`)`
`43`	`43`	`# Opening InfluxDB client with a batch size of 5k points or flush interval`
`44`	`44`	`# of 10k ms and gzip compression`
Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@ def retry(self, conf, data: str, exception: InfluxDBError):`
`27`	`27`	`wco = write_client_options(success_callback=callback.success,`
`28`	`28`	`error_callback=callback.error,`
`29`	`29`	`retry_callback=callback.retry,`
`30`		`- WriteOptions=write_options`
	`30`	`+ write_options=write_options`
`31`	`31`	`)`
`32`	`32`
`33`	`33`	`with InfluxDBClient3.InfluxDBClient3(`