generated from oracle/template-repo
-
Notifications
You must be signed in to change notification settings - Fork 2
Add Apple Silicon Usage doc #23
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,178 @@ | ||
| # Oracle Storage Adapter for Parse Server on Apple Silicon | ||
|
|
||
| This document describes how to build and run [Parse Server](https://parseplatform.org/) with the new Oracle storage adapter on [Apple Silicon](https://en.wikipedia.org/wiki/Apple_silicon). It will demonstrate running against the [Free Oracle Database 23ai Docker container](https://www.oracle.com/database/free) using the [Oracle NodeJS libraries](https://node-oracledb.readthedocs.io/en/latest). | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| The Oracle SQL client is a software application that allows users to connect to an Oracle database and execute queries and manage the database. | ||
|
|
||
| [SQL Client](https://www.oracle.com/database/sqldeveloper/technologies/sqlcl/download/) | ||
|
|
||
| The Oracle Instant Client is a set of software libraries that allow users to connect to an Oracle database without a full Oracle database installation. | ||
|
|
||
| [Instant Client Libraries](https://www.oracle.com/cis/database/technologies/instant-client/downloads.html) | ||
|
|
||
| ## Installation | ||
|
|
||
| Clone [Parse Server Repository](https://github.com/parse-community/parse-server). Supported version 7.3.0 and above. | ||
|
|
||
| There were changes in this release that supported: | ||
|
|
||
| 1. [Test Exclusion List](https://github.com/parse-community/parse-server/pull/8774) | ||
| 2. [Dynamic Database Adapter configuration](https://github.com/parse-community/parse-server/pull/8883) | ||
|
|
||
| ``` | ||
| git clone --depth 1 --branch 7.3.0 https://github.com/parse-community/parse-server.git | ||
| cd parse-server | ||
| ``` | ||
| 2. Clone this Oracle Samples repo into src/Adapters/Storage/Oracle | ||
| ``` | ||
| cd src/Adapters/Storage | ||
| git clone https://github.com/oracle-samples/oracleadapter-parse.git Oracle | ||
| cd Oracle | ||
| rm -rf .git # IMPORTANT or build will fail | ||
| cd ../../../.. # Go back to Project Root | ||
| ``` | ||
|
|
||
| ## Getting Started | ||
| ### Building Parse with Oracle Storage Adapter | ||
| 1. Add the Oracle database dependency | ||
|
|
||
| ``` | ||
| npm install [email protected] | ||
| ``` | ||
|
|
||
| [Quick Start node-oracledb Installation](https://node-oracledb.readthedocs.io/en/latest/user_guide/installation.html#quick-start-node-oracledb-installation) | ||
|
|
||
| 2. Add the Parse File Adapter dependency | ||
|
|
||
| ``` | ||
| npm install --save @parse/fs-files-adapter | ||
| ``` | ||
|
|
||
| This defaults to local storage. | ||
|
|
||
| [Parse Server File Storage Adapter Repository](https://github.com/parse-community/parse-server-fs-adapter) | ||
|
|
||
| 3. Run | ||
| ``` | ||
| npm ci | ||
| ``` | ||
| to build the server | ||
|
|
||
| ## How To Run | ||
| ### Configuring Free23ai Oracle database image | ||
| 1. Get and Start the image | ||
|
|
||
| ``` | ||
| docker run --name free23ai -d -p 1521:1521 -e ORACLE_PASSWORD=Welcome12345 -e APP_USER=testuser -e APP_USER_PASSWORD=Welcome12345 gvenzl/oracle-free:23.5-slim-faststart | ||
| ``` | ||
|
|
||
| It takes about a minute for the image to reach a healthy state on my MacBook | ||
|
|
||
| 2. Connect to the image as sysdba | ||
|
|
||
| ``` | ||
| sql sys/Welcome12345@localhost:1521 as sysdba | ||
| ``` | ||
|
|
||
| and run the following commands to enable JSON support | ||
|
|
||
| ``` | ||
| alter session set container=FREEPDB1; | ||
| grant db_developer_role to testuser; | ||
| grant soda_app to testuser; | ||
| GRANT UNLIMITED TABLESPACE TO testuser; | ||
| quit; | ||
| ``` | ||
|
|
||
| or run the commands as a script. Create a file called `soda` that contains the above commands | ||
|
|
||
| ``` | ||
| sql sys/Welcome12345@localhost:1521 as sysdba @./soda | ||
| ``` | ||
|
|
||
| ### Run Parse Server | ||
| 1. Create a config.json. This is a minimal set of [configuration parameters](https://parseplatform.org/parse-server/api/master/ParseServerOptions.html) for booting the server. The databaseURI is configured to attach to the local 23ai Oracle Database instance. | ||
|
|
||
| ``` | ||
| { | ||
| "appId": "APPLICATION_ID", | ||
| "masterKey": "MASTER_KEY", | ||
| "allowClientClassCreation": true, | ||
| "port": 1338, | ||
| "logLevel": "info", | ||
| "verbose": false, | ||
| "mountGraphQL": true, | ||
| "mountPlayground": true, | ||
| "graphQLPath": "/graphql", | ||
| "filesAdapter": { | ||
| "module": "@parse/fs-files-adapter" | ||
| }, | ||
| "databaseAdapter": { | ||
| "module": "./Storage/Oracle/OracleStorageAdapter", | ||
| "options": { | ||
| "databaseURI": "oracledb://testuser:Welcome12345@localhost:1521/freepdb1", | ||
| "collectionPrefix": "" | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| 2. Boot the Server using the Oracle Instant Client location | ||
|
|
||
| ``` | ||
| ORACLE_CLIENT_LOCATION=/Users/myuser/instantclient_23_3 npm start -- ./config.json | ||
| ``` | ||
|
|
||
| ### Test the Local Stack | ||
| 1. Run a curl command | ||
|
|
||
| ``` | ||
| curl -X POST -H "X-Parse-Application-Id: APPLICATION_ID" -H "Content-Type: application/json" -d '{"score":12,"playerName":"scooby","cheatmode":false}' http://localhost:1338/parse/classes/GameScore | ||
| ``` | ||
|
|
||
| Upon success | ||
|
|
||
| ``` | ||
| {"objectId":"CdmLJT6Duc","createdAt":"2023-10-16T19:33:27.382Z"} | ||
| ``` | ||
|
|
||
| 2. Connect to the database and verify | ||
|
|
||
| ``` | ||
| sql testuser/Welcome12345@localhost:1521/FREEPDB1 | ||
| ``` | ||
|
|
||
| 3. Run SODA commands | ||
|
|
||
| ``` | ||
| SQL> soda list | ||
| List of collections: | ||
|
|
||
| GameScore | ||
| _Hooks | ||
| _Idempotency | ||
| _Role | ||
| _SCHEMA | ||
| _User | ||
|
|
||
| SQL> soda get GameScore | ||
| KEY Created On | ||
|
|
||
| 3A8CB47A41A74F59BFDD143A3F365F4A 2023-10-16T19:33:27.404374000Z | ||
|
|
||
| 1 row selected. | ||
|
|
||
| SQL> soda get GameScore -k 3A8CB47A41A74F59BFDD143A3F365F4A | ||
|
|
||
| Key: 3A8CB47A41A74F59BFDD143A3F365F4A | ||
| Content: {"score":12,"playerName":"scooby","cheatmode":false,"updatedAt":"2023-10-16T19:33:27.382Z","createdAt":"2023-10-16T19:33:27.382Z","_id":"CdmLJT6Duc"} | ||
|
|
||
| 1 row selected. | ||
|
|
||
|
|
||
| soda help – list all soda commands | ||
|
|
||
| ``` | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Don't know if it matters but there is an official image
container-registry.oracle.com/database/free:23.5.0.0-lite-arm64