Skip to content
This repository was archived by the owner on Jan 22, 2025. It is now read-only.

Commit 1f1ae27

Browse files
committed
add docs
1 parent 7bd2b83 commit 1f1ae27

File tree

1 file changed

+13
-11
lines changed

1 file changed

+13
-11
lines changed

docs/connection.md

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -15,20 +15,22 @@ client = Client(
1515
database="default",
1616
user="user",
1717
port="443",
18+
secure=True,
1819
password="password", settings={"copy_purge": True, "force": True})
1920
```
2021

2122
### Parameter References
2223

23-
| Parameter | Description | Default | example |
24-
|------------------|----------------------------------------------------------------------------------------------------------|-------------|------------------------------------------------|
25-
| user | username | root | |
26-
| password | password | None | | |
27-
| port | server port | None | |
28-
| database | selected database | default |
29-
| secure | Enable SSL | false | http://root@localhost:8000/db?secure=False |
30-
| copy_purge | If True, the command will purge the files in the stage after they are loaded successfully into the table | false | http://root@localhost:8000/db?copy_purge=False |
31-
| debug | Enable debug log | False | http://root@localhost:8000/db?debug=True |
32-
| persist_cookies | if using cookies set by server to perform following requests. | False | http://root@localhost:8000/db?persist_cookies=True|
33-
| null_to_none | if the result data NULL which is of type str, change it to NoneType | False | http://root@localhost:8000/db?null_to_none=True|
24+
| Parameter | Description | Default | example |
25+
|-------------------|----------------------------------------------------------------------------------------------------------|---------|-----------------------------------------------------------|
26+
| user | username | root | |
27+
| password | password | None | | |
28+
| port | server port | None | |
29+
| database | selected database | default |
30+
| secure | Enable SSL | false | http://root@localhost:8000/db?secure=False |
31+
| copy_purge | If True, the command will purge the files in the stage after they are loaded successfully into the table | false | http://root@localhost:8000/db?copy_purge=False |
32+
| debug | Enable debug log | False | http://root@localhost:8000/db?debug=True |
33+
| persist_cookies | if using cookies set by server to perform following requests. | False | http://root@localhost:8000/db?persist_cookies=True |
34+
| null_to_none | if the result data NULL which is of type str, change it to NoneType | False | http://root@localhost:8000/db?null_to_none=True |
35+
| connect_timeout | timeout seconds when connect to databend | 20 | http://root:root@localhost:8000/db?connect_timeout=30 |
3436

0 commit comments

Comments
 (0)