Graine

Graine is a versatile Node.js tool that simplifies the process of populating databases with test data. It allows you to generate structured and realistic data, making it an essential tool for testing and development.

Features

Hierarchical Data Generation: Graine can create complex, nested data structures with ease, including one-to-one, one-to-many, many-to-many relationships, and even deep hierarchies.
Customizable Data Templates: You can tailor the generated data to match your database schema requirements, ensuring accurate testing scenarios.
Efficiency and Speed: Graine is designed for efficiency and speed, making it suitable for projects with large-scale data seeding needs.
Cross-Framework Compatibility: It can seamlessly integrate with various databases, ORMs, and frameworks, making it a versatile choice for a wide range of projects.

Getting Started

To get started with Graine, follow these simple steps:

Installation

You can install Graine using npm or yarn:

npm install -D graine

Usage

Here's an example of how to use Graine to seed data:

const { Seeder, ref } = require('graine');
const faker = require('faker');

// Create a database writer (you can use your own database connection here)
const databaseWriter = new InMemoryDatabaseWriter();

// Initialize Seeder
const seeder = new Seeder(databaseWriter);

// Define data factories
seeder.addFactory({
  id: 'user',
  tableName: 'users',
  primaryKey: 'userID',
  provider: () => ({
    name: faker.person.firstName(),
    phone: faker.phone.imei(),
    age: faker.number.int({ min: 18, max: 60 }),
  }),
  refs: [ref('channel', 'channelID')], // one-to-many relationship with a foreign key
});

seeder.addFactory({
  id: 'channel',
  tableName: 'channels',
  primaryKey: 'channelID',
  provider: () => ({
    name: faker.word.noun(),
  }),
});

// Seed users each with different channel
await seeder.seed('user'); // seed one user, with a random channel
await seeder.seed('user'); // seed one user, with a another random channel

// Seed multiple users, with the same channel
const channelID = await seeder.seed('channel'); // seed one channel

await seeder.seed('user', { channelID }); // seed one user, with the specified channel
await seeder.seed('user', { channelID }); // seed one user, with the specified channel

This example demonstrates seeding data for user(s) and channel(s), since having a user requires a channel, we use refs to define the relationship between the two and the seeder will automatically handle the relationship. You can configure factories according to your project's needs.

Tests

Graine is thoroughly tested to ensure its reliability and functionality. You can find various test cases in the test folder, covering scenarios like one-to-one, one-to-many, many-to-many relationships, and deep hierarchies.

Contributions

We welcome contributions from the community. If you have any improvements, bug fixes, or new features to add, please open a pull request on our GitHub repository.

License

Graine is licensed under the MIT License. You can find the full license details in the LICENSE file.

Happy seeding!

halimsamy/graine