Saltearse al contenido

@astrojs/ db

v0.9.0 GitHub npm Changelog

Astro DB es una base de datos SQL completamente administrada diseñada para el ecosistema de Astro: desarrolla localmente en Astro y despliega desde tu panel de Astro Studio.

Con Astro DB tienes una herramienta potente, local y segura para consultar y modelar contenido como una base de datos relacional. Visualiza, administra y despliega tus datos remotos alojados a través de tu panel interactivo de Studio.

Consulta la guía de Astro DB para obtener ejemplos y usos completos.

Instalación

Sección titulada Instalación

Astro incluye un comando astro add para automatizar la configuración de integraciones oficiales. Si lo prefieres, puedes instalar las integraciones manualmente en su lugar.

Ejecuta uno de los siguientes comandos en una nueva ventana de terminal.

Ventana de terminal
npx astro add db

Instalación manual

Sección titulada Instalación manual

Si prefieres configurar las cosas desde cero, omite astro add y sigue estas instrucciones para instalar Astro DB tú mismo.

1. Instala la integración desde npm a través de un gestor de paquetes
Sección titulada 1. Instala la integración desde npm a través de un gestor de paquetes
Ventana de terminal
npm install @astrojs/db
2. Agrega la integración a astro.config.mjs
Sección titulada 2. Agrega la integración a astro.config.mjs
astro.config.mjs
import { defineConfig } from 'astro/config';
import db from '@astrojs/db';


export default defineConfig({
  integrations: [
   db()
  ]
});
3. Configura tu base de datos
Sección titulada 3. Configura tu base de datos

Crea un archivo db/config.ts en la raíz de tu proyecto. Este es un archivo especial que Astro cargará y utilizará automáticamente para configurar las tablas de tu base de datos.

db/config.ts
import { defineDb } from 'astro:db';


export default defineDb({
  tables: {},
})

Configuración de la tabla de referencia

Sección titulada Configuración de la tabla de referencia

columns

Sección titulada columns

Las columnas de la tabla se configuran utilizando el objeto columns:

import { defineTable, column, NOW } from 'astro:db';


const Comment = defineTable({
  columns: {
    id: column.number({ primaryKey: true }),
    author: column.text(),
    content: column.text({ optional: true }),
    published: column.date({ default: NOW }),
  },
});

Las columnas se configuran utilizando la utilidad column. column admite los siguientes tipos:

  • column.text(...) - guarda contenido de texto plano o enriquecido
  • column.number(...) - almacena valores enteros y de punto flotante
  • column.boolean(...) - almacena valores verdaderos / falsos
  • column.date(...) - almacena objetos Date, analizados como strings ISO para el almacenamiento de datos
  • column.json(...) - almacena bloques JSON arbitrarios, analizados como JSON serializado para el almacenamiento de datos

Hay algunos valores de configuración compartidos en todas las columnas:

  • primaryKey - Establece una columna number o text como identificador único.
  • optional - Astro DB usa NOT NULL para todas las columnas de forma predeterminada. Establece optional en true para permitir valores nulos.
  • default - Establece el valor predeterminado para las entradas recién insertadas. Esto acepta un valor estático o un string de sql para valores generados como marcas de tiempo. unique - Marca una columna como única. Esto evita valores duplicados en las entradas de la tabla.
  • references - Hace referencia a una tabla relacionada por columna. Esto establece una restricción de clave externa, lo que significa que cada valor de columna debe tener un valor coincidente en la tabla referenciada.

indexes

Sección titulada indexes

Los índices de tabla se utilizan para mejorar la velocidad de búsqueda en una columna o combinación de columnas. La propiedad indexes acepta un objeto con un nombre de índice único como clave:

db/config.ts
import { defineTable, column } from 'astro:db';


const Comment = defineTable({
  authorId: column.number(),
  body: column.text(),
  indexes: {
    author_idx: { on: ['authorId'], unique: true },
  }
});

Las siguientes opciones de configuración están disponibles para cada índice:

  • on: string | string[] - Una sola columna o un array de nombres de columnas para indexar.
  • unique: boolean - Establece true para forzar valores únicos en las columnas indexadas.

foreignKeys

Sección titulada foreignKeys

Las claves foráneas se utilizan para establecer una relación entre dos tablas. La propiedad foreignKeys acepta una matriz de objetos de configuración que pueden relacionar una o más columnas entre tablas:

db/config.ts
import { defineTable, column } from 'astro:db';


const Author = defineTable({
  firstName: column.text(),
  lastName: column.text(),
});


const Comment = defineTable({
  authorFirstName: column.text(),
  authorLastName: column.text(),
  body: column.text(),
  foreignKeys: [
    {
      columns: ['authorFirstName', 'authorLastName'],
      references: () => [
        Author.columns.firstName,
        Author.columns.lastName
      ],
    },
  ]
});

Cada objeto de configuración de clave foránea acepta las siguientes propiedades:

  • columns: string[] - Un array de nombres de columnas para relacionar con la tabla referenciada.
  • references: () => Column[] - Una función que devuelve un array de columnas de la tabla referenciada.

Referencia de la CLI de Astro DB

Sección titulada Referencia de la CLI de Astro DB

Astro DB incluye un conjunto de comandos CLI para interactuar con tu base de datos de proyecto alojada y tu cuenta de Astro Studio.

Estos comandos se ejecutan automáticamente al usar una acción de GitHub CI, y se pueden llamar manualmente utilizando el CLI astro db.

astro db push

Sección titulada astro db push

Banderas:

  • --force-reset Reinicia todos los datos de producción si se requiere un cambio de esquema.

De forma segura envía cambios de configuración de la base de datos a la base de datos de tu proyecto. Esto comprobará cualquier riesgo de pérdida de datos y te guiará en cualquier paso de migración recomendado. Si se debe realizar un cambio de esquema que rompa, usa la bandera --force-reset para restablecer todos los datos de producción.

astro db verify

Sección titulada astro db verify

Verifica si hay diferencias entre las configuraciones de tu base de datos local y remota. Esto se ejecuta automáticamente con astro db push. verify comparará tu archivo db/config.ts local con la base de datos remota y advertirá si se detectan cambios.

astro db execute <file-path>

Sección titulada astro db execute &lt;file-path&gt;

Banderas:

  • --remote Ejecuta contra la base de datos de tu proyecto de Studio. Omite para ejecutar contra tu servidor de desarrollo.

Ejecuta un archivo .ts o .js para leer o escribir en tu base de datos. Esto acepta una ruta de archivo como argumento y admite el uso del módulo astro:db para escribir consultas seguras. Utiliza la bandera --remote para ejecutar contra la base de datos de tu proyecto de Studio, u omite la bandera para ejecutar contra tu servidor de desarrollo. Consulta cómo sembrar datos de desarrollo para ver un archivo de ejemplo.

astro db shell --query <sql-string>

Sección titulada astro db shell --query &lt;sql-string&gt;

Banderas:

  • --query Consulta SQL sin procesar para ejecutar.
  • --remote Ejecuta contra la base de datos de tu proyecto de Studio. Omite para ejecutar contra tu servidor de desarrollo.

Ejecuta una consulta SQL sin procesar contra tu base de datos. Utiliza la bandera --remote para ejecutar contra la base de datos de tu proyecto de Studio u omite la bandera para ejecutar contra tu servidor de desarrollo.

Más integraciones

Frameworks UI

Adaptadores SSR

Otras integraciones