Skip to main content

CRUD Operations without Model Registration

note

While registering models with CollectModel provides strong TypeScript support and a clear structure, you can also perform CRUD operations directly using the CollectRestAPI methods in the Collect class. This approach allows you to interact with your data without predefining models, offering flexibility for quick operations or dynamic use cases.

Creating Records without Model Registration​

The create method allows you to create a single record without registering a model.

Example​

Creating an author record directly:

const newAuthor = await Collect.records.create('author', {
  name: 'Alice Smith',
  email: 'alice.smith@example.com',
  jobTitle: 'writer',
  age: 28,
  married: true,
  dateOfBirth: '1993-05-15T00:00:00Z'
});

Reading Records without Model Registration​

The find, findOne, and findById methods let you read records from the database without predefining models.

Example​

Finding records with specific criteria:

const authors = await Collect.records.find('author', {
    where: {
        jobTitle: { $contains: 'writer' },
        age: { $gte: 25 }
    }
});

Example​

Finding a single record:

const author = await Collect.records.findOne('author', {
    where: {
        email: { $contains: 'alice.smith@example.com' }
    }
});

Updating Records without Model Registration​

You can update records using the update method, which allows for modifications without registered models.

Example​

Updating a record directly:

const author = await Collect.records.findOne('author', {
    where: {
        email: { $contains: 'alice.smith@example.com' }
    }
});

await Collect.records.update(author.data.__id, {
  jobTitle: 'senior writer'
});

Deleting Records without Model Registration​

The delete and deleteById methods enable you to remove records from the database without using registered models.

Example​

Deleting records with specific criteria:

await Collect.records.delete('author', {
  where: {
    jobTitle: { $contains: 'writer' }
  }
});

Example​

Deleting records by ID:

await Collect.records.deleteById('author', ['author_id_1', 'author_id_2']);

Conclusion​

Using the CollectRestAPI methods in the Collect class provides a flexible way to perform CRUD operations without registering models. This approach is particularly useful for dynamic or ad-hoc operations, offering a straightforward way to interact with your data.