neondatabase/neon

Was macht neon?

Hinweis: Diese Fähigkeit verwendet die Neon API und erfordert einen API-Schlüssel. Du musst den Schlüssel als Umgebungsvariable NEON_API_KEY setzen.

Über Neon

Neon ist eine serverlose Open-Source-Alternative zu AWS Aurora PostgreSQL. Es trennt Storage und Compute und bietet modernste Features wie sofortige Bereitstellung von Datenbanken, Branching (ähnlich wie Git-Branches) und unbegrenzte Speicherkapazität. Weitere Informationen zu Neon findest du in der offiziellen Dokumentation.

Verwendung

Projekte

Ein bestehendes Neon-Projekt verwenden:

Um auf ein bestehendes Neon-Projekt zuzugreifen, benötigst du entweder deinen Connection String oder deine Neon-Anmeldeinformationen.

Neon verwendet drei Arten von Benutzernamen:

• CNP (Console Neon Password): Wird für den Zugriff auf die Neon-Konsole verwendet. Format: [email-username]-[project-id]
• PG (PostgreSQL): Wird für Datenbankverbindungen verwendet. Format: [project-name]_owner
• API: Wird für API-Anfragen mit dem Neon-API-Schlüssel verwendet.

Neon-Anmeldeinformationen finden:

Falls du deine Neon-Anmeldeinformationen nicht findest, führe diese Schritte aus:

1. Öffne das Neon-Dashboard.
2. Klicke auf dein Projekt.
3. Suche unter den Verbindungsdetails oder im Bereich 'Einstellungen'.

Wenn der Benutzer seinen Neon Connection String hat, kannst du die Datenbankverbindung mit diesem String herstellen.

Ein neues Neon-Projekt erstellen:

# Ein neues Neon-Projekt erstellen
curl -X POST "https://console.neon.tech/api/v2/projects" \
  -H "Authorization: Bearer $NEON_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"project": {"name": "my-project"}}'

Datenbanken

Datenbanken auflisten:

# Alle Datenbanken in einem Projekt auflisten
curl "https://console.neon.tech/api/v2/projects/{project_id}/databases" \
  -H "Authorization: Bearer $NEON_API_KEY"

Eine Datenbank erstellen:

# In einem bestimmten Branch eine Datenbank erstellen
curl -X POST "https://console.neon.tech/api/v2/projects/{project_id}/databases" \
  -H "Authorization: Bearer $NEON_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"database": {"name": "mydb", "owner_name": "myuser", "branch_id": "{branch_id}"}}'

Branches

Branches auflisten:

# Alle Branches eines Projekts auflisten
curl "https://console.neon.tech/api/v2/projects/{project_id}/branches" \
  -H "Authorization: Bearer $NEON_API_KEY"

Einen Branch erstellen:

# Von einem bestehenden Branch aus einen neuen Branch erstellen (Standard: Hauptbranch)
curl -X POST "https://console.neon.tech/api/v2/projects/{project_id}/branches" \
  -H "Authorization: Bearer $NEON_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"branch": {"name": "feature-branch", "parent_id": "{parent_branch_id}"}}'

SQL-Abfragen

SQL-Abfragen mit der Neon SQL-Proxy-API ausführen (Anmeldung erforderlich):

# SQL-Abfrage an eine Datenbank in einem Branch senden
curl "https://console.neon.tech/api/v2/projects/{project_id}/branches/{branch_id}/databases/{database_name}/sql" \
  -H "Authorization: Bearer $NEON_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query": "SELECT * FROM users LIMIT 10;"}'

Verbindungsinformationen

Verbindungsdetails eines Projekts abrufen:

# Verbindungsdetails für ein Projekt abrufen (erfordert Benutzerpasswort)
curl "https://console.neon.tech/api/v2/projects/{project_id}/connection_uri" \
  -H "Authorization: Bearer $NEON_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"database": {"name": "mydb"}, "role": {"name": "myuser", "password": "userpassword"}}'

Endpunkte

Compute-Endpunkte auflisten:

# Compute-Endpunkte für einen bestimmten Branch eines Projekts abrufen
curl "https://console.neon.tech/api/v2/projects/{project_id}/branches/{branch_id}/endpoints" \
  -H "Authorization: Bearer $NEON_API_KEY"

Passwort zurücksetzen:

# Passwort für einen Datenbankbenutzer zurücksetzen
curl -X POST "https://console.neon.tech/api/v2/projects/{project_id}/branches/{branch_id}/roles/{role_name}/reset_password" \
  -H "Authorization: Bearer $NEON_API_KEY" \
  -H "Content-Type: application/json"

Umgebungsvariablen

Variable	Beschreibung	Erforderlich
NEON_API_KEY	Dein Neon API-Schlüssel	Ja
NEON_PROJECT_ID	Projekt-ID deines bestehenden Neon-Projekts (optional)	Nein
DATABASE_URL	PostgreSQL Connection String (optional)	Nein

Kompatibilität mit KI-Assistenten

Diese Fähigkeit ist kompatibel mit:

• Claude Code
• Cursor
• Codex CLI
• Andere KI-Assistenten für Befehlszeilen, die OpenAI-kompatible Funktionsaufrufe oder Tool-Integrationen unterstützen.

Brauchst du Hilfe?

• Neon-Dokumentation
• Neon-API-Referenz
• Neon-Dashboard

---

Erstellt vom Neon-Team