Skip to content

Commit 73b4258

Browse files
committed
feat: address comments
1 parent 569cfb0 commit 73b4258

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

templates/mle-ts-ords-backend/README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ Building on top of the standard [mle-ts-sample](../mle-ts-sample/README.md) layo
2626
| `src/ords.ts` | Contains handler functions for ORDS REST endpoints. |
2727
| `src/index.ts` | Exports the public API for the MLE module (see mle-ts-sample), plus ORDS handler implementations. |
2828
| `utils/database/ords.sql` | SQL script to configure ORDS: installs ORDS modules, templates, and handlers bound to the MLE JS module. |
29+
| `utils/db.mjs` | `db.mjs` is a wrapper around SQLcl. It is used to execute SQL scripts in the database using creadentials specified in `.env` file. See `package.json` for usage. |
2930
| `test/rest.test.js` | Automated tests for the REST API endpoints, using HTTP requests against the running ORDS backend. |
3031
| `docker-compose.yml` | Docker Compose file spinning up both Oracle Database 23 Free (`db23`) and an ORDS node (`ords-node1`). |
3132
| `utils/database/setup/01-user-setup.sql` | Creates MLE enabled user. The script is run during docker container DB service startup. |
@@ -36,7 +37,7 @@ All standard files and scripts from [`mle-ts-sample`](../mle-ts-sample/README.md
3637

3738
- [Oracle Database 23ai](https://www.oracle.com/database/) or Oracle Database Free (provided via Docker Compose).
3839
- [Oracle REST Data Services](https://www.oracle.com/database/technologies/appdev/rest.html) (ORDS, configured for database access).
39-
- [SQLcl](https://www.oracle.com/database/sqldeveloper/technologies/sqlcl) for deploying MLE modules.
40+
- [SQL Developer Command Line](https://www.oracle.com/database/sqldeveloper/technologies/sqlcl), aka _sqlcl_ is used to deploy the bundled JavaScript code as an MLE module in the database.
4041
- [Node.js](https://nodejs.org/).
4142
- (Optional) [Docker](https://www.docker.com/) and [Docker Compose](https://docs.docker.com/compose/) for quick local setup.
4243
_Note: Any suitable container engine, such as [Podman](https://podman.io/), can be used in place of Docker._

0 commit comments

Comments
 (0)