feat: mle-ts-ords-backend template #301 #302

DimaNike · 2025-06-05T08:33:38Z

[PR] MLE ORDS BACKEND TEMPLATE

## Description
Introduces new MLE template that uses existing mle-ts-sample as backend logic and adds ORDS configuration to expose existing logic as REST endpoint.

Fixes #301 

## Type of change
- [ ] Bug fix (non-breaking change which fixes an issue)
- [x] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [ ] This change requires a documentation update

## How Has This Been Tested?
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

- [ ] Test A
- [ ] Test B

## Checklist:
- [x] My code follows the style guidelines of this project
- [x] I have performed a self-review of my own code
- [x] I have commented my code, particularly in hard-to-understand areas
- [x] I have made corresponding changes to the documentation
- [x] My changes generate no new warnings/errors
- [n/a] I have added tests that prove my fix is effective or that my feature works
- [n/a] New and existing unit tests pass locally with my changes

LeonSilva15

great documentation @DimaNike, thanks!

templates/mle-ts-sample/src/todos.ts

templates/mle-ts-ords-backend/utils/database/ords.sql

templates/mle-ts-ords-backend/test/rest.test.js

templates/mle-ts-ords-backend/docker-compose.yml

templates/mle-ts-ords-backend/test/rest.test.js

templates/mle-ts-ords-backend/docker-compose.yml

templates/mle-ts-ords-backend/utils/database/ords.sql

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

templates/mle-ts-ords-backend/utils/database/ords.sql

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

dbtools-antcampo · 2025-07-04T23:40:11Z

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

+
+- [Oracle Database 23ai](https://www.oracle.com/database/) or Oracle Database Free (provided via Docker Compose).
+- [Oracle REST Data Services](https://www.oracle.com/database/technologies/appdev/rest.html) (ORDS, configured for database access).
+- [SQLcl](https://www.oracle.com/database/sqldeveloper/technologies/sqlcl) for deploying MLE modules.


When testing we didn't find any real reference to SQLcl, so my question is, can we remove this dependency? If so, it would also need to be removed from the CLI wizard.

dbtools-antcampo · 2025-07-04T23:41:27Z

src/index.ts

+                Object.assign( configObject, {
+                    ordsHost: ordsHost === '' ? await input(
+                        {
+                            message: 'Please provide ORDS Base URL: ',


If the ORDS base path provided contains a slash at the end, the BASE_URL for tests generates something like <my_hostname>/ords//<my_db_user> with a double slash which makes tests fail (test/rest.test.js)

LeonSilva15 · 2025-07-05T00:00:00Z

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

+
+Follow the general steps in the [mle-ts-sample/README](../mle-ts-sample/README.md#getting-started) to create your project, but **choose `mle-ts-ords-backend` as the template** during `@create-database-app` initialization.
+
+### 2. (Optional) Start Development Environment with Docker Compose


Running the docker-compose up throws a permissions error:

Gracefully stopping... (press Ctrl+C again to force) Error response from daemon: error while creating mount source path 'create-database-app/templates/mle-ts-ords-backend/ords/config': chown create-database-app/templates/mle-ts-ords-backend/ords/config: permission denied

we need to add this step or caveat informing chmod can fix this: chmod -R 770 create-database-app/templates/mle-ts-ords-backend/ or execute with sudo / as admin

Would be nice to also have the path to the docker-compose.yml (create-database-app/templates/mle-ts-ords-backend) so the users can know where to go to run this command

LeonSilva15 · 2025-07-05T00:15:29Z

src/index.ts

@@ -540,7 +554,8 @@ export default class Generate extends Command {
            } );
        }

-        if(templateChoice == 'mle-ts-sample'){
+        if(templateChoice == 'mle-ts-sample' || templateChoice == 'mle-ts-ords-backend') 


Please use strict comparison === instead

LeonSilva15 · 2025-07-05T00:15:37Z

src/index.ts

@@ -552,6 +567,21 @@ export default class Generate extends Command {
                    },
                ) : sqlclPath
            });
+            if (templateChoice == 'mle-ts-ords-backend') 


Please use strict comparison === instead

LeonSilva15 · 2025-07-05T00:51:13Z

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

+- `db23` - Oracle Database 23 Free
+- `ords-node1` - ORDS server configured to use `db23`
+
+See the `docker-compose.yml` file (and its comments) for configuration options.


it'd also be really valuable if here we ask the user to create a user and grant the required permissions or create one for them.
What we did was create one of our own and grant:
CONNECT, DBA, PDB_DBA, SYSDBA, and EXECUTE ON JAVASCRIPT

feat: mle-ts-ords-backend template

9452d20

oracle-contributor-agreement bot added the OCA Verified All contributors have signed the Oracle Contributor Agreement. label Jun 5, 2025

LeonSilva15 reviewed Jun 14, 2025

View reviewed changes

feat: review comments

0c2868b

LeonSilva15 reviewed Jun 25, 2025

View reviewed changes

DimaNike added 4 commits June 25, 2025 10:28

feat: review comments

af0d0b1

feat: comments

c18d199

feat: readme.md update

03fedbd

feat: fix

17bae72

dbtools-antcampo requested changes Jul 4, 2025

View reviewed changes

LeonSilva15 requested changes Jul 5, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat: mle-ts-ords-backend template #301 #302

feat: mle-ts-ords-backend template #301 #302

Uh oh!

DimaNike commented Jun 5, 2025

Uh oh!

LeonSilva15 left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dbtools-antcampo Jul 4, 2025

Uh oh!

dbtools-antcampo Jul 4, 2025

Uh oh!

LeonSilva15 Jul 5, 2025 •

edited

Loading

Uh oh!

LeonSilva15 Jul 5, 2025

Uh oh!

LeonSilva15 Jul 5, 2025

Uh oh!

LeonSilva15 Jul 5, 2025

Uh oh!

Uh oh!


		Follow the general steps in the [mle-ts-sample/README](../mle-ts-sample/README.md#getting-started) to create your project, but choose `mle-ts-ords-backend` as the template during `@create-database-app` initialization.

		### 2. (Optional) Start Development Environment with Docker Compose

feat: mle-ts-ords-backend template #301 #302

Are you sure you want to change the base?

feat: mle-ts-ords-backend template #301 #302

Uh oh!

Conversation

DimaNike commented Jun 5, 2025

[PR] MLE ORDS BACKEND TEMPLATE

Uh oh!

LeonSilva15 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dbtools-antcampo Jul 4, 2025

Choose a reason for hiding this comment

Uh oh!

dbtools-antcampo Jul 4, 2025

Choose a reason for hiding this comment

Uh oh!

LeonSilva15 Jul 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

LeonSilva15 Jul 5, 2025

Choose a reason for hiding this comment

Uh oh!

LeonSilva15 Jul 5, 2025

Choose a reason for hiding this comment

Uh oh!

LeonSilva15 Jul 5, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

LeonSilva15 Jul 5, 2025 •

edited

Loading