Skip to content

Commit d684bf8

Browse files
author
Jesse
authored
Update example in docstring so query output is valid Spark SQL (#95)
Signed-off-by: Jesse Whitehouse <[email protected]>
1 parent d4d7cca commit d684bf8

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

src/databricks/sql/client.py

+3-3
Original file line numberDiff line numberDiff line change
@@ -457,9 +457,9 @@ def execute(
457457
Execute a query and wait for execution to complete.
458458
Parameters should be given in extended param format style: %(...)<s|d|f>.
459459
For example:
460-
operation = "SELECT * FROM %(table_name)s"
461-
parameters = {"table_name": "my_table_name"}
462-
Will result in the query "SELECT * FROM 'my_table_name' being sent to the server
460+
operation = "SELECT * FROM table WHERE field = %(some_value)s"
461+
parameters = {"some_value": "foo"}
462+
Will result in the query "SELECT * FROM table WHERE field = 'foo' being sent to the server
463463
:returns self
464464
"""
465465
if parameters is not None:

0 commit comments

Comments
 (0)