Skip to main content

Creating and Retrieving Records with the SDK

In this section, we'll learn how to use the Collect SDK to create and retrieve simple data records. This guide assumes you have already initialized the SDK and obtained an API token as described in the previous sections. Here, we'll focus on utilizing the SDK to interact with your data, demonstrating how to define a data model, create a record, and then fetch it back.

Objective​

The goal of this section is to familiarize you with the basics of creating and retrieving data using the Collect SDK. While the examples provided are agnostic and can be adapted to your specific library/framework, they serve as a foundation for understanding how to work with Collect data models and records.

Prerequisites​

Ensure that you have initialized the Collect SDK in your project as follows:

import CollectSDK from '@collect.so/javascript-sdk';
const COLLECT_SDK_TOKEN = 'Your SDK token'

const Collect = new CollectSDK(
    COLLECT_SDK_TOKEN
);

Replace COLLECT_SDK_TOKEN with your actual API token.

Defining a Data Model​

First, let's define a data model for a user. This model will specify the structure of the user records we intend to create and retrieve:

import { CollectModel } from '@collect.so/javascript-sdk';

// Helper function to generate random numbers for ID
const asyncRandomNumber = async () => Math.floor(Math.random() * 10000);

const User = new CollectModel('user', {
  name: { type: 'string' },
  email: { type: 'string', uniq: true },
  id: { type: 'number', default: asyncRandomNumber },
  jobTitle: { type: 'string' },
  age: { type: 'number' },
  married: { type: 'boolean' },
  dateOfBirth: { type: 'datetime', default: () => new Date().toISOString() }
});

export const UserRepo = Collect.registerModel(User);

Creating a User Record​

With our User model defined, we can now create a user record. Here's an example payload for creating a user:

const payload = {
    name: 'Jane Doe',
    email: 'jane.doe@example.com',
    id: await asyncRandomNumber(),
    jobTitle: 'Developer',
    age: 28,
    married: false,
    dateOfBirth: '1992-05-15'
};

await UserRepo.create(payload);

Retrieving User Records​

After creating users, you may want to fetch them back. Use the find method to retrieve a list of all users:

const users = await UserRepo.find();
console.log(users);

This simple flow demonstrates how to create and retrieve records using the Collect SDK. By defining models and utilizing the SDK's methods, you can easily manage your application's data. Feel free to adapt these examples to fit the specific needs of your project.