drizzle-seed 0.0.1 → 0.1.1-166fb8d

package/README.md

@@ -0,0 +1,105 @@
+# Drizzle Seed
+
+> [!NOTE]
+> `drizzle-seed` can only be used with `drizzle-orm@0.36.4` or higher. Versions lower than this may work at runtime but could have type issues and identity column issues, as this patch was introduced in `drizzle-orm@0.36.4`
+
+## Documentation
+
+The full API reference and package overview can be found in our [official documentation](https://orm.drizzle.team/docs/seed-overview)
+
+## Overview
+
+`drizzle-seed` is a TypeScript library that helps you generate deterministic, yet realistic,
+fake data to populate your database. By leveraging a seedable pseudorandom number generator (pRNG),
+it ensures that the data you generate is consistent and reproducible across different runs.
+This is especially useful for testing, development, and debugging purposes.
+
+#### What is Deterministic Data Generation?
+
+Deterministic data generation means that the same input will always produce the same output.
+In the context of `drizzle-seed`, when you initialize the library with the same seed number,
+it will generate the same sequence of fake data every time. This allows for predictable and repeatable data sets.
+
+#### Pseudorandom Number Generator (pRNG)
+
+A pseudorandom number generator is an algorithm that produces a sequence of numbers
+that approximates the properties of random numbers. However, because it's based on an initial value
+called a seed, you can control its randomness. By using the same seed, the pRNG will produce the
+same sequence of numbers, making your data generation process reproducible.
+
+#### Benefits of Using a pRNG:
+
+- Consistency: Ensures that your tests run on the same data every time.
+- Debugging: Makes it easier to reproduce and fix bugs by providing a consistent data set.
+- Collaboration: Team members can share seed numbers to work with the same data sets.
+
+With drizzle-seed, you get the best of both worlds: the ability to generate realistic fake data and the control to reproduce it whenever needed.
+
+## Getting started
+
+`npm install drizzle-seed`
+
+You have to install `drizzle-orm` in order to use `drizzle-seed`.
+
+`npm install drizzle-orm`
+
+## Basic Usage
+
+In this example we will create 10 users with random names and ids
+
+```ts {12}
+import { pgTable, integer, text } from "drizzle-orm/pg-core";
+import { drizzle } from "drizzle-orm/node-postgres";
+import { seed } from "drizzle-seed";
+
+const users = pgTable("users", {
+  id: integer().primaryKey(),
+  name: text().notNull(),
+});
+
+async function main() {
+  const db = drizzle(process.env.DATABASE_URL!);
+  await seed(db, { users });
+}
+
+main();
+```
+
+## Options
+
+**`count`**
+
+By default, the `seed` function will create 10 entities.
+However, if you need more for your tests, you can specify this in the seed options object
+
+```ts
+await seed(db, schema, { count: 1000 });
+```
+
+**`seed`**
+
+If you need a seed to generate a different set of values for all subsequent runs, you can define a different number
+in the `seed` option. Any new number will generate a unique set of values
+
+```ts
+await seed(db, schema, { seed: 12345 });
+```
+
+## Reset databases
+
+With `drizzle-seed`, you can easily reset your database and seed it with new values, for example, in your test suites
+
+```ts
+// path to a file with schema you want to reset
+import * as schema from "./schema.ts";
+import { reset } from "drizzle-seed";
+
+async function main() {
+  const db = drizzle(process.env.DATABASE_URL!);
+  await reset(db, schema);
+}
+
+main();
+```
+
+More examples are available in our [official documentation](https://orm.drizzle.team/docs/seed-overview)

package/datasets/adjectives.d.cts

@@ -0,0 +1,5 @@
+/**
+ * The original source for the Adjectives data was taken from https://www.kaggle.com/datasets/jordansiem/adjectives-list
+ */
+declare const _default: string[];
+export default _default;

package/datasets/adjectives.d.mts

@@ -0,0 +1,5 @@
+/**
+ * The original source for the Adjectives data was taken from https://www.kaggle.com/datasets/jordansiem/adjectives-list
+ */
+declare const _default: string[];
+export default _default;

package/datasets/adjectives.d.ts

@@ -0,0 +1,5 @@
+/**
+ * The original source for the Adjectives data was taken from https://www.kaggle.com/datasets/jordansiem/adjectives-list
+ */
+declare const _default: string[];
+export default _default;

package/datasets/cityNames.d.cts

@@ -0,0 +1,6 @@
+/**
+ * The original source for cities names data was taken from https://www.kaggle.com/datasets/juanmah/world-cities
+ * We've excluded a few countries and their cities from this list because we don't think they should ever appear in any list
+ */
+declare const _default: string[];
+export default _default;

package/datasets/cityNames.d.mts

@@ -0,0 +1,6 @@
+/**
+ * The original source for cities names data was taken from https://www.kaggle.com/datasets/juanmah/world-cities
+ * We've excluded a few countries and their cities from this list because we don't think they should ever appear in any list
+ */
+declare const _default: string[];
+export default _default;

package/datasets/cityNames.d.ts

@@ -0,0 +1,6 @@
+/**
+ * The original source for cities names data was taken from https://www.kaggle.com/datasets/juanmah/world-cities
+ * We've excluded a few countries and their cities from this list because we don't think they should ever appear in any list
+ */
+declare const _default: string[];
+export default _default;

package/datasets/companyNameSuffixes.d.cts

@@ -0,0 +1,2 @@
+declare const _default: string[];
+export default _default;

package/datasets/companyNameSuffixes.d.mts

@@ -0,0 +1,2 @@
+declare const _default: string[];
+export default _default;

package/datasets/companyNameSuffixes.d.ts

@@ -0,0 +1,2 @@
+declare const _default: string[];
+export default _default;

package/datasets/countries.d.cts

@@ -0,0 +1,6 @@
+/**
+ * The original source for countries data was taken from https://www.kaggle.com/datasets/manusmitajha/countrydatacsv
+ * We've excluded a few countries and their cities from this list because we don't think they should ever appear in any list
+ */
+declare const _default: string[];
+export default _default;

package/datasets/countries.d.mts

@@ -0,0 +1,6 @@
+/**
+ * The original source for countries data was taken from https://www.kaggle.com/datasets/manusmitajha/countrydatacsv
+ * We've excluded a few countries and their cities from this list because we don't think they should ever appear in any list
+ */
+declare const _default: string[];
+export default _default;

package/datasets/countries.d.ts

@@ -0,0 +1,6 @@
+/**
+ * The original source for countries data was taken from https://www.kaggle.com/datasets/manusmitajha/countrydatacsv
+ * We've excluded a few countries and their cities from this list because we don't think they should ever appear in any list
+ */
+declare const _default: string[];
+export default _default;

package/datasets/emailDomains.d.cts

@@ -0,0 +1,2 @@
+declare const _default: string[];
+export default _default;

package/datasets/emailDomains.d.mts

@@ -0,0 +1,2 @@
+declare const _default: string[];
+export default _default;

package/datasets/emailDomains.d.ts

@@ -0,0 +1,2 @@
+declare const _default: string[];
+export default _default;

package/datasets/firstNames.d.cts

@@ -0,0 +1,5 @@
+/**
+ * The original source for first names data was taken from https://www.kaggle.com/datasets/kaggle/us-baby-names?select=StateNames.csv
+ */
+declare const _default: string[];
+export default _default;

package/datasets/firstNames.d.mts

@@ -0,0 +1,5 @@
+/**
+ * The original source for first names data was taken from https://www.kaggle.com/datasets/kaggle/us-baby-names?select=StateNames.csv
+ */
+declare const _default: string[];
+export default _default;

package/datasets/firstNames.d.ts

@@ -0,0 +1,5 @@
+/**
+ * The original source for first names data was taken from https://www.kaggle.com/datasets/kaggle/us-baby-names?select=StateNames.csv
+ */
+declare const _default: string[];
+export default _default;

package/datasets/jobsTitles.d.cts

@@ -0,0 +1,5 @@
+/**
+ * The original source for the job titles data was taken from https://www.kaggle.com/datasets/ravindrasinghrana/job-description-dataset
+ */
+declare const _default: string[];
+export default _default;

package/datasets/jobsTitles.d.mts

@@ -0,0 +1,5 @@
+/**
+ * The original source for the job titles data was taken from https://www.kaggle.com/datasets/ravindrasinghrana/job-description-dataset
+ */
+declare const _default: string[];
+export default _default;

package/datasets/jobsTitles.d.ts

@@ -0,0 +1,5 @@
+/**
+ * The original source for the job titles data was taken from https://www.kaggle.com/datasets/ravindrasinghrana/job-description-dataset
+ */
+declare const _default: string[];
+export default _default;

package/datasets/lastNames.d.cts

@@ -0,0 +1,5 @@
+/**
+ * The original source for last names data was taken from https://www.kaggle.com/datasets/fivethirtyeight/fivethirtyeight-most-common-name-dataset?resource=download&select=surnames.csv
+ */
+declare const _default: string[];
+export default _default;

package/datasets/lastNames.d.mts

@@ -0,0 +1,5 @@
+/**
+ * The original source for last names data was taken from https://www.kaggle.com/datasets/fivethirtyeight/fivethirtyeight-most-common-name-dataset?resource=download&select=surnames.csv
+ */
+declare const _default: string[];
+export default _default;

package/datasets/lastNames.d.ts

@@ -0,0 +1,5 @@
+/**
+ * The original source for last names data was taken from https://www.kaggle.com/datasets/fivethirtyeight/fivethirtyeight-most-common-name-dataset?resource=download&select=surnames.csv
+ */
+declare const _default: string[];
+export default _default;

package/datasets/loremIpsumSentences.d.cts

@@ -0,0 +1,5 @@
+/**
+ * Data was generated, using https://www.lipsum.com/
+ */
+declare const _default: string[];
+export default _default;

package/datasets/loremIpsumSentences.d.mts

@@ -0,0 +1,5 @@
+/**
+ * Data was generated, using https://www.lipsum.com/
+ */
+declare const _default: string[];
+export default _default;

package/datasets/loremIpsumSentences.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Data was generated, using https://www.lipsum.com/
+ */
+declare const _default: string[];
+export default _default;

package/datasets/phonesInfo.d.cts

@@ -0,0 +1,7 @@
+/**
+ * The original source for the phones info data was taken from https://www.kaggle.com/datasets/leighplt/country-code?select=mobile_telephone_prefixes_by_country.csv
+ *
+ * Data format is: ["country prefix, operator prefix, number length including operator prefix and excluding country prefix"]
+ */
+declare const _default: string[];
+export default _default;

package/datasets/phonesInfo.d.mts

@@ -0,0 +1,7 @@
+/**
+ * The original source for the phones info data was taken from https://www.kaggle.com/datasets/leighplt/country-code?select=mobile_telephone_prefixes_by_country.csv
+ *
+ * Data format is: ["country prefix, operator prefix, number length including operator prefix and excluding country prefix"]
+ */
+declare const _default: string[];
+export default _default;

package/datasets/phonesInfo.d.ts

@@ -0,0 +1,7 @@
+/**
+ * The original source for the phones info data was taken from https://www.kaggle.com/datasets/leighplt/country-code?select=mobile_telephone_prefixes_by_country.csv
+ *
+ * Data format is: ["country prefix, operator prefix, number length including operator prefix and excluding country prefix"]
+ */
+declare const _default: string[];
+export default _default;

package/datasets/states.d.cts

@@ -0,0 +1,2 @@
+declare const _default: string[];
+export default _default;

package/datasets/states.d.mts

@@ -0,0 +1,2 @@
+declare const _default: string[];
+export default _default;

package/datasets/states.d.ts

@@ -0,0 +1,2 @@
+declare const _default: string[];
+export default _default;

package/datasets/streetSuffix.d.cts

@@ -0,0 +1,5 @@
+/**
+ * The original data was taken from the сopycat library: https://github.com/supabase-community/copycat/blob/main/src/locales/en/address/street_suffix.ts
+ */
+declare const _default: string[];
+export default _default;

package/datasets/streetSuffix.d.mts

@@ -0,0 +1,5 @@
+/**
+ * The original data was taken from the сopycat library: https://github.com/supabase-community/copycat/blob/main/src/locales/en/address/street_suffix.ts
+ */
+declare const _default: string[];
+export default _default;

package/datasets/streetSuffix.d.ts

@@ -0,0 +1,5 @@
+/**
+ * The original data was taken from the сopycat library: https://github.com/supabase-community/copycat/blob/main/src/locales/en/address/street_suffix.ts
+ */
+declare const _default: string[];
+export default _default;