Skip to content

Commit eae2dc6

Browse files
committed
Update docs with new settings
1 parent 1c273b9 commit eae2dc6

File tree

2 files changed

+6
-17
lines changed

2 files changed

+6
-17
lines changed

docs/source/quickstart.rst

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -27,21 +27,16 @@ For the simplest case, we will need `make-tables`, `make-generators`, `create-ta
2727
we need to set environment variables to tell sqlsynthgen how to access our source database (where the real data resides now) and destination database (where the synthetic data will go).
2828
We can do that in the terminal with the `export` keyword, as shown below, or in a file called `.env`.
2929
The source and destination may be on the same database server, as long as the database or schema names differ.
30+
If the source and destination schemas are the default schema for the user on that database, you should not set those variables.
31+
If you are using a DBMS that does not support schemas (e.g. MariaDB), you must not set those variables.
3032

3133
.. code-block:: console
3234
33-
$ export SRC_HOST_NAME='[email protected]'
34-
$ export SRC_USER_NAME='someuser'
35-
$ export SRC_PASSWORD='secretpassword'
35+
$ export SRC_DSN="postgresql://someuser:[email protected]"
3636
$ export SRC_SCHEMA='myschema'
37-
$ export SRC_DB_NAME='source_db'
3837
39-
$ export DST_HOST_NAME='[email protected]'
40-
$ export DST_USER_NAME='someuser'
41-
$ export DST_PASSWORD='secretpassword'
38+
$ export DST_DSN="postgresql://someuser:[email protected]/dst_db"
4239
$ export DST_SCHEMA='myschema'
43-
$ export DST_DB_NAME='destination_db'
44-
4540
4641
Next, we make a SQLAlchemy file that defines the structure of your database using the `make-tables` command:
4742

docs/source/tutorials/airbnb.rst

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -28,14 +28,8 @@ First, we need to provide SSG with the connection parameters, using a ``.env`` f
2828

2929
.. code-block:: console
3030
31-
SRC_HOST_NAME=localhost
32-
SRC_USER_NAME=postgres
33-
SRC_PASSWORD=password
34-
SRC_DB_NAME=airbnb
35-
DST_HOST_NAME=localhost
36-
DST_USER_NAME=postgres
37-
DST_PASSWORD=password
38-
DST_DB_NAME=dst
31+
SRC_DSN='postgresql://postgres:password@localhost/airbnb'
32+
DST_DSN='postgresql://postgres:password@localhost/dst'
3933
4034
We can start the schema migration process by running the following command::
4135

0 commit comments

Comments
 (0)