status-im
/
realm-js
mirror of https://github.com/status-im/realm-js.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

Update README with new Schema API

This commit is contained in:
Scott Kyle 2016-01-04 15:58:16 -08:00
parent 676849a338
commit 2a7c336ba9
1 changed files with 18 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
README.md
View File

@ -28,12 +28,12 @@ const Realm = require('realm');
const personSchema = { const personSchema = {
name: 'Person', name: 'Person',
primaryKey: 'name', primaryKey: 'name',
properties: [ properties: {
{name: 'name', type: Realm.Types.STRING}, name': 'string',
{name: 'birthday', type: Realm.Types.DATE}, birthday: 'date',
{name: 'friends', type: Realm.Types.LIST, objectType: 'Person'}, friends: {type: 'list', objectType: 'Person'},
{name: 'points', type: Realm.Types.INT, default: 0}, points: {type: 'int', default: 0},
], },
}; };
const realm = new Realm({schema: [personSchema]}); const realm = new Realm({schema: [personSchema]});
@ -101,27 +101,28 @@ The `realmConfig` passed to the constructor can contain the following:
### ObjectSchema ### ObjectSchema
- `name` – string used to refer to this object type - `name` – string used to refer to this object type
- `properties` - array of property defitions (see below) - `properties` - object with property definitions (see below)
- `primaryKey` – optional - name of `STRING` or `INT` property that should be unique - `primaryKey` – optional - name of `STRING` or `INT` property that should be unique
### Property Types ### Property Types
When definining object `properties` in a `schema`, each should have a unique `name`, and the `type` of each property must be defined as either the name of an object type in the same schema **or** as one of the following: When defining object `properties` in a `schema`, the value for each property must either be the `type` **OR** an object with a `type` key along with other options detailed below. The `type` of each property must be defined as either the name of an object type in the same schema **or** as one of the following:
- `Realm.Types.BOOL` - `Realm.Types.BOOL` (`"bool"`)
- `Realm.Types.INT` - `Realm.Types.INT` (`"int"`)
- `Realm.Types.FLOAT` - `Realm.Types.FLOAT` (`"float"`)
- `Realm.Types.DOUBLE` - `Realm.Types.DOUBLE` (`"double"`)
- `Realm.Types.STRING` - `Realm.Types.STRING` (`"string"`)
- `Realm.Types.DATE` - `Realm.Types.DATE` (`"date"`)
- `Realm.Types.DATA` - `Realm.Types.DATA` (`"data"`)
- `Realm.Types.OBJECT` (requires `objectType`, is always `optional`) - `Realm.Types.LIST` (`"list"` – requires `objectType` and cannot be `optional`)
- `Realm.Types.LIST` (requires `objectType`, is never `optional`)
You _may_ specify these property options as well: You _may_ specify these property options as well:
- `default` – default value when property was not specified on creation - `default` – default value when property was not specified on creation
- `optional` – boolean indicating if this property may be assigned `null` or `undefined` - `optional` – boolean indicating if this property may be assigned `null` or `undefined`
**Note:** When the `type` of a property is that of an object type in the same schema, it _always_ will be `optional`.
### `Realm` Instance Methods ### `Realm` Instance Methods
#### `create(type, props [, update])` #### `create(type, props [, update])`
- `type` – string matching object `name` in the `schema` definition - `type` – string matching object `name` in the `schema` definition