NeoAnd/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2025-08-17 04:58:16 -06:00
Code Issues Actions 4 Packages Projects Releases Wiki Activity

Update replicating-netbox.md

Browse Source 
Load external database documentation is not working and there are many missing steps. This PR significantly improves the information needed to successfully and efficiently load an exported database.
This commit is contained in:
Nicolas Kowenski 2024-02-09 14:19:54 +01:00 committed by GitHub
parent 040dbcc875
commit e0f36d5d4d
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 27 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
docs/administration/replicating-netbox.md
View File

@ -9,10 +9,10 @@ NetBox employs a [PostgreSQL](https://www.postgresql.org/) database, so general
### Export the Database
Use the `pg_dump` utility to export the entire database to a file:
Use the `pg_dump` utility (available on the PostgreSQL container) to export the entire database to a file:
```no-highlight
pg_dump --username netbox --password --host localhost netbox > netbox.sql
pg_dump --username netbox --password --host localhost netbox > /tmp/netbox.sql
```
!!! note
@ -21,7 +21,7 @@ pg_dump --username netbox --password --host localhost netbox > netbox.sql
When replicating a production database for development purposes, you may find it convenient to exclude changelog data, which can easily account for the bulk of a database's size. To do this, exclude the `extras_objectchange` table data from the export. The table will still be included in the output file, but will not be populated with any data.
```no-highlight
pg_dump ... --exclude-table-data=extras_objectchange netbox > netbox.sql
pg_dump ... --exclude-table-data=extras_objectchange netbox > /tmp/netbox.sql
```
### Load an Exported Database
@ -32,11 +32,32 @@ When restoring a database from a file, it's recommended to delete any existing d
The following will destroy and replace any existing instance of the database.
```no-highlight
psql -c 'drop database netbox'
psql -c 'create database netbox'
psql netbox < netbox.sql
psql -U netbox -h localhost
netbox=> \c template1
You are now connected to database "template1" as user "netbox".
template1=# REVOKE CONNECT ON DATABASE netbox FROM public;
REVOKE
template1=# SELECT pg_terminate_backend(pg_stat_activity.pid) FROM pg_stat_activity WHERE pg_stat_activity.datname = 'netbox';
pg_terminate_backend
----------------------
t
(0 row)
template1=# DROP database netbox;
DROP DATABASE
postgres-> \q
```
Note a few things here:
1- In PostgreSQL one has to change the actual database to another to be able to drop it.
2- There must be no active connections at the moment, so we have to prevent new connections and drop all actual ones ("0 row").
finally, load the database:
```no-highlight
psql netbox -U netbox -h localhost < /tmp/netbox.sql
```
Keep in mind that PostgreSQL user accounts and permissions are not included with the dump: You will need to create those manually if you want to fully replicate the original database (see the [installation docs](../installation/1-postgresql.md)). When setting up a development instance of NetBox, it's strongly recommended to use different credentials anyway.
### Export the Database Schema