This application works with dynamic tables: when you add a new field to the database, it will automatically appear in the UI. The application is displayed on a Jira global page.

See the Forge documentation for more details.

Before starting, ensure that your Forge environment is set up. Follow the Forge setup guide for instructions.

npm install

./create-and-run-db.sh

or

export MYSQL_ROOT_PASSWORD=admin
docker run -d --name forge-sql-orm-example-db -p 3366:3306 -e MYSQL_ROOT_PASSWORD=${MYSQL_ROOT_PASSWORD} --security-opt seccomp=unconfined --restart=always mysql
# wait 30 sec
docker exec forge-sql-orm-example-db mysql -uroot -padmin -e "create database dynamicforgesqlorm"
docker exec forge-sql-orm-example-db mysql -uroot -p${MYSQL_ROOT_PASSWORD} -e "grant all privileges on dynamicforgesqlorm.* TO 'root'@'%';"
docker exec forge-sql-orm-example-db mysql -uroot -p${MYSQL_ROOT_PASSWORD} -e "use dynamicforgesqlorm; create table users (id int not null auto_increment primary key, name varchar(200) null)"

npm run models:create

npm run migration:create

npm install

npm run build

forge register

forge deploy

forge install -s <environment>.atlassian.net

forge webtrigger

? Select a web trigger: invoke-schema-migration

Copy your web trigger URL below to start using it:

https://c0f17555-2e0a-4c3d-ac3c-e1eb6c4b86a9.hello.atlassian-dev.net/x1/CrBtzGoiNboUxjhROYWVJa3aSm4

Open the copied URL in your browser. You should see the message: 'Migrations successfully executed'.

Go to <environment>.atlassian.net and open the Forge SQL ORM Data Sync app.

1. You can add users with only the name field initially since your table has only one column.
2. If you add more than one record, you can sort the table by the name field.
3. If you add two records with the same name, you can click the "Find Duplicates" button. It will display two columns: count and name.

1. If you need to add a new field (e.g., email), update the table structure:

export MYSQL_ROOT_PASSWORD=admin
docker exec forge-sql-orm-example-db mysql -uroot -p${MYSQL_ROOT_PASSWORD} -e "use dynamicforgesqlorm; ALTER TABLE users ADD email VARCHAR(255);"

2. Update migrations:

npm run migration:update

3. Update models:

npm run models:create

4. Deploy the updated app:

forge deploy

5. Get the new Web Trigger URL:

forge webtrigger

6. Open the Web Trigger URL in a browser. You should see 'Migrations successfully executed'.
7. Refresh the Jira app page (<environment>.atlassian.net) to see the new columns (name and email).
8. The duplicate search feature will now work for both name and email fields.
9. You can add as many fields as needed.

• Use forge deploy to persist code changes.
• Use forge install only when installing the app on a new site.
• Once the app is installed, any new deployments will be automatically reflected without needing to reinstall.