How could I predefine my schemas in the parse server cloud side?

xeoshow · October 7, 2021, 8:03am

Hello,

I am new to Parse Server, and now trying out the parse-server-example, I just would like to know how could I define my schemas beforehand in the cloud side, so when do the first post request via rest api, it will follow the valiadation of my schemas.

I searched docs but only found below:
https://docs.parseplatform.org/js/guide/#schema

And seems no related info for the parse-server cloud side:
https://docs.parseplatform.org/parse-server/guide/

Any one could please kindly help? Thanks a lot.

xeoshow · October 7, 2021, 8:08am

I have also found this link, adding a schema via rest api. But I just would like initialize my schemas when parse server start (also need check if the schemas already to avoid repeating adding the same schemas).
https://docs.parseplatform.org/rest/guide/#adding-a-schema

dblythy · October 8, 2021, 6:14am

Hi @xeoshow and welcome! Predefined schemas are currently not supported, however @sadortun and @Moumouls have almost finished their PR which will make this feature part of the V5 release.

github.com/parse-community/parse-server

feat: add user-defined schema and migrations

parse-community:alpha ← GoPlan-Finance:pr-migrations

opened 02:43AM - 06 Jun 21 UTC

sadortun

+1365 -36

### New Pull Request Checklist  ### Continuation of PR #7091 from @Moumouls - [x] I am not disclosing a [vulnerability](https://github.com/parse-community/parse-server/blob/master/SECURITY.md). - [x] I am creating this PR in reference to an [issue](https://github.com/parse-community/parse-server/issues?q=is%3Aissue). ### Issue Description Related issue: #7063 ### Approach Provide an easy way to add and handle schema updates and migrations for Parse-Server. ## Examples: How to use it in for Parse-server initialization : https://github.com/sadortun/GoPlan-app/blob/feat-holding-history/backend/src/server.ts#L73 How to define your schemas : https://github.com/sadortun/GoPlan-app/tree/feat-holding-history/backend/src/Migrations/schemas ### TODOs before merging  - [x] Add better logging/error managment .... - [x] Add test cases - [x] Add entry to changelog - [ ] Add changes to documentation (guides, repository pages, in-code descriptions)

xeoshow · October 8, 2021, 2:14pm

Hi Daniel,
Got it, thanks so much again for your kind help!
And another question: when will parse server V5 be released? And the V5 codebase is a big change from V4 or totally rewrite from scratch?

dblythy · October 8, 2021, 8:12pm

We are expecting V5 in the next month or so. V5 does contain some breaking changes and security improvements, but the core Parse Server will be mostly the same

github.com

parse-community/parse-server/blob/master/CHANGELOG.md

# Parse Server Changelog

Jump directly to a version:

| 4.x                                  |
|--------------------------------------|
| [**4.10.4 (latest release)**](#4104) |
| [4.10.3](#4103) |
| [4.10.2](#4102)                      |
| [4.10.1](#4101)                      |
| [4.10.0](#4100)                      |
| [4.5.2](#452)                        |
| [4.5.1](#451)                        |
| [4.5.0](#450)                        |
| [4.4.0](#440)                        |
| [4.3.0](#430)                        |
| [4.2.0](#420)                        |
| [4.1.0](#410)                        |
| [4.0.2](#402)                        |
| [4.0.1](#401)                        |

This file has been truncated. show original

xeoshow · October 9, 2021, 1:35am

Hi Daniel,
Looks like the Examples there got 404 error:

Examples:

How to use it in for Parse-server initialization :
https://github.com/sadortun/GoPlan-app/blob/feat-holding-history/backend/src/server.ts#L73

How to define your schemas :
https://github.com/sadortun/GoPlan-app/tree/feat-holding-history/backend/src/Migrations/schemas

dblythy · October 10, 2021, 11:42pm

You would have to ask @sadortun, that’s his repo

sadortun · October 11, 2021, 12:01am

Hi Guys,

Best way to get you started is to have a look at our open source project using it

You can add this to your config

github.com

GoPlan-Finance/GoPlan-app/blob/master/backend/src/server.ts#L77


      
          masterKey: config.get('parse.masterKey') as string,
          serverURL: config.get('parse.serverUrl'), // Don't forget to change to https if needed
          liveQuery: {
            classNames: [
              // List of classes to support for query subscriptions
              'Watchlist',
              'WatchlistItem',
              'AssetSymbol',
              'AssetProfile',
              'Transaction',
              'Holding',
              'AssetPrice',
              'Account',
              // '',
              // '',
            ],
          },
          schema: {
            strict: true,
            definitions: schemas,
          },

And add your schemas:

We plan to implement unique indexes soon too.

For this you’ll need to use the code from the pr_migration branch from :

Note that the master branch have other currently PRs pending review. So it’s up to you, but using the pr_migration branch is probably a bit more stable.

PLEASE OPEN ISSUES ON OUR FORK IF YOU FiND ISSUES OR HAVE SUGGESTIONS FOR THE MIGRATION PR

Enjoy!

xeoshow · October 11, 2021, 8:38am

Warm community and great thanks!

Found below schema definition part, and a further question: could it be possible that we generate the rest api document based on this schema definition with adding comments info for all fields?

So when schemas changes, we could easily resync the api doc with further details for all classes.

github.com

sadortun/GoPlan-app/blob/feat-holdings/backend/src/schema/schemas/Account.ts

import { requiresAuthentication, schema } from './base/defaults'


export default schema('Account', {
  fields: {
    createdBy : {type: 'Pointer', targetClass: '_User'},
    name      : {type: 'Object'},
    currency  : {type: 'String'},
  },
  indexes: {
    name: {name: 1},
  },
  classLevelPermissions: {
    ...requiresAuthentication([
      'find', 'get', 'count', 'update', 'create', 'delete',
    ]),

    protectedFields: {
      // '*': [
      //     'symbol',

This file has been truncated. show original

sadortun · November 1, 2021, 12:10pm

Please note the fork is now outdated. Please check the main repo for examples.

github.com

GoPlan-Finance/GoPlan-app/blob/master/backend/src/Migrations/schemas/AccountSchema.ts

import { SchemaMigrations } from 'parse-server';

export default SchemaMigrations.makeSchema('Account', {
  fields: {
    createdBy: { type: 'Pointer', targetClass: '_User' },
    name: { type: 'Object' },
    currency: { type: 'String' },
  },
  indexes: {
    name: { name: 1 },
  },
  classLevelPermissions: {
    ...SchemaMigrations.CLP.allow({
      requiresAuthentication: ['find', 'get', 'count', 'update', 'create', 'delete'],
    }),
    protectedFields: {
      // '*': [
      //     'symbol',
      // ],
    },

This file has been truncated. show original

As for docs. It’s a nice idea, feel free to submit a PR !

xeoshow · November 12, 2021, 3:10am

Hello @sadortun and community,

Just would like to know about another question : If I have already got many mangodb collections, any way to automatically generate corresponding schemas for them?

I am seriously considering migrating my project to parse server, and this is a big problem for me.

Thanks so much!

sadortun · November 12, 2021, 3:25am

Hey @xeoshow

Unfortunately, you need to create theses files manually. The good news, is that after you made the first one, creating the rest is really easy.

I migrated another app few weeks ago with ~25 schemas and it took me around an hour.

ParseServer will also give you console warnings if you set strict:true about any missing or misc configured fields.

xeoshow · November 19, 2021, 1:51am

Hi @sadortun ,

Just managed to get time to try this out, and I found there is 5.0.0-beta.3 tag (chore(release): 5.0.0-beta.3 [skip ci] · parse-community/parse-server@2923833 · GitHub) released, so could I use this latest beta version to try without using the previous pr_migration branch?

Thanks so much.

sadortun · November 19, 2021, 11:41am

Yes, it should be in the alpha/beta branch

sadortun · November 23, 2021, 4:29pm

Have you tried Google ?

xeoshow · November 24, 2021, 3:43am

Hi @sadortun ,

Sorry for the bothering, I have searched and do found below usage, along with the esm method (our old project used this).

"type": "module"

While I just do not plan to use typescript (not familar with it, and js is better for old project migration), and met below error:
a. “type”: “module”:

b. esm:

Node version is v14.16.0.

Need your futher help, thanks so much!

sadortun · November 24, 2021, 6:12am

Mmmm, Parse use Flow, which is a a thing similar to Typescript. I’m not sure in your case if you’re using the original Parse sources that include Flow.

I’m probably not the best to help you with this. It seems like an issue with project configuration, but I’m not sure.

xeoshow · November 29, 2021, 4:34am

Hi @sadortun ,

Problem resolved and seems found a bug:

For the User (_User) schema (Other external table schemas are normal), it could be added to the collection even if data is not confined to the schema (the schema strict: true):

As shown above, aaa and bbb is not defined in the schema, while the data could be added to the _User collection.

For other schemas and corresponding collections, they will get addField error response and the data could not be added.

sadortun · November 29, 2021, 10:28am

Hi!

Glad to see you got your project working !

Currently the strict:true doesn’t prevent users with permissions to create fields. But only warns to the console when there is a discrepancy.

See CPL addField if you want to block access.

In a future version, strict mode could be more severe, but this willl be up for discussions in a later release.

xeoshow · November 29, 2021, 2:33pm

Got it and thank you v much!