Skip to content

Commit c14bf8b

Browse files
committed
add token to readme
1 parent 68d381a commit c14bf8b

1 file changed

Lines changed: 26 additions & 6 deletions

File tree

README.md

Lines changed: 26 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,9 @@ conda install -c defusco intake-metabase
1515
To access a catalog of tables in Metabase you will need the following information
1616

1717
* `domain`: The URL where Metabase is running
18-
* `username`: Your username, typically an email address
19-
* `password`: Your password (Google Auth is not yet supported)
18+
* `username`: Your username, typically an email address [Optional]
19+
* `password`: Your password (Google Auth is not yet supported) [Optional]
20+
* `token`: Your session token (this will take precedence over username/password) [Optional]
2021

2122
To load the catalog and list the tables
2223

@@ -46,10 +47,11 @@ This driver supports multiple databases and saved questions.
4647
To load a table as a Pandas DataFrames you will need to know the following information
4748

4849
* `domain`: The URL where Metabase is running
49-
* `username`: Your username, typically an email address
50-
* `password`: Your password (Google Auth is not yet supported)
5150
* `database`: The numeric id of the database where the table is stored
5251
* `table`: The numeric id of the table to load
52+
* `username`: Your username, typically an email address [Optional]
53+
* `password`: Your password (Google Auth is not yet supported) [Optional]
54+
* `token`: Your session token (this will take precedence over username/password) [Optional]
5355

5456
You can generally determine the numeric ids of the database and table from the URL when you are viewing the table in your browser. Here are the steps.
5557

@@ -73,9 +75,10 @@ df = ds.read()
7375
To load a table as a Pandas DataFrames you will need to know the following information
7476

7577
* `domain`: The URL where Metabase is running
76-
* `username`: Your username, typically an email address
77-
* `password`: Your password (Google Auth is not yet supported)
7878
* `question`: The numeric id of the question
79+
* `username`: Your username, typically an email address [Optional]
80+
* `password`: Your password (Google Auth is not yet supported) [Optional]
81+
* `token`: Your session token (this will take precedence over username/password) [Optional]
7982

8083
You can generally determine the numeric id of the question you are interested in by
8184

@@ -118,3 +121,20 @@ sources:
118121
database: 2
119122
table: 6
120123
```
124+
125+
or by using a session token
126+
127+
```yaml
128+
metadata:
129+
version: 1
130+
131+
sources:
132+
my_table:
133+
description: My table
134+
driver: metabase_table
135+
args:
136+
domain: <domain>
137+
token: 'env("METABASE_TOKEN")'
138+
database: 2
139+
table: 6
140+
```

0 commit comments

Comments
 (0)