Skip to content

Commit 0d96dd5

Browse files
committed
Update README
1 parent c473f7e commit 0d96dd5

File tree

1 file changed

+13
-3
lines changed

1 file changed

+13
-3
lines changed

README.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,9 @@ curs.execute("""
7474
for row in curs:
7575
print(row)
7676
```
77+
7778
where,
79+
7880
- `dbName` : the database context that needs to be passed
7981
- `table1` : table under the `dbName` database
8082

@@ -130,7 +132,7 @@ engine = create_engine('pinot://localhost:8099/query/sql?controller=http://local
130132
# or, provide extra argument to connect with multi-stage engine enabled:
131133
# engine = create_engine(
132134
# "pinot://localhost:8000/query/sql?controller=http://localhost:9000/",
133-
# connect_args={"useMultistageEngine": "true"}
135+
# connect_args={"use_multistage_engine": "true"}
134136
# )
135137

136138
places = Table('places', MetaData(bind=engine), autoload=True)
@@ -143,7 +145,15 @@ you may pass them while creating the engine. For example:
143145
```python
144146
engine = create_engine(
145147
"pinot://localhost:8000/query/sql?controller=http://localhost:9000/",
146-
connect_args={"query_options": "useMultistageEngine=true;timeoutMs=10000"})
148+
connect_args={"query_options": "use_multistage_engine=true;timeoutMs=10000"})
149+
```
150+
151+
To support multi-stage engine, you can pass the `use_multistage_engine` parameter in the `connect_args` dictionary.
152+
153+
E.g. In SuperSet Engine Parameters, you can put the following JSON:
154+
155+
```
156+
{"connect_args":{"use_multistage_engine":"true"}}
147157
```
148158

149159
#### Pass the Pinot database context
@@ -158,10 +168,10 @@ The db engine connection string is format as:
158168
```
159169
pinot+http://pinot-broker:8099/query/sql?controller=http://pinot-controller:9000/&database=dbName
160170
```
171+
161172
where `dbName` is the database context that needs to be passed.
162173
If not specified the connection will use the `default` database context while querying.
163174

164-
165175
## Examples with Pinot Quickstart
166176

167177
Start Pinot Batch Quickstart

0 commit comments

Comments
 (0)