Railway 数据库服务：一键部署 PostgreSQL、Redis、MySQL、MongoDB

database by railwayapp/railway-skills

872 周安装量

214 GitHub Stars

GitHub

安装命令

npx skills add https://github.com/railwayapp/railway-skills --skill database

云服务数据库开发运维

🇨🇳中文介绍

数据库

添加官方的 Railway 数据库服务。这些是经过维护的模板，具有预配置的卷、网络和连接变量。

对于非数据库模板，请参阅 templates 技能。

使用时机

用户要求"添加数据库"、"添加 Postgres"、"添加 Redis"等
用户的应用需要数据库
用户询问如何连接到数据库
用户说"添加 postgres 并连接到我的服务器"
用户说"配置数据库连接"

决策流程

在创建之前，务必先检查是否已存在数据库。

用户提及数据库
        │
  首先检查现有数据库
  (查询环境配置中的 source.image)
        │
   ┌────┴────┐
 存在      不存在
    │           │
    │      创建数据库
    │      (CLI 或 API)
    │           │
    │      等待部署完成
    │           │
    └─────┬─────┘
          │
    用户是否想要
    连接服务？
          │
    ┌─────┴─────┐
   是          否
    │           │
通过环境技能   完成 +
连接变量     建议连接

检查现有数据库

在创建数据库之前，请检查是否已存在。

有关完整的环境配置结构，请参阅 environment-config.md。

railway status --json

然后查询环境配置，并检查每个服务的：

广告位招租

在这里展示您的产品或服务

触达数万 AI 开发者，精准高效

联系我们

步骤 1：获取模板

bash <<'SCRIPT'
scripts/railway-api.sh \
  'query template($code: String!) {
    template(code: $code) {
      id
      name
      serializedConfig
    }
  }' \
  '{"code": "postgres"}'
SCRIPT

这将返回部署所需的模板 id 和 serializedConfig。

步骤 2：部署模板

bash <<'SCRIPT'
scripts/railway-api.sh \
  'mutation deployTemplate($input: TemplateDeployV2Input!) {
    templateDeployV2(input: $input) {
      projectId
      workflowId
    }
  }' \
  '{
    "input": {
      "templateId": "TEMPLATE_ID",
      "serializedConfig": SERIALIZED_CONFIG,
      "projectId": "PROJECT_ID",
      "environmentId": "ENVIRONMENT_ID",
      "workspaceId": "WORKSPACE_ID"
    }
  }'
SCRIPT

重要提示： serializedConfig 是来自模板查询的确切对象，不是字符串。

部署后，其他服务使用引用变量进行连接。

有关完整的变量引用语法和连接模式，请参阅 variables.md。

后端服务（服务器端）

使用私有/内部 URL 进行服务器到服务器通信：

数据库	变量引用
PostgreSQL	`${{Postgres.DATABASE_URL}}`
Redis	`${{Redis.REDIS_URL}}`
MySQL	`${{MySQL.MYSQL_URL}}`
MongoDB	`${{MongoDB.MONGO_URL}}`

重要提示： 前端在用户浏览器中运行，无法访问 Railway 的私有网络。它们必须使用公共 URL 或通过后端 API。

对于从前端直接访问数据库（不推荐）：

使用公共 URL 变量（例如 ${{MongoDB.MONGO_PUBLIC_URL}}）
需要启用 TCP 代理

更好的模式：前端 → 后端 API → 数据库

示例：添加 PostgreSQL

bash <<'SCRIPT'
# 1. 获取上下文
railway status --json
# 提取 project.id 和 environment.id

# 2. 获取工作区 ID
scripts/railway-api.sh \
  'query { project(id: "proj-id") { workspaceId } }' '{}'

# 3. 获取 Postgres 模板
scripts/railway-api.sh \
  'query { template(code: "postgres") { id serializedConfig } }' '{}'

# 4. 部署模板
scripts/railway-api.sh \
  'mutation deploy($input: TemplateDeployV2Input!) {
    templateDeployV2(input: $input) { projectId workflowId }
  }' \
  '{"input": {"templateId": "...", "serializedConfig": {...}, "projectId": "...", "environmentId": "...", "workspaceId": "..."}}'
SCRIPT

然后从另一个服务连接

使用 environment 技能添加变量引用：

{
  "services": {
    "<backend-service-id>": {
      "variables": {
        "DATABASE_URL": { "value": "${{Postgres.DATABASE_URL}}" }
      }
    }
  }
}

成功部署返回：

{
  "data": {
    "templateDeployV2": {
      "projectId": "e63baedb-e308-49e9-8c06-c25336f861c7",
      "workflowId": "deployTemplate/project/e63baedb-e308-49e9-8c06-c25336f861c7/xxx"
    }
  }
}

每个数据库模板创建：

一个包含数据库镜像的服务
一个用于数据持久化的卷
连接字符串的环境变量
用于外部访问的 TCP 代理（如适用）

错误	原因	解决方案
未找到模板	无效的模板代码	使用：`postgres`, `redis`, `mysql`, `mongodb`
权限被拒绝	用户缺少访问权限	需要 DEVELOPER 角色或更高
项目未找到	无效的项目 ID	运行 `railway status --json` 获取正确的 ID

"添加 postgres 并连接到服务器"

通过环境配置查询检查现有数据库
如果 postgres 已存在：跳转到步骤 5
如果不存在：部署 postgres 模板（获取模板 → 部署）
等待部署完成
确定目标服务（如果多个则询问，或使用链接的服务）
使用 environment 技能暂存：DATABASE_URL: { "value": "${{Postgres.DATABASE_URL}}" }
应用更改

通过环境配置查询检查现有数据库
如果存在："此项目中已存在 Postgres"
如果不存在：部署 postgres 模板
通知用户："Postgres 已创建。使用以下方式连接服务：DATABASE_URL=${{Postgres.DATABASE_URL}}"

"将服务器连接到 redis"

通过环境配置查询检查现有数据库
如果 redis 存在：通过环境技能连接 REDIS_URL → 应用
如果没有 redis：询问"未找到 Redis。是否创建一个？"
- 部署 redis 模板
- 连接 REDIS_URL → 应用

连接服务：使用 environment 技能添加变量引用
查看数据库服务：使用 service 技能
检查日志：使用 deployment 技能

🇺🇸English

Database

Add official Railway database services. These are maintained templates with pre-configured volumes, networking, and connection variables.

For non-database templates, see the templates skill.

When to Use

User asks to "add a database", "add Postgres", "add Redis", etc.
User needs a database for their application
User asks about connecting to a database
User says "add postgres and connect to my server"
User says "wire up the database"

Decision Flow

ALWAYS check for existing databases FIRST before creating.

User mentions database
        │
  Check existing DBs first
  (query env config for source.image)
        │
   ┌────┴────┐
 Exists    Doesn't exist
    │           │
    │      Create database
    │      (CLI or API)
    │           │
    │      Wait for deployment
    │           │
    └─────┬─────┘
          │
    User wants to
    connect service?
          │
    ┌─────┴─────┐
   Yes         No
    │           │
Wire vars    Done +
via env     suggest wiring
skill

Check for Existing Databases

Before creating a database, check if one already exists.

For full environment config structure, see environment-config.md.

railway status --json

Then query environment config and check source.image for each service:

query environmentConfig($environmentId: String!) {
  environment(id: $environmentId) {
    config(decryptVariables: false)
  }
}

The config.services object contains each service's configuration. Check source.image for:

ghcr.io/railway/postgres* or postgres:* → Postgres
ghcr.io/railway/redis* or redis:* → Redis
ghcr.io/railway/mysql* or mysql:* → MySQL
ghcr.io/railway/mongo* or mongo:* → MongoDB

Available Databases

Database	Template Code
PostgreSQL	`postgres`
Redis	`redis`
MySQL	`mysql`
MongoDB	`mongodb`

Prerequisites

Get project context:

railway status --json

Extract:

id - project ID
environments.edges[0].node.id - environment ID

Get workspace ID (not in status output):

bash <<'SCRIPT'
scripts/railway-api.sh \
  'query getWorkspace($projectId: String!) {
    project(id: $projectId) { workspaceId }
  }' \
  '{"projectId": "PROJECT_ID"}'
SCRIPT

Adding a Database

Step 1: Fetch Template

bash <<'SCRIPT'
scripts/railway-api.sh \
  'query template($code: String!) {
    template(code: $code) {
      id
      name
      serializedConfig
    }
  }' \
  '{"code": "postgres"}'
SCRIPT

This returns the template's id and serializedConfig needed for deployment.

Step 2: Deploy Template

bash <<'SCRIPT'
scripts/railway-api.sh \
  'mutation deployTemplate($input: TemplateDeployV2Input!) {
    templateDeployV2(input: $input) {
      projectId
      workflowId
    }
  }' \
  '{
    "input": {
      "templateId": "TEMPLATE_ID",
      "serializedConfig": SERIALIZED_CONFIG,
      "projectId": "PROJECT_ID",
      "environmentId": "ENVIRONMENT_ID",
      "workspaceId": "WORKSPACE_ID"
    }
  }'
SCRIPT

Important: serializedConfig is the exact object from the template query, not a string.

Connecting to the Database

After deployment, other services connect using reference variables.

For complete variable reference syntax and wiring patterns, see variables.md.

Backend Services (Server-side)

Use the private/internal URL for server-to-server communication:

Database	Variable Reference
PostgreSQL	`${{Postgres.DATABASE_URL}}`
Redis	`${{Redis.REDIS_URL}}`
MySQL	`${{MySQL.MYSQL_URL}}`
MongoDB	`${{MongoDB.MONGO_URL}}`

Frontend Applications

Important: Frontends run in the user's browser and cannot access Railway's private network. They must use public URLs or go through a backend API.

For direct database access from frontend (not recommended):

Use the public URL variables (e.g., ${{MongoDB.MONGO_PUBLIC_URL}})
Requires TCP proxy to be enabled

Better pattern: Frontend → Backend API → Database

Example: Add PostgreSQL

bash <<'SCRIPT'
# 1. Get context
railway status --json
# Extract project.id and environment.id

# 2. Get workspace ID
scripts/railway-api.sh \
  'query { project(id: "proj-id") { workspaceId } }' '{}'

# 3. Fetch Postgres template
scripts/railway-api.sh \
  'query { template(code: "postgres") { id serializedConfig } }' '{}'

# 4. Deploy template
scripts/railway-api.sh \
  'mutation deploy($input: TemplateDeployV2Input!) {
    templateDeployV2(input: $input) { projectId workflowId }
  }' \
  '{"input": {"templateId": "...", "serializedConfig": {...}, "projectId": "...", "environmentId": "...", "workspaceId": "..."}}'
SCRIPT

Then Connect From Another Service

Use environment skill to add the variable reference:

{
  "services": {
    "<backend-service-id>": {
      "variables": {
        "DATABASE_URL": { "value": "${{Postgres.DATABASE_URL}}" }
      }
    }
  }
}

Response

Successful deployment returns:

{
  "data": {
    "templateDeployV2": {
      "projectId": "e63baedb-e308-49e9-8c06-c25336f861c7",
      "workflowId": "deployTemplate/project/e63baedb-e308-49e9-8c06-c25336f861c7/xxx"
    }
  }
}

What Gets Created

Each database template creates:

A service with the database image
A volume for data persistence
Environment variables for connection strings
TCP proxy for external access (where applicable)

Error Handling

Error	Cause	Solution
Template not found	Invalid template code	Use: `postgres`, `redis`, `mysql`, `mongodb`
Permission denied	User lacks access	Need DEVELOPER role or higher
Project not found	Invalid project ID	Run `railway status --json` for correct ID

Example Workflows

"add postgres and connect to the server"

Check existing DBs via env config query
If postgres exists: Skip to step 5
If not exists: Deploy postgres template (fetch template → deploy)
Wait for deployment to complete
Identify target service (ask if multiple, or use linked service)
Use environment skill to stage: DATABASE_URL: { "value": "${{Postgres.DATABASE_URL}}" }
Apply changes

"add postgres"

Check existing DBs via env config query
If exists: "Postgres already exists in this project"
If not exists: Deploy postgres template
Inform user: "Postgres created. Connect a service with: DATABASE_URL=${{Postgres.DATABASE_URL}}"

"connect the server to redis"

Check existing DBs via env config query
If redis exists: Wire up REDIS_URL via environment skill → apply
If no redis: Ask "No Redis found. Create one?"
- Deploy redis template
- Wire REDIS_URL → apply

Composability

Connect services : Use environment skill to add variable references
View database service : Use service skill
Check logs : Use deployment skill

Weekly Installs

872

Repository

railwayapp/rail…y-skills

GitHub Stars

214

First Seen

Jan 20, 2026

Security Audits

Gen Agent Trust HubWarn SocketPass SnykPass

Installed on

opencode734

codex718

gemini-cli680

github-copilot650

claude-code639

amp576

Azure 升级评估与自动化工具 - 轻松迁移 Functions 计划、托管层级和 SKU

64,099 周安装