# node-sql-fixtures

**Repository Path**: mirrors_mikehostetler/node-sql-fixtures

## Basic Information

- **Project Name**: node-sql-fixtures
- **Description**: SQL fixtures for Node.js in PostgreSQL, MySQL, MariaDB and SQLite
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-09-25
- **Last Updated**: 2026-03-22

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# sql-fixtures

Easily generate data that gets saved in the database, with foreign key dependencies automatically resolved. Ideal for integration tests and generating dummy data. Uses [knex](http://knexjs.org) internally.

# Supported Databases

| Database  | Works?   | As of version | Integration Tests? | Usage                                      |
|-----------|----------|---------------|--------------------|--------------------------------------------|
| Postgres  | Yes      | 0.0.0         | [Yes](https://github.com/city41/node-sql-fixtures/blob/master/test/integration/postgres-integration-spec.js) | several projects known   |
| MySQL     | Yes | 0.4.0         | [Yes](https://github.com/city41/node-sql-fixtures/blob/master/test/integration/mysql-integration-spec.js) | several projects known |
| sqlite3   | Yes | 0.3.0         | [Yes](https://github.com/city41/node-sql-fixtures/blob/master/test/integration/sqlite-integration-spec.js) | one known project |
| MariaDB   | Yes  | 0.7.0   | [Yes](https://github.com/city41/node-sql-fixtures/blob/master/test/integration/maria-integration-spec.js) | no known projects :( |

# Install

`npm install sql-fixtures`

# Simple Example

```javascript
var sqlFixtures = require('sql-fixtures');

// depending on which database engine you are using
// this is a typical PostgreSQL config for the pg driver
var dbConfig = {
  client: 'pg',
  connection: {
    host: 'localhost',
    user: 'testdb',
    password: 'password',
    database: 'testdb',
    port: 15432
  }
};

var dataSpec = {
  users: {
    username: 'Bob',
    email: 'bob@example.com'
  }
};

sqlFixtures.create(dbConfig, dataSpec, function(err, result) {
  // at this point a row has been added to the users table
  console.log(result.users[0].username);
});
```

# Documentation and Examples

Are available at the [sql-fixtures website](http://city41.github.io/node-sql-fixtures)

# Contributing
Please fork and send pull requests in the typical fashion.

There are both unit and integration tests. The unit tests are invoked with `gulp test:unit`.

Checkout integration_tests.md for the scoop on the integration tests.

# Road to 1.0.0

These things remain to accomplish "one point oh"

* better error reporting when a dependency can't be resolved
* MySQL, Maria and SQLite can fail in some unusual scenarios due to the way they do inserts. Finding a solid fix for this would be good. So far the fixes just minimize the number of broken use cases, but there are is still at least one broken scenario lurking.