docs: add missing account_name (#336)

firebolt-db · Jan 9, 2024 · 87e8378 · 87e8378
1 parent 897f1e8
commit 87e8378
Showing 1 changed file with 11 additions and 1 deletion.
diff --git a/docsrc/Connecting_and_queries.rst b/docsrc/Connecting_and_queries.rst
@@ -70,10 +70,12 @@ To get started, follow the steps below:
                 secret = "your_service_account_secret"
                 engine_name = "your_engine"
                 database_name = "your_database"
+                account_name = "your_account"
 
                 with connect(
                         engine_name=engine_name,
                         database=database_name,
+                        account_name=account_name,
                         auth=ClientCredentials(id, secret),
                 ) as connection:
                     cursor = connection.cursor()
@@ -91,6 +93,7 @@ To get started, follow the steps below:
                 FIREBOLT_CLIENT_SECRET="your_service_account_secret"
                 FIREBOLT_ENGINE="your_engine"
                 FIREBOLT_DB="your_database"
+                FIREBOLT_ACCOUNT="your_account"
 
             Be sure to place this ``.env`` file into your root directory.
 
@@ -112,7 +115,8 @@ To get started, follow the steps below:
                         os.getenv("FIREBOLT_CLIENT_SECRET")
                     )
                     engine_name=os.getenv('FIREBOLT_ENGINE'),
-                    database=os.getenv('FIREBOLT_DB')
+                    database=os.getenv('FIREBOLT_DB'),
+                    account_name=os.getenv('FIREBOLT_ACCOUNT'),
                 ) as connection:
                     cursor = connection.cursor()
 
@@ -395,12 +399,14 @@ It can be extended to run alongside of other operations.
         secret = "your_service_account_secret"
         engine_name = "your_engine"
         database_name = "your_database"
+        account_name = "your_account"
 
         query = "select * from my_table"
 
         async with await async_connect(
             engine_name=engine_name,
             database=database_name,
+            account_name=account_name,
             auth=ClientCredentials(id, secret),
         ) as connection:
             cursor = connection.cursor()
@@ -445,6 +451,7 @@ at the same time.
         secret = "your_service_account_secret"
         engine_name = "your_engine"
         database_name = "your_database"
+        account_name = "your_account"
 
         queries = [
             "select * from table_1",
@@ -455,6 +462,7 @@ at the same time.
         async with await async_connect(
             engine_name=engine_name,
             database=database_name,
+            account_name=account_name,
             auth=ClientCredentials(id, secret),
         ) as connection:
             # Create async tasks for every query
@@ -520,6 +528,7 @@ load on both server and client machines can be controlled. A suggested way is to
         secret = "your_service_account_secret"
         engine_name = "your_engine"
         database_name = "your_database"
+        account_name = "your_account"
 
         queries = [
             "select * from table_1",
@@ -530,6 +539,7 @@ load on both server and client machines can be controlled. A suggested way is to
         async with await async_connect(
             engine_name=engine_name,
             database=database_name,
+            account_name=account_name,
             auth=ClientCredentials(id, secret),
         ) as connection:
             # Create async tasks for every query