You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+15-6
Original file line number
Diff line number
Diff line change
@@ -5,9 +5,9 @@
5
5
<spanclass="badge-npmversion"><ahref="https://www.npmjs.com/package/@mep-agency/local-dev-db"title="View this project on NPM"><imgsrc="https://img.shields.io/npm/v/%40mep-agency/local-dev-db"alt="NPM version" /></a></span>
6
6
<spanclass="badge-npmdownloads"><ahref="https://www.npmjs.com/package/@mep-agency/local-dev-db"title="View this project on NPM"><imgsrc="https://img.shields.io/npm/dt/%40mep-agency/local-dev-db"alt="NPM downloads" /></a></span>
7
7
8
-
A zero-config local MariaDB instance for local development (using Docker) so you can finally stop doing things like:
8
+
A zero-config local MySQL instance for local development (using Docker) so you can finally stop doing things like:
9
9
10
-
- Using different databases for dev and prod environments (e.g. SQLite vs MariaDB/MySQL)
10
+
- Using different databases for dev and prod environments (e.g. SQLite vs MySQL/MariaDB)
11
11
- Installing a local database server directly on your machine
12
12
- Spending time getting up and running in a new development environment
13
13
@@ -16,11 +16,11 @@ A zero-config local MariaDB instance for local development (using Docker) so you
16
16
While this tool is designed to be installed as a dependency in your projects, it actually runs as a single database server.
17
17
This makes it possible to optimize resources when working on multiple projects at the same time.
18
18
19
-
Feel free to install this tool as a dependency in any project where you need a MariaDB/MySQL database, CLI commands will act on the same instance and all your databases will share the same storage volume.
19
+
Feel free to install this tool as a dependency in any project where you need a MySQL/MariaDB database, CLI commands will act on the same instance and all your databases will share the same storage volume.
20
20
21
21
## Features
22
22
23
-
- Runs a fully-featured MariaDB server without touching your local system
23
+
- Runs a fully-featured MySQL server without touching your local system
24
24
- Runs a PhpMyAdmin instance attached to the DB server so you can manage your databases with no additional software
25
25
- Provides you with a simple set of CLI commands do run common tasks:
26
26
- Create/drop databases and dedicated users
@@ -59,7 +59,7 @@ Run the `ldd` binary to see the available commands:
59
59
$ yarn ldd --help
60
60
Usage: ldd [options] [command]
61
61
62
-
A zero-config localMariaDB instance forlocal development (using Docker)
62
+
A zero-config localMySQL instance forlocal development (using Docker)
63
63
64
64
Options:
65
65
-V, --version output the version number
@@ -139,7 +139,16 @@ Creating a new DB named "my-awesome-app"...
139
139
140
140
We hope you never have to use them, but just in case, here are some ENV vars you can set on your machine to customize the behavior of the application:
141
141
142
-
-`LDD_DB_IMAGE_TAG` (default: `latest`): we use the official [MariaDB](https://hub.docker.com/_/mariadb) Docker image. You can pick a different tag if you wish.
142
+
#### Server behavior
143
+
144
+
-`LDD_SQL_MODE` (default: `"ANSI,ONLY_FULL_GROUP_BY,ERROR_FOR_DIVISION_BY_ZERO,NO_ENGINE_SUBSTITUTION,NO_ZERO_DATE,NO_ZERO_IN_DATE,STRICT_ALL_TABLES,ALLOW_INVALID_DATES"`): The SQL mode to use for the MySQL server.
145
+
-`LDD_SQL_REQUIRE_PRIMARY_KEY` (default: `ON`): Whether to require primary keys to be defined for each table.
146
+
-`LDD_DEFAULT_STORAGE_ENGINE` (default: `InnoDB`): The default storage engine to use for the MySQL server.
147
+
-`LDD_EXPLICIT_DEFAULTS_FOR_TIMESTAMP` (default: `ON`): Whether to use explicit defaults for timestamp columns.
148
+
149
+
#### Advanced customization
150
+
151
+
-`LDD_DB_IMAGE_TAG` (default: `lts`): we use the official [MySQL](https://hub.docker.com/_/mysql) Docker image. You can pick a different tag if you wish.
143
152
-`LDD_DB_PORT` (default: `3306`): The database server will be attached to this port on your local machine. You can customize this to avoid any conflicts with other services.
144
153
-`LDD_DB_ROOT_PASSWORD` (default: `not-secure-pwd`): This tool is not secure by design, so you should probably leave this untouched to avoid issues.
145
154
-`LDD_PMA_IMAGE_TAG` (default: `latest`): we use the official [PhpMyAdmin](https://hub.docker.com/_/phpmyadmin) Docker image. You can pick a different tag if you wish.
0 commit comments