Skip to content

Commit a945975

Browse files
authored
Update README.md
1 parent b4665dd commit a945975

File tree

1 file changed

+51
-29
lines changed

1 file changed

+51
-29
lines changed

README.md

Lines changed: 51 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -181,35 +181,57 @@ Now you can run the Application locally in IntelliJ IDEA by simply right-clickin
181181

182182
### Supported Configuration Properties
183183

184-
spring.local.postgresql.engaged
185-
: Whether the embedded, containerized PostgreSQL database should be configured to start when the Application starts. By default, it is not engaged. Only engaged if `true`.
186-
187-
spring.local.postgresql.container.image
188-
: The name of a Docker Image containing a given version of PostgreSQL (example: `postgres:15`). If undefined, the Testcontainers default of `postgres:9.6.12` is used.
189-
190-
spring.local.postgresql.container.port
191-
: The port on the Docker Container that should map to the port used by PostgreSQL inside the container. If undefined, a random port is used, which is preferred for integration tests, but when running the Application locally, defining a fixed port is useful. It gives developers the ability to configure a JDBC client with a consistent port. Otherwise, the port in the client's configuration must be updated if the Application had been restarted since the client was last used.
192-
193-
spring.local.postgresql.container.log.follow
194-
: Whether the Application should log the log output produced by the Container. By default, container logs are not followed. Set with `true` to see their output.
195-
196-
spring.local.postgresql.database.name
197-
: The name of the PostgreSQL database the Application will connect to. If undefined, defaults to the Testcontainers default of `test`.
198-
199-
spring.local.postgresql.database.username
200-
: The username of an admin or superuser in the PostgreSQL database. If no `spring.local.postgresql.database.application.username` is defined, this will also be the username the Application uses to connect. If undefined, defaults to the Testcontainers default of `test`.
201-
202-
spring.local.postgresql.database.password
203-
: The password that goes with the username of the admin or superuser in the PostgreSQL database. If no `spring.local.postgresql.database.application.username` is defined, this will also be the password for the username the Application uses to connect. If undefined, defaults to the Testcontainers default of `test`.
204-
205-
spring.local.postgresql.database.application.username
206-
: In most cases the database user used by the Application should not have admin or superuser privileges. This property provides the ability to define the username of an "application user" for use during testing and local development. The Application will use this username to connect to the PostgreSQL database. If undefined, the value defined by `spring.local.postgresql.database.username` will be used instead. NOTE: This application user is NOT automatically created. An init-script is required to create the user and grant their initial privileges.
207-
208-
spring.local.postgresql.database.application.password
209-
: In most cases the database user used by the Application should not have admin or superuser privileges. This property provides the ability to define the password for the username of an "application user" for use during testing and local development. The Application will use this password to connect to the PostgreSQL database. If undefined, the value defined by `spring.local.postgresql.database.password` will be used instead. NOTE: This application user is NOT automatically created. An init-script is required to create the user and grant their initial privileges.
210-
211-
spring.local.postgresql.database.init.script
212-
: The path to an SQL file (beginning with the `resources` directory as the root) that should be executed when the Docker Container starts. Executes before migrations. Useful for administrative tasks, like creating additional users, for example. If undefined, no script is executed.
184+
<dl>
185+
<dt>spring.local.postgresql.engaged</dt>
186+
<dd>
187+
Whether the embedded, containerized PostgreSQL database should be configured to start when the Application starts. By default, it is not engaged. Only engaged if `true`.
188+
</dd>
189+
190+
<dt>spring.local.postgresql.container.image</dt>
191+
<dd>
192+
The name of a Docker Image containing a given version of PostgreSQL (example: `postgres:15`). If undefined, the Testcontainers default of `postgres:9.6.12` is used.
193+
</dd>
194+
195+
<dt>spring.local.postgresql.container.port</dt>
196+
<dd>
197+
The port on the Docker Container that should map to the port used by PostgreSQL inside the container. If undefined, a random port is used, which is preferred for integration tests, but when running the Application locally, defining a fixed port is useful. It gives developers the ability to configure a JDBC client with a consistent port. Otherwise, the port in the client's configuration must be updated if the Application had been restarted since the client was last used.
198+
</dd>
199+
200+
<dt>spring.local.postgresql.container.log.follow</dt>
201+
<dd>
202+
Whether the Application should log the log output produced by the Container. By default, container logs are not followed. Set with `true` to see their output.
203+
</dd>
204+
205+
<dt>spring.local.postgresql.database.name</dt>
206+
<dd>
207+
The name of the PostgreSQL database the Application will connect to. If undefined, defaults to the Testcontainers default of `test`.
208+
</dd>
209+
210+
<dt>spring.local.postgresql.database.username</dt>
211+
<dd>
212+
The username of an admin or superuser in the PostgreSQL database. If no `spring.local.postgresql.database.application.username` is defined, this will also be the username the Application uses to connect. If undefined, defaults to the Testcontainers default of `test`.
213+
</dd>
214+
215+
<dt>spring.local.postgresql.database.password</dt>
216+
<dd>
217+
The password that goes with the username of the admin or superuser in the PostgreSQL database. If no `spring.local.postgresql.database.application.username` is defined, this will also be the password for the username the Application uses to connect. If undefined, defaults to the Testcontainers default of `test`.
218+
</dd>
219+
220+
<dt>spring.local.postgresql.database.application.username</dt>
221+
<dd>
222+
In most cases the database user used by the Application should not have admin or superuser privileges. This property provides the ability to define the username of an "application user" for use during testing and local development. The Application will use this username to connect to the PostgreSQL database. If undefined, the value defined by `spring.local.postgresql.database.username` will be used instead. NOTE: This application user is NOT automatically created. An init-script is required to create the user and grant their initial privileges.
223+
</dd>
224+
225+
<dt>spring.local.postgresql.database.application.password</dt>
226+
<dd>
227+
In most cases the database user used by the Application should not have admin or superuser privileges. This property provides the ability to define the password for the username of an "application user" for use during testing and local development. The Application will use this password to connect to the PostgreSQL database. If undefined, the value defined by `spring.local.postgresql.database.password` will be used instead. NOTE: This application user is NOT automatically created. An init-script is required to create the user and grant their initial privileges.
228+
</dd>
229+
230+
<dt>spring.local.postgresql.database.init.script</dt>
231+
<dd>
232+
The path to an SQL file (beginning with the `resources` directory as the root) that should be executed when the Docker Container starts. Executes before migrations. Useful for administrative tasks, like creating additional users, for example. If undefined, no script is executed.
233+
</dd>
234+
</dl>
213235

214236
## Examples
215237

0 commit comments

Comments
 (0)