🚀 Herramienta CLI avanzada para gestionar esquemas GraphQL y base de datos de manera sincronizada
📖 Documentación • ⚡ Inicio Rápido • 🎯 Características • 📊 Ejemplos
GraphQLStore CLI es una herramienta de línea de comandos profesional que automatiza la gestión de bases de datos MySQL a partir de esquemas GraphQL. Transforma definiciones GraphQL en estructuras de base de datos completamente funcionales con soporte para relaciones complejas, migraciones automáticas y visualización rica.
| Comando | Descripción | Estado |
|---|---|---|
conexion | Configurar conexión a base de datos MySQL | ✅ |
probar-conexion | Verificar conectividad y diagnósticos | ✅ |
inicializar | Crear base de datos desde esquema GraphQL | ✅ |
migracion | Evolucionar esquemas existentes | ✅ |
server | Genera una estructura de un servidor GraphQL de pruebas en JavaScript | ✅ |
| GraphQL | MySQL | Características |
|---|---|---|
ID | VARCHAR(25) | Primary keys automáticos |
String | VARCHAR(255) | Soporte UTF-8 completo |
Int | INT | Enteros |
Boolean | BOOLEAN | Valores true/false |
DateTime | DATETIME | Timestamps con @createdAt/@updatedAt |
Float | DECIMAL(10,2) | Precisión decimal |
JSON | JSON | Objetos complejos nativos |
[] | JSON | Listas de valores |
Enum | ENUM(...) | Enumeraciones tipo-seguras |
! | NOT NULL | Validación de campos obligatorios |
sin ! | NULL | Campos opcionales |
| Directiva | Descripción | Argumentos |
|---|---|---|
@id | Define un campo como clave primaria | Ninguno |
@unique | Asegura que el campo sea único | Ninguno |
@default | Establece un valor por defecto para el campo | value |
@db | Renombra el campo en la base de datos | rename |
@protected | Oculta el campo en el esquema cliente | Ninguno |
@relation | Define relaciones entre tipos | name, type, onDelete |
@createdAt | Marca el campo con la fecha de creación | Ninguno |
@updatedAt | Marca el campo con la fecha de actualización | Ninguno |
La directiva @id define un campo como clave primaria en la base de datos:
Sintaxis:
id: ID! @id
Ejemplo:
type User {
id: ID! @id
nombre: String!
}
SQL generado:
CREATE TABLE User (
id VARCHAR(25) NOT NULL PRIMARY KEY,
nombre VARCHAR(255) NOT NULL
);
La directiva @unique asegura que un campo de tipo escalar tenga valores únicos en la base de datos:
Sintaxis:
campo: Tipo! @unique
La directiva @default permite establecer valores por defecto para campos escalares:
Sintaxis:
campo: Tipo! @default(value: "valor_por_defecto")
Ejemplos:
type User {
active: Boolean! @default(value: "true")
age: Int! @default(value: 18)
role: UserRole! @default(value: "ADMIN")
}
SQL generado:
CREATE TABLE User (
active BOOLEAN NOT NULL DEFAULT true,
age INT NOT NULL DEFAULT 18,
role ENUM('ADMIN', 'AUTHOR', 'USER') NOT NULL DEFAULT 'ADMIN'
);
La directiva @db permite usar nombres diferentes entre GraphQL y la base de datos:
Sintaxis:
campo: Tipo! @db(rename: "nombre_columna_sql")
Ejemplos:
type User {
fullName: String! @db(rename: "full_name")
email: String! @db(rename: "email_address")
phone: String @db(rename: "phone_number")
}
SQL generado:
CREATE TABLE User (
full_name VARCHAR(255) NOT NULL,
email_address VARCHAR(255) NOT NULL,
phone_number VARCHAR(255)
);
La directiva @relation gestiona relaciones complejas entre tipos con control granular:
Sintaxis:
campo: [Tipo] @relation(name: "NombreRelacion", type: TIPO_RELACION, onDelete: ACCION)
Argumentos:
name: Nombre único de la relación (requerido para toda relacion)type: Tipo de relación física
INLINE: Opcional para relaciones 1:1 y 1:N (clave foránea)TABLA: Requerido para relaciones N:M (tabla intermedia)onDelete: Acción al eliminar registro padre
CASCADE: Eliminación en cascada (elimina registros hijos)SET_NULL: Establece NULL en registros hijos (no elimina)Ejemplos de relaciones 1:N con INLINE:
type User {
id: ID! @id
email: String! @unique
posts: [Post] @relation(name: "UserPosts")
}
type Post {
id: ID! @id
title: String!
author: User! @relation(name: "UserPosts", onDelete: CASCADE)
}
SQL generado para 1:N:
-- Tabla User
CREATE TABLE User (
id VARCHAR(25) NOT NULL PRIMARY KEY,
email VARCHAR(255) NOT NULL UNIQUE
);
-- Tabla Post con clave foránea
CREATE TABLE Post (
id VARCHAR(25) NOT NULL PRIMARY KEY,
author_id VARCHAR(25) NOT NULL,
FOREIGN KEY (author_id) REFERENCES User(id) ON DELETE CASCADE
);
Ejemplos de relaciones N:M con TABLA:
type Post {
id: ID! @id
title: String!
tags: [Tag] @relation(name: "PostTags", type: TABLA, onDelete: CASCADE)
}
type Tag {
id: ID! @id
name: String! @unique
posts: [Post] @relation(name: "PostTags", type: TABLA, onDelete: CASCADE)
}
SQL generado para N:M:
-- Tabla Post
CREATE TABLE Post (
id VARCHAR(25) NOT NULL PRIMARY KEY,
title VARCHAR(255) NOT NULL
);
-- Tabla Tag
CREATE TABLE Tag (
id VARCHAR(25) NOT NULL PRIMARY KEY,
name VARCHAR(255) NOT NULL UNIQUE
);
-- Tabla intermedia PostTags
CREATE TABLE PostTags (
post_id VARCHAR(25) NOT NULL,
tag_id VARCHAR(25) NOT NULL,
PRIMARY KEY (post_id, tag_id),
FOREIGN KEY (post_id) REFERENCES Post(id) ON DELETE CASCADE,
FOREIGN KEY (tag_id) REFERENCES Tag(id) ON DELETE CASCADE
);
pip install graphqlstore
git clone https://github.com/your-username/graphqlstore.git
cd graphqlstore
pipenv install --dev
# Configuración interactiva
graphqlstore conexion
# O con parámetros directos
graphqlstore conexion \
--host localhost \
--puerto 3306 \
--usuario admin \
--password secret \
--base-datos mi_app
graphqlstore probar-conexion --verbose
type User {
id: ID! @id
username: String!
email: String! @unique
}
# Desde archivo específico
# NOTA: Es necesario indicar el esquema si hay varios archivos .graphql
# en el directorio actual
graphqlstore inicializar --esquema schema.graphql
# Detección automática
graphqlstore inicializar
# Migración automática
# NOTA: Es necesario indicar el esquema si hay varios archivos .graphql
# en el directorio actual
graphqlstore migracion --esquema schema.graphql
NOTA: SI DESEAS COMPROBAR O INTEGRAR LA HERRAMIENTA EN BACKEND CON ARQUITECTURA GRAPHQL, SERA NECESARIO EJECUTAR PRIMERO graphqlstore servidor PARA GENERAR LA ESTRUCTURA DEL SERVIDOR.
graphqlstore servidor
PARA MAYOR INFORMACIÓN SOBRE EL COMANDO servidor, CONSULTE LA DOCUMENTACIÓN DEL COMANDO servidor.
scalar Json
scalar DateTime
type User {
id: ID! @id
username: String! @unique
email: String! @unique
role: UserRole!
posts: [Post!]! @relation(name: "UserPosts")
profile: Profile @relation(name: "UserProfile")
createdAt: DateTime @createdAt
updatedAt: DateTime @updatedAt
}
type Post {
id: ID! @id
title: String!
content: String
published: Boolean! @default(value: "false")
tags: [String!]!
author: User! @relation(name: "UserPosts", onDelete: CASCADE)
createdAt: DateTime @createdAt
}
type Profile {
id: ID! @id
bio: String
avatar: String
user: User! @relation(name: "UserProfile", onDelete: CASCADE)
}
enum UserRole {
ADMIN
AUTHOR
USER
}
-- Tabla User con constraints
CREATE TABLE User (
`id` VARCHAR(25) NOT NULL PRIMARY KEY,
`username` VARCHAR(255) NOT NULL,
`email` VARCHAR(255) NOT NULL,
`role` ENUM('ADMIN','AUTHOR','USER') NOT NULL,
`createdAt` DATETIME DEFAULT CURRENT_TIMESTAMP,
`updatedAt` DATETIME DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
UNIQUE KEY `uk_username` (`username`),
UNIQUE KEY `uk_email` (`email`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;
-- Relaciones con foreign keys
ALTER TABLE `Post`
ADD COLUMN `author_id` VARCHAR(25) NOT NULL,
ADD CONSTRAINT `fk_User_posts_Post` FOREIGN KEY (`author_id`)
REFERENCES `User`(id) ON DELETE CASCADE;
ALTER TABLE `Profile`
ADD COLUMN `user_id` VARCHAR(25) UNIQUE,
ADD CONSTRAINT `fk_User_profile_Profile` FOREIGN KEY (`user_id`)
REFERENCES `User`(id) ON DELETE CASCADE;
GraphQLStore CLI v3.0.0
Desplegando servicio
📋 Diferencias detectadas
├── ➕ Tablas agregadas: 1
├── 🔹 Campos agregados: 3
└── 🔗 Relaciones agregadas: 2
🔧 CREAR TABLA
├── Creando tabla Profile
🔧 AGREGAR RELACIÓN
├── Agregando relación UserProfile
✅ Migración generada exitosamente
📊 Total de sentencias SQL: 5
graphqlstore/
├── 📂 source/cli/
│ ├── 🔌 conexion/ # Gestión de configuración BD
│ ├── 🩺 probar_conexion/ # Diagnósticos y validación
│ ├── 🚀 inicializar/ # Inicialización de esquemas
│ ├── 📈 migracion/ # Sistema de migraciones
│ ├── 🔍 graphql/ # Motor GraphQL
│ │ ├── parser.py # Parser de esquemas
│ │ ├── mysql_generador.py # Generador SQL
│ │ ├── mysql_migracion.py # Motor de migraciones
│ │ └── procesar_relaciones.py # Procesador de relaciones
│ ├── 🗄️ database/ # Adaptadores de BD
│ └── 🛠️ utilidades/ # Herramientas auxiliares
├── 📂 tests/ # Suite de pruebas (97% cobertura)
└── 📂 .github/workflows/ # CI/CD automatizado
├── 📄 README.md # Documentación principal
├── 📄 LICENSE # Licencia del proyecto
├── 📄 setup.py # Configuración del paquete
├── 📄 requirements.txt # Dependencias del proyecto
├── 📄 requirements-dev.txt # Dependencias de desarrollo
├── 📄 .pre-commit-config.yaml # Configuración de pre-commit
├── 📄 Pipfile # Gestión de dependencias con Pipenv
├── 📄 pyproject.toml # Configuración del proyecto
├── 📄 .pylintrc # Configuración de pylint
source/cli/graphql/docs/parser.md)source/cli/graphql/docs/procesar_relaciones.md)source/cli/graphql/docs/mysql_generador.md)source/cli/graphql/docs/mysql_migracion.md)| Herramienta | Propósito | Estado |
|---|---|---|
| pytest | Testing framework | ✅ 97% cobertura |
| black | Formateo de código | ✅ Configurado |
| flake8 | Linting (ligero) | ✅ Configurado |
| pylint | Linting (exhausto) | ✅ Configurado |
| mypy | Type checking | ✅ Configurado |
| pre-commit | Git hooks | ✅ Configurado |
| Módulo | Statements | Miss | Branch | BrPart | Cover |
|---|---|---|---|---|---|
| Parser GraphQL | 67 | 1 | 18 | 1 | 98% |
| Procesador Relaciones | 96 | 4 | 38 | 6 | 93% |
| Generador MySQL | 237 | 5 | 94 | 11 | 95% |
| Sistema Migraciones | 396 | 17 | 208 | 23 | 93% |
| Comandos CLI | 271 | 11 | 52 | 3 | 100% |
| 🎯 TOTAL PROYECTO | 3113 | 57 | 472 | 49 | 🏆 97% |
.github/workflows/ci.yml)🔄 Flujo de Integración Continua:
📋 Entrada (Push/PR)
↓
🔧 Instalación de Dependencias
↓
🎯 Pre-commit Hooks
├── ⚫ Black (Formateo)
├── 🔍 Flake8 (Linting ligero)
├── 📋 Pylint (Análisis exhaustivo)
└── 🔤 Mypy (Type checking)
↓
🧪 Testing Suite + Cobertura
↓
✅ Pipeline Completo
| Etapa | Proceso | Estado |
|---|---|---|
| 🔧 Setup | Instalación de dependencias | ✅ |
| 🎯 Quality | Pre-commit hooks completos | ✅ |
| ⚫ Black | Formateo automático de código | ✅ |
| 🔍 Flake8 | Linting ligero y rápido | ✅ |
| 📋 Pylint | Análisis exhaustivo de código | ✅ |
| 🔤 Mypy | Verificación estática de tipos | ✅ |
| 🧪 Testing | Suite completa con cobertura | ✅ |
.github/workflows/cd.yml)📦 Flujo de Despliegue Continuo:
🏷️ Release Tag
↓
🛠️ Configuración Build Tools
↓
📦 Empaquetado Multi-formato
├── 🎯 Wheel Distribution
└── 📄 Source Distribution
↓
🚀 Publicación PyPI
↓
📋 GitHub Release + Artifacts
↓
✅ Deploy Completo
| Etapa | Proceso | Descripción |
|---|---|---|
| 🛠️ Setup | Configuración de herramientas | Preparación del entorno de build |
| 📦 Build | Empaquetado multi-formato | Wheel + Source distributions |
| 🎯 Wheel | Distribución binaria | Instalación rápida optimizada |
| 📄 Source | Distribución de código fuente | Máxima compatibilidad |
| 🚀 PyPI | Publicación automática | Deploy en nuevas versiones |
| 📋 GitHub | Release + artifacts | Documentación y archivos |
push, pull_request → mainrelease → published → PyPI + GitHub Release| Versión | Estado | Características |
|---|---|---|
| v0.x.0 | ✅ | Despligue funcionamiento correcto |
| v1.0.0 | ✅ | Core completo |
| v2.0.0 | ✅ | Directivas avanzadas |
| v3.0.0 | ✅ | Generador de servidor GraphQL en JavaScript |
| v3.x.0 | 🎯 Actual | Bugs, mejoras y documentación |
conexion - Configuración de base de datosprobar-conexion - Diagnósticos y validación de base de datosinicializar - Inicialización de esquemasmigracion - Sistema de migracionesservidor - Generador de servidor GraphQL en JavaScript# Inicialización completa de proyecto
graphqlstore conexion
graphqlstore inicializar
# ✅ Base de datos lista para desarrollo
# Migración automática
graphqlstore migracion
# ✅ Esquema actualizado preservando datos (de tablas y relaciones existentes)
# Modo silencioso para pipelines
graphqlstore migracion \
--esquema schemas/production.graphql \
--no-visualizar-salida \
--no-visualizar-sql
conexion - Configuración de conexión a MySQLprobar-conexion - Verificación de conectividadinicializar - Inicialización de base de datos desde esquema GraphQLmigracion - Sistema de migraciones automático@unique - Campos únicos@default - Valores por defecto@db - Renombrado de campos@protected - Campos protegidosserver - Genera estructura de servidor GraphQL en JavaScriptservidorGeneradorEsquemaMySQL y GenerarMigracionMySQL implementando patrones de diseño para escalar el codigo y mejorar la mantenibilidad, sobre todo para implementar la funcionalidad multi-base de datos.Este proyecto utiliza una Licencia Privada que prohíbe:
Ver LICENSE para detalles completos.
📧 ¿Preguntas? • 🐛 ¿Problemas? • 💡 ¿Ideas?
MUY PRONTO
FAQs
A CLI tool for managing GraphQL stores
We found that graphqlstore demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Application Security
/Security News
Socket CEO Feross Aboukhadijeh and a16z partner Joel de la Garza discuss vibe coding, AI-driven software development, and how the rise of LLMs, despite their risks, still points toward a more secure and innovative future.
Research
/Security News
Threat actors hijacked Toptal’s GitHub org, publishing npm packages with malicious payloads that steal tokens and attempt to wipe victim systems.
Research
/Security News
Socket researchers investigate 4 malicious npm and PyPI packages with 56,000+ downloads that install surveillance malware.
