@pgpm/faker 0.4.0 → 0.6.0

package/Makefile

@@ -1,5 +1,5 @@
 EXTENSION = launchql-faker
-DATA = sql/launchql-faker--0.4.6.sql
+DATA = sql/launchql-faker--0.5.0.sql
 
 PG_CONFIG = pg_config
 PGXS := $(shell $(PG_CONFIG) --pgxs)

package/README.md

@@ -2,7 +2,73 @@
 
 create fake data in PostgreSQL
 
-# Usage
+## Overview
+
+`@pgpm/faker` provides a comprehensive set of fake data generation functions directly in PostgreSQL. Perfect for seeding test databases, creating demo data, and development environments. All functions are implemented in pure plpgsql and return realistic-looking data without external dependencies.
+
+## Features
+
+- **Geographic Data**: Latitude/longitude coordinates, addresses by state
+- **Text Generation**: Sentences, paragraphs, tags, names
+- **Temporal Data**: Random timestamps, dates, intervals
+- **Numeric Data**: Random integers and floats
+- **Contact Information**: Email, phone, IP addresses
+- **File & Media**: URLs, images, profile pictures, attachments
+- **Business Data**: Company names, usernames, tokens
+- **State-Aware**: Filter data by US state codes
+- **Pure plpgsql**: No external dependencies required
+
+## Installation
+
+If you have `pgpm` installed:
+
+```bash
+pgpm install @pgpm/faker
+pgpm deploy
+```
+
+This is a quick way to get started. The sections below provide more detailed installation options.
+
+### Prerequisites
+
+```bash
+# Install pgpm globally
+npm install -g pgpm
+
+# Start PostgreSQL
+pgpm docker start
+
+# Set environment variables
+eval "$(pgpm env)"
+```
+
+### Deploy
+
+#### Option 1: Deploy by installing with pgpm
+
+```bash
+pgpm install @pgpm/faker
+pgpm deploy
+```
+
+#### Option 2: Deploy from Package Directory
+
+```bash
+cd packages/utils/faker
+pgpm deploy --createdb
+```
+
+#### Option 3: Deploy from Workspace Root
+
+```bash
+# Install workspace dependencies
+pnpm install
+
+# Deploy with dependencies
+pgpm deploy mydb1 --yes --createdb
+```
+
+## Usage
 
 ## state, city, zip
 
@@ -368,7 +434,79 @@ select faker.lnglat();
 -- (-74.0205,40.316)
 ```
 
-# Development
+## Use Cases
+
+### Seeding Test Databases
+
+Generate realistic test data for development:
+
+```sql
+-- Create test users with fake data
+INSERT INTO users (name, email, created_at)
+SELECT 
+  faker.fullname(),
+  faker.email(),
+  faker.timestamptz()
+FROM generate_series(1, 100);
+```
+
+### Geographic Testing
+
+Test location-based features:
+
+```sql
+-- Create test locations with coordinates
+INSERT INTO locations (lat, lng, address)
+SELECT 
+  (faker.lnglat()).lat,
+  (faker.lnglat()).lng,
+  faker.address()
+FROM generate_series(1, 50);
+```
+
+### Content Generation
+
+Generate fake content for testing:
+
+```sql
+-- Create blog posts
+INSERT INTO posts (title, content, tags, published_at)
+SELECT 
+  faker.word() || ' ' || faker.word(),
+  faker.paragraph(),
+  faker.tags(),
+  faker.timestamptz()
+FROM generate_series(1, 100);
+```
+
+### Demo Data
+
+Create realistic demo data for presentations:
+
+```sql
+-- E-commerce orders
+INSERT INTO orders (customer_name, phone, total, order_date)
+SELECT 
+  faker.fullname(),
+  faker.phone(),
+  faker.float(10, 1000),
+  faker.date()
+FROM generate_series(1, 1000);
+```
+
+## Testing
+
+```bash
+pnpm test
+```
+
+## Dependencies
+
+None - this is a pure plpgsql implementation.
+
+---
+
+## Development
 
 ## start the postgres db process
 
@@ -409,30 +547,110 @@ yarn test:watch
 Create a new folder in `packages/`
 
 ```sh
-lql init
+pgpm init
 ```
 
 Then, run a generator:
 
 ```sh
-lql generate
+pgpm generate
 ```
 
 You can also add arguments if you already know what you want to do:
 
 ```sh
-lql generate schema --schema myschema
-lql generate table --schema myschema --table mytable
+pgpm generate schema --schema myschema
+pgpm generate table --schema myschema --table mytable
 ```
 
 ## deploy code as extensions
 
-`cd` into `packages/<module>`, and run `lql package`. This will make an sql file in `packages/<module>/sql/` used for `CREATE EXTENSION` calls to install your sqitch module as an extension.
+`cd` into `packages/<module>`, and run `pgpm package`. This will make an sql file in `packages/<module>/sql/` used for `CREATE EXTENSION` calls to install your sqitch module as an extension.
 
 ## recursive deploy
 
 You can also deploy all modules utilizing versioning as sqtich modules. Remove `--createdb` if you already created your db:
 
 ```sh
-lql deploy awesome-db --yes --recursive --createdb
+pgpm deploy mydb1 --yes --createdb
 ```
+
+---
+
+### **Before You Begin**
+
+```bash
+# 1. Install pgpm
+npm install -g pgpm
+
+# 2. Start Postgres (Docker or local)
+pgpm docker start
+
+# 3. Load PG* environment variables (PGHOST, PGUSER, ...)
+eval "$(pgpm env)"
+```
+
+---
+
+### **Starting a New Project**
+
+```bash
+# 1. Create a workspace
+pgpm init --workspace
+cd my-app
+
+# 2. Create your first module
+pgpm init
+
+# 3. Add a migration
+pgpm add some_change
+
+# 4. Deploy (auto-creates database)
+pgpm deploy --createdb
+```
+
+---
+
+### **Working With an Existing Project**
+
+```bash
+# 1. Clone and enter the project
+git clone <repo> && cd <project>
+
+# 2. Install dependencies
+pnpm install
+
+# 3. Deploy locally
+pgpm deploy --createdb
+```
+
+---
+
+### **Testing a Module Inside a Workspace**
+
+```bash
+# 1. Install workspace deps
+pnpm install
+
+# 2. Enter the module directory
+cd packages/<some-module>
+
+# 3. Run tests in watch mode
+pnpm test:watch
+```
+
+## Related Tooling
+
+* [pgpm](https://github.com/launchql/launchql/tree/main/packages/pgpm): **🖥️ PostgreSQL Package Manager** for modular Postgres development. Works with database workspaces, scaffolding, migrations, seeding, and installing database packages.
+* [pgsql-test](https://github.com/launchql/launchql/tree/main/packages/pgsql-test): **📊 Isolated testing environments** with per-test transaction rollbacks—ideal for integration tests, complex migrations, and RLS simulation.
+* [supabase-test](https://github.com/launchql/launchql/tree/main/packages/supabase-test): **🧪 Supabase-native test harness** preconfigured for the local Supabase stack—per-test rollbacks, JWT/role context helpers, and CI/GitHub Actions ready.
+* [graphile-test](https://github.com/launchql/launchql/tree/main/packages/graphile-test): **🔐 Authentication mocking** for Graphile-focused test helpers and emulating row-level security contexts.
+* [pgsql-parser](https://github.com/launchql/pgsql-parser): **🔄 SQL conversion engine** that interprets and converts PostgreSQL syntax.
+* [libpg-query-node](https://github.com/launchql/libpg-query-node): **🌉 Node.js bindings** for `libpg_query`, converting SQL into parse trees.
+* [pg-proto-parser](https://github.com/launchql/pg-proto-parser): **📦 Protobuf parser** for parsing PostgreSQL Protocol Buffers definitions to generate TypeScript interfaces, utility functions, and JSON mappings for enums.
+
+## Disclaimer
+
+AS DESCRIBED IN THE LICENSES, THE SOFTWARE IS PROVIDED "AS IS", AT YOUR OWN RISK, AND WITHOUT WARRANTIES OF ANY KIND.
+
+No developer or entity involved in creating this software will be liable for any claims or damages whatsoever associated with your use, inability to use, or your interaction with other users of the code, including any direct, indirect, incidental, special, exemplary, punitive or consequential damages, or loss of profits, cryptocurrencies, tokens, or anything else of value.

package/launchql-faker.control

@@ -1,6 +1,6 @@
 # launchql-faker extension
 comment = 'launchql-faker extension'
-default_version = '0.4.6'
+default_version = '0.5.0'
 module_pathname = '$libdir/launchql-faker'
 requires = 'citext,pgcrypto,plpgsql,uuid-ossp,launchql-types,launchql-verify'
 relocatable = false

package/package.json

@@ -1,29 +1,29 @@
 {
   "name": "@pgpm/faker",
-  "version": "0.4.0",
+  "version": "0.6.0",
   "description": "Fake data generation utilities for testing and development",
   "publishConfig": {
     "access": "public"
   },
   "scripts": {
-    "bundle": "lql package",
+    "bundle": "pgpm package",
     "test": "jest",
     "test:watch": "jest --watch"
   },
   "dependencies": {
-    "@pgpm/types": "0.4.0",
-    "@pgpm/verify": "0.4.0"
+    "@pgpm/types": "0.6.0",
+    "@pgpm/verify": "0.6.0"
   },
   "devDependencies": {
-    "@launchql/cli": "^4.9.0"
+    "pgpm": "^0.2.0"
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/launchql/extensions"
+    "url": "https://github.com/launchql/pgpm-modules"
   },
-  "homepage": "https://github.com/launchql/extensions",
+  "homepage": "https://github.com/launchql/pgpm-modules",
   "bugs": {
-    "url": "https://github.com/launchql/extensions/issues"
+    "url": "https://github.com/launchql/pgpm-modules/issues"
   },
-  "gitHead": "cc9f52a335caa6e21ee7751b04b77c84ce6cb809"
+  "gitHead": "c7d0eae588d7a764b382a330c8b853b341b13fb2"
 }