Skip to content

Commit 77ceda6

Browse files
actions-useractions-user
committed
Update documentation
1 parent ff108c8 commit 77ceda6

11 files changed

Lines changed: 242 additions & 141 deletions

File tree

‎how-to/configure-database/index.html‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2275,6 +2275,17 @@
22752275
</span>
22762276
</a>
22772277

2278+
</li>
2279+
2280+
<li class="md-nav__item">
2281+
<a href="#database-name" class="md-nav__link">
2282+
<span class="md-ellipsis">
2283+
2284+
Database Name
2285+
2286+
</span>
2287+
</a>
2288+
22782289
</li>
22792290

22802291
<li class="md-nav__item">
@@ -5900,6 +5911,17 @@
59005911
</span>
59015912
</a>
59025913

5914+
</li>
5915+
5916+
<li class="md-nav__item">
5917+
<a href="#database-name" class="md-nav__link">
5918+
<span class="md-ellipsis">
5919+
5920+
Database Name
5921+
5922+
</span>
5923+
</a>
5924+
59035925
</li>
59045926

59055927
<li class="md-nav__item">
@@ -6113,6 +6135,12 @@ <h2 id="configuration-settings">Configuration Settings<a class="headerlink" href
61136135
<td>Database backend: <code>mysql</code> or <code>postgresql</code></td>
61146136
</tr>
61156137
<tr>
6138+
<td><code>database.name</code></td>
6139+
<td><code>DJ_DATABASE_NAME</code></td>
6140+
<td><code>None</code></td>
6141+
<td>Database name (PostgreSQL only). Defaults to <code>"postgres"</code></td>
6142+
</tr>
6143+
<tr>
61166144
<td><code>database.use_tls</code></td>
61176145
<td><code>DJ_TLS</code></td>
61186146
<td><code>True</code></td>
@@ -6185,17 +6213,40 @@ <h3 id="configuration-file">Configuration File<a class="headerlink" href="#confi
61856213
<span class="p">}</span>
61866214
</code></pre></div>
61876215
<p>The port defaults to <code>5432</code> when <code>backend</code> is set to <code>postgresql</code>.</p>
6216+
<h3 id="database-name">Database Name<a class="headerlink" href="#database-name" title="Permanent link">&para;</a></h3>
6217+
<div class="admonition version-added">
6218+
<p class="admonition-title">New in 2.2.1</p>
6219+
<p>The <code>database.name</code> setting specifies which PostgreSQL database to connect to.</p>
6220+
</div>
6221+
<p>PostgreSQL requires connecting to a specific database. By default, DataJoint connects to the <code>postgres</code> database. To use a different database:</p>
6222+
<div class="highlight"><pre><span></span><code><span class="p">{</span>
6223+
<span class="w"> </span><span class="nt">&quot;database&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
6224+
<span class="w"> </span><span class="nt">&quot;host&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;localhost&quot;</span><span class="p">,</span>
6225+
<span class="w"> </span><span class="nt">&quot;backend&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;postgresql&quot;</span><span class="p">,</span>
6226+
<span class="w"> </span><span class="nt">&quot;name&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;my_database&quot;</span>
6227+
<span class="w"> </span><span class="p">}</span>
6228+
<span class="p">}</span>
6229+
</code></pre></div>
6230+
<p>Or via environment variable:</p>
6231+
<div class="highlight"><pre><span></span><code><span class="nb">export</span><span class="w"> </span><span class="nv">DJ_DATABASE_NAME</span><span class="o">=</span>my_database
6232+
</code></pre></div>
6233+
<p>Or programmatically:</p>
6234+
<div class="highlight"><pre><span></span><code><span class="n">dj</span><span class="o">.</span><span class="n">config</span><span class="p">[</span><span class="s1">&#39;database.name&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;my_database&#39;</span>
6235+
</code></pre></div>
6236+
<p>This setting only applies to PostgreSQL. Setting it with the MySQL backend emits a warning.</p>
61886237
<h3 id="environment-variable">Environment Variable<a class="headerlink" href="#environment-variable" title="Permanent link">&para;</a></h3>
61896238
<div class="highlight"><pre><span></span><code><span class="nb">export</span><span class="w"> </span><span class="nv">DJ_BACKEND</span><span class="o">=</span>postgresql
61906239
<span class="nb">export</span><span class="w"> </span><span class="nv">DJ_HOST</span><span class="o">=</span>localhost
61916240
<span class="nb">export</span><span class="w"> </span><span class="nv">DJ_USER</span><span class="o">=</span>postgres
61926241
<span class="nb">export</span><span class="w"> </span><span class="nv">DJ_PASS</span><span class="o">=</span>password
6242+
<span class="nb">export</span><span class="w"> </span><span class="nv">DJ_DATABASE_NAME</span><span class="o">=</span>my_database<span class="w"> </span><span class="c1"># optional, defaults to &quot;postgres&quot;</span>
61936243
</code></pre></div>
61946244
<h3 id="programmatic-configuration_1">Programmatic Configuration<a class="headerlink" href="#programmatic-configuration_1" title="Permanent link">&para;</a></h3>
61956245
<div class="highlight"><pre><span></span><code><span class="kn">import</span><span class="w"> </span><span class="nn">datajoint</span><span class="w"> </span><span class="k">as</span><span class="w"> </span><span class="nn">dj</span>
61966246

61976247
<span class="n">dj</span><span class="o">.</span><span class="n">config</span><span class="p">[</span><span class="s1">&#39;database.backend&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;postgresql&#39;</span>
61986248
<span class="n">dj</span><span class="o">.</span><span class="n">config</span><span class="p">[</span><span class="s1">&#39;database.host&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;localhost&#39;</span>
6249+
<span class="n">dj</span><span class="o">.</span><span class="n">config</span><span class="p">[</span><span class="s1">&#39;database.name&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;my_database&#39;</span> <span class="c1"># optional</span>
61996250
</code></pre></div>
62006251
<h3 id="docker-compose-for-local-development">Docker Compose for Local Development<a class="headerlink" href="#docker-compose-for-local-development" title="Permanent link">&para;</a></h3>
62016252
<div class="highlight"><pre><span></span><code><span class="nt">services</span><span class="p">:</span>

‎how-to/demo_modules/__init__/index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3028,7 +3028,7 @@ <h1> init </h1>
30283028
</style>
30293029
<!-- End of mermaid configuration --><div class="jupyter-wrapper">
30303030
<div class="jp-Notebook" data-jp-theme-light="true" data-jp-theme-name="JupyterLab Light">
3031-
<div class="jp-Cell jp-MarkdownCell jp-Notebook-cell" id="cell-id=f480a304">
3031+
<div class="jp-Cell jp-MarkdownCell jp-Notebook-cell" id="cell-id=67636c41">
30323032
<div class="jp-Cell-inputWrapper" tabindex="0">
30333033
<div class="jp-Collapser jp-InputCollapser jp-Cell-inputCollapser">
30343034
</div>

‎how-to/demo_modules/acquisition/index.html‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3029,7 +3029,7 @@ <h1>Acquisition</h1>
30293029
<!-- End of mermaid configuration --><div class="jupyter-wrapper">
30303030
<div class="jp-Notebook" data-jp-theme-light="true" data-jp-theme-name="JupyterLab Light">
30313031
<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs">
3032-
<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=7df1821a">
3032+
<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=0730eced">
30333033
<div class="jp-Cell-inputWrapper" tabindex="0">
30343034
<div class="jp-Collapser jp-InputCollapser jp-Cell-inputCollapser">
30353035
</div>
@@ -3068,7 +3068,7 @@ <h1>Acquisition</h1>
30683068
</div>
30693069
</div>
30703070
</div><div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs">
3071-
<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=446cb02d">
3071+
<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=ae6ca3ba">
30723072
<div class="jp-Cell-inputWrapper" tabindex="0">
30733073
<div class="jp-Collapser jp-InputCollapser jp-Cell-inputCollapser">
30743074
</div>
@@ -3097,7 +3097,7 @@ <h1>Acquisition</h1>
30973097
</div>
30983098
</div>
30993099
</div><div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs">
3100-
<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=4acdd9eb">
3100+
<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=245806d0">
31013101
<div class="jp-Cell-inputWrapper" tabindex="0">
31023102
<div class="jp-Collapser jp-InputCollapser jp-Cell-inputCollapser">
31033103
</div>
@@ -3136,7 +3136,7 @@ <h1>Acquisition</h1>
31363136
</div>
31373137
</div>
31383138
</div><div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs">
3139-
<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=4a2c4c40">
3139+
<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=0a9b72ad">
31403140
<div class="jp-Cell-inputWrapper" tabindex="0">
31413141
<div class="jp-Collapser jp-InputCollapser jp-Cell-inputCollapser">
31423142
</div>
@@ -3179,7 +3179,7 @@ <h1>Acquisition</h1>
31793179
</div>
31803180
</div>
31813181
</div><div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs">
3182-
<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=52161cce">
3182+
<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=b9a10e42">
31833183
<div class="jp-Cell-inputWrapper" tabindex="0">
31843184
<div class="jp-Collapser jp-InputCollapser jp-Cell-inputCollapser">
31853185
</div>

‎how-to/demo_modules/analysis/index.html‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3029,7 +3029,7 @@ <h1>Analysis</h1>
30293029
<!-- End of mermaid configuration --><div class="jupyter-wrapper">
30303030
<div class="jp-Notebook" data-jp-theme-light="true" data-jp-theme-name="JupyterLab Light">
30313031
<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs">
3032-
<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=5126cbfe">
3032+
<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=7a4c1bb9">
30333033
<div class="jp-Cell-inputWrapper" tabindex="0">
30343034
<div class="jp-Collapser jp-InputCollapser jp-Cell-inputCollapser">
30353035
</div>
@@ -3070,7 +3070,7 @@ <h1>Analysis</h1>
30703070
</div>
30713071
</div>
30723072
</div><div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs">
3073-
<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=8f27eed2">
3073+
<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=9bb5d87b">
30743074
<div class="jp-Cell-inputWrapper" tabindex="0">
30753075
<div class="jp-Collapser jp-InputCollapser jp-Cell-inputCollapser">
30763076
</div>
@@ -3099,7 +3099,7 @@ <h1>Analysis</h1>
30993099
</div>
31003100
</div>
31013101
</div><div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs">
3102-
<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=e91bb747">
3102+
<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=01b4c2cf">
31033103
<div class="jp-Cell-inputWrapper" tabindex="0">
31043104
<div class="jp-Collapser jp-InputCollapser jp-Cell-inputCollapser">
31053105
</div>
@@ -3140,7 +3140,7 @@ <h1>Analysis</h1>
31403140
</div>
31413141
</div>
31423142
</div><div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs">
3143-
<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=819729ac">
3143+
<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=23679155">
31443144
<div class="jp-Cell-inputWrapper" tabindex="0">
31453145
<div class="jp-Collapser jp-InputCollapser jp-Cell-inputCollapser">
31463146
</div>
@@ -3189,7 +3189,7 @@ <h1>Analysis</h1>
31893189
</div>
31903190
</div>
31913191
</div><div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs">
3192-
<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=16d77b45">
3192+
<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=9655a021">
31933193
<div class="jp-Cell-inputWrapper" tabindex="0">
31943194
<div class="jp-Collapser jp-InputCollapser jp-Cell-inputCollapser">
31953195
</div>

‎how-to/demo_modules/processing/index.html‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3029,7 +3029,7 @@ <h1>Processing</h1>
30293029
<!-- End of mermaid configuration --><div class="jupyter-wrapper">
30303030
<div class="jp-Notebook" data-jp-theme-light="true" data-jp-theme-name="JupyterLab Light">
30313031
<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs">
3032-
<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=5b18b4c3">
3032+
<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=22be5784">
30333033
<div class="jp-Cell-inputWrapper" tabindex="0">
30343034
<div class="jp-Collapser jp-InputCollapser jp-Cell-inputCollapser">
30353035
</div>
@@ -3070,7 +3070,7 @@ <h1>Processing</h1>
30703070
</div>
30713071
</div>
30723072
</div><div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs">
3073-
<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=1cd73fc8">
3073+
<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=31259335">
30743074
<div class="jp-Cell-inputWrapper" tabindex="0">
30753075
<div class="jp-Collapser jp-InputCollapser jp-Cell-inputCollapser">
30763076
</div>
@@ -3099,7 +3099,7 @@ <h1>Processing</h1>
30993099
</div>
31003100
</div>
31013101
</div><div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs">
3102-
<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=7a36d8b7">
3102+
<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=1725c43b">
31033103
<div class="jp-Cell-inputWrapper" tabindex="0">
31043104
<div class="jp-Collapser jp-InputCollapser jp-Cell-inputCollapser">
31053105
</div>
@@ -3142,7 +3142,7 @@ <h1>Processing</h1>
31423142
</div>
31433143
</div>
31443144
</div><div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs">
3145-
<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=be659cab">
3145+
<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=085f7665">
31463146
<div class="jp-Cell-inputWrapper" tabindex="0">
31473147
<div class="jp-Collapser jp-InputCollapser jp-Cell-inputCollapser">
31483148
</div>
@@ -3191,7 +3191,7 @@ <h1>Processing</h1>
31913191
</div>
31923192
</div>
31933193
</div><div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs">
3194-
<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=360f18d5">
3194+
<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=9d0124bf">
31953195
<div class="jp-Cell-inputWrapper" tabindex="0">
31963196
<div class="jp-Collapser jp-InputCollapser jp-Cell-inputCollapser">
31973197
</div>

‎how-to/deploy-production/index.html‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6187,6 +6187,10 @@ <h3 id="override-for-migrations">Override for Migrations<a class="headerlink" hr
61876187
<h2 id="use-database-prefixes">Use Database Prefixes<a class="headerlink" href="#use-database-prefixes" title="Permanent link">&para;</a></h2>
61886188
<p>When multiple projects share a database server, use prefixes to avoid naming collisions and organize schemas.</p>
61896189
<h3 id="configure-database-prefix">Configure Database Prefix<a class="headerlink" href="#configure-database-prefix" title="Permanent link">&para;</a></h3>
6190+
<div class="admonition version-deprecated">
6191+
<p class="admonition-title">Deprecated in 2.2.1</p>
6192+
<p><code>database_prefix</code> is deprecated. For PostgreSQL, use <code>database.name</code> to select a database instead. <code>database_prefix</code> will be removed in 2.3.</p>
6193+
</div>
61906194
<div class="highlight"><pre><span></span><code><span class="kn">import</span><span class="w"> </span><span class="nn">datajoint</span><span class="w"> </span><span class="k">as</span><span class="w"> </span><span class="nn">dj</span>
61916195

61926196
<span class="n">dj</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">database</span><span class="o">.</span><span class="n">database_prefix</span> <span class="o">=</span> <span class="s1">&#39;myproject_&#39;</span>

‎llms-full.txt‎

Lines changed: 41 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# DataJoint Documentation (Full)
22

3-
Generated: 2026-04-01 15:38:13 UTC
3+
Generated: 2026-04-08 13:59:32 UTC
44
Commit: unknown
55
Branch: unknown
66

@@ -13028,6 +13028,7 @@ Environment variables take precedence over config files.
1302813028
| `database.user` | `DJ_USER` | — | Database username |
1302913029
| `database.password` | `DJ_PASS` | — | Database password |
1303013030
| `database.backend` | `DJ_BACKEND` | `mysql` | Database backend: `mysql` or `postgresql` |
13031+
| `database.name` | `DJ_DATABASE_NAME` | `None` | Database name (PostgreSQL only). Defaults to `"postgres"` |
1303113032
| `database.use_tls` | `DJ_TLS` | `True` | Use TLS encryption |
1303213033
| `database.reconnect` | — | `True` | Auto-reconnect on timeout |
1303313034
| `safemode` | — | `True` | Prompt before destructive operations |
@@ -13107,13 +13108,45 @@ DataJoint supports both MySQL and PostgreSQL backends. To use PostgreSQL:
1310713108

1310813109
The port defaults to `5432` when `backend` is set to `postgresql`.
1310913110

13111+
### Database Name
13112+
13113+
!!! version-added "New in 2.2.1"
13114+
The `database.name` setting specifies which PostgreSQL database to connect to.
13115+
13116+
PostgreSQL requires connecting to a specific database. By default, DataJoint connects to the `postgres` database. To use a different database:
13117+
13118+
```json
13119+
{
13120+
"database": {
13121+
"host": "localhost",
13122+
"backend": "postgresql",
13123+
"name": "my_database"
13124+
}
13125+
}
13126+
```
13127+
13128+
Or via environment variable:
13129+
13130+
```bash
13131+
export DJ_DATABASE_NAME=my_database
13132+
```
13133+
13134+
Or programmatically:
13135+
13136+
```python
13137+
dj.config['database.name'] = 'my_database'
13138+
```
13139+
13140+
This setting only applies to PostgreSQL. Setting it with the MySQL backend emits a warning.
13141+
1311013142
### Environment Variable
1311113143

1311213144
```bash
1311313145
export DJ_BACKEND=postgresql
1311413146
export DJ_HOST=localhost
1311513147
export DJ_USER=postgres
1311613148
export DJ_PASS=password
13149+
export DJ_DATABASE_NAME=my_database # optional, defaults to "postgres"
1311713150
```
1311813151

1311913152
### Programmatic Configuration
@@ -13123,6 +13156,7 @@ import datajoint as dj
1312313156

1312413157
dj.config['database.backend'] = 'postgresql'
1312513158
dj.config['database.host'] = 'localhost'
13159+
dj.config['database.name'] = 'my_database' # optional
1312613160
```
1312713161

1312813162
### Docker Compose for Local Development
@@ -14558,6 +14592,9 @@ When multiple projects share a database server, use prefixes to avoid naming col
1455814592

1455914593
### Configure Database Prefix
1456014594

14595+
!!! version-deprecated "Deprecated in 2.2.1"
14596+
`database_prefix` is deprecated. For PostgreSQL, use `database.name` to select a database instead. `database_prefix` will be removed in 2.3.
14597+
1456114598
```python
1456214599
import datajoint as dj
1456314600

@@ -23936,9 +23973,10 @@ Configuration is loaded in priority order:
2393623973
| `database.port` | `DJ_PORT` | `3306`/`5432` | Database server port (auto-detects from backend) |
2393723974
| `database.user` | `DJ_USER` | — | Database username (required) |
2393823975
| `database.password` | `DJ_PASS` | — | Database password (required) |
23976+
| `database.name` | `DJ_DATABASE_NAME` | `None` | Database name for PostgreSQL connections. Defaults to `"postgres"` if not set. *(new in 2.2.1)* |
2393923977
| `database.reconnect` | — | `True` | Auto-reconnect on connection loss |
2394023978
| `database.use_tls` | `DJ_USE_TLS` | `None` | Enable TLS encryption *(env var new in 2.1)* |
23941-
| `database.database_prefix` | `DJ_DATABASE_PREFIX` | `""` | Prefix for database/schema names |
23979+
| `database.database_prefix` | `DJ_DATABASE_PREFIX` | `""` | *(Deprecated — use `database.name` instead)* Prefix for database/schema names |
2394223980
| `database.create_tables` | `DJ_CREATE_TABLES` | `True` | Default for `Schema(create_tables=)`. Set `False` for production mode |
2394323981

2394423982
## Connection Settings
@@ -24155,6 +24193,7 @@ echo ".secrets/" >> .gitignore
2415524193
export DJ_HOST=mysql.example.com
2415624194
export DJ_USER=analyst
2415724195
export DJ_PASS=secret
24196+
export DJ_DATABASE_NAME=my_database # PostgreSQL only (new in 2.2.1)
2415824197
```
2415924198

2416024199
**Note:** Per-store credentials must be configured in `datajoint.json` or `.secrets/` — environment variable overrides are not supported for nested store configurations.

‎reference/configuration/index.html‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6053,6 +6053,12 @@ <h2 id="database-settings">Database Settings<a class="headerlink" href="#databas
60536053
<td>Database password (required)</td>
60546054
</tr>
60556055
<tr>
6056+
<td><code>database.name</code></td>
6057+
<td><code>DJ_DATABASE_NAME</code></td>
6058+
<td><code>None</code></td>
6059+
<td>Database name for PostgreSQL connections. Defaults to <code>"postgres"</code> if not set. <em>(new in 2.2.1)</em></td>
6060+
</tr>
6061+
<tr>
60566062
<td><code>database.reconnect</code></td>
60576063
<td>—</td>
60586064
<td><code>True</code></td>
@@ -6068,7 +6074,7 @@ <h2 id="database-settings">Database Settings<a class="headerlink" href="#databas
60686074
<td><code>database.database_prefix</code></td>
60696075
<td><code>DJ_DATABASE_PREFIX</code></td>
60706076
<td><code>""</code></td>
6071-
<td>Prefix for database/schema names</td>
6077+
<td><em>(Deprecated — use <code>database.name</code> instead)</em> Prefix for database/schema names</td>
60726078
</tr>
60736079
<tr>
60746080
<td><code>database.create_tables</code></td>
@@ -6501,6 +6507,7 @@ <h3 id="environment-variables-alternative-to-secrets">Environment Variables (Alt
65016507
<span class="nb">export</span><span class="w"> </span><span class="nv">DJ_HOST</span><span class="o">=</span>mysql.example.com
65026508
<span class="nb">export</span><span class="w"> </span><span class="nv">DJ_USER</span><span class="o">=</span>analyst
65036509
<span class="nb">export</span><span class="w"> </span><span class="nv">DJ_PASS</span><span class="o">=</span>secret
6510+
<span class="nb">export</span><span class="w"> </span><span class="nv">DJ_DATABASE_NAME</span><span class="o">=</span>my_database<span class="w"> </span><span class="c1"># PostgreSQL only (new in 2.2.1)</span>
65046511
</code></pre></div>
65056512
<p><strong>Note:</strong> Per-store credentials must be configured in <code>datajoint.json</code> or <code>.secrets/</code> — environment variable overrides are not supported for nested store configurations.</p>
65066513
<h2 id="programmatic-access">Programmatic Access<a class="headerlink" href="#programmatic-access" title="Permanent link">&para;</a></h2>

‎search/search_index.json‎

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)