Creating a Record

Use postRecord() to create a new record or update an existing record in the database.

This method takes two arguments:

• data: The content to save as key-value pairs. This can be an object literal, null, undefined, or a form SubmitEvent. After upload, the value is stored under the data key in the returned RecordData.

• config (required): Upload configuration, including table name, access group, index values, and more.

See the example below:

Form

<form onsubmit="skapi.postRecord(event, { table: { name: 'my_collection', access_group: 'public' } }).then(rec => {
    console.log(rec);
    /*
    Returns:
    {
        data: { something: 'Hello World' },
        table: { name: 'my_collection', access_group: 'public' },
        ...
    }
    */
})">
    <input name="something" placeholder="Say something" value="Hello World"/>
    <input type="submit" value="Submit" />
</form>

JS

// Data to be saved in key:value pairs
let data = {
    something: "Hello World"
}

// Configuration for the record to be uploaded
let config = {
    table: { name: 'my_collection', access_group: 'public' }
}

skapi.postRecord(data, config).then(rec=>{
    console.log(rec);
    /*
    Returns:
    {
        data: { something: "Hello World" },
        table: { name: 'my_collection', access_group: 'public' },
        ...
    }
    */
});

This example demonstrates using the postRecord() method to create a record in the database. When successful, the method returns RecordData.

In this example, the first argument is the data to upload. The value of something is saved as part of the record and appears under the data key in the returned RecordData.

In the second argument, the table name is set to my_collection and the access group is set to public. config.table is required.

Every record must include a table name. You can think of the table name as the top-level category for your data. Later, you can fetch records by table.

config.table.name validation rules:

• Maximum length: 128 characters
• Must not be empty
• Must not include /, !, *, #
• Must not include control characters or sentinel 􏿿

If the access group is public, anyone can access the uploaded data. To use different access restrictions, see Access Restrictions.

DANGER

Both authenticated and anonymous users can upload data to your service with postRecord().

Limitations for anonymous (unsigned) users:

1. They can only create records in the public access group (see Access Restrictions).
2. They cannot edit or delete any records they create.
3. They cannot create records that use Subscription features.
4. They cannot create records with Unique ID features.

You can prevent anonymous uploads by changing your service settings in the Skapi dashboard.

WARNING

When an anonymous user uploads a record, the user_id value in the returned RecordData is temporary and should not be used for user queries.

For more detailed information on all the parameters and options available with the postRecord() method, please refer to the API Reference below:

postRecord(data, config):Promise<RecordData>

Note

Skapi does not require you to predefine a database schema.

If the specified table does not exist, it will be automatically created when you create the record. Conversely, if a table has no records, it will be automatically deleted.