Visão geral da conexão

info

Beta

O Lakebase Postgres (beta com escalonamento automático) é a próxima versão do Lakebase, disponível apenas para avaliação. Para cargas de trabalho de produção, utilize a versão de pré-visualização pública do Lakebase. Consulte a seção "Como escolher entre as versões" para entender qual versão é a mais adequada para você.

Aprenda como se conectar ao seu projeto de banco de dados Lakebase Postgres.

Início rápido: Conecte-se ao seu banco de dados

Conecte-se ao seu banco de dados usando um dos dois métodos de autenticação:

• FunçãoOAuth : Autentique-se usando sua identidade Databricks com um token OAuth . O responsável pelo projeto pode entrar em contato imediatamente. Para permitir que outras identidades do Databricks usem a autenticação OAuth, crie suas funções do Postgres usando a extensão databricks_auth . Consulte Criar uma função OAuth.
• Autenticação nativa de senha do Postgres: Autentique-se usando uma função do Postgres com uma senha de banco de dados tradicional. Crie essas funções usando a interface do usuário do Lakebase ou SQL.

Os exemplos abaixo usam psql, um cliente Postgres padrão, mas você também pode acessar seu banco de dados através do Editor SQL do Lakebase, do Editor de Tabelas ou de ferramentas de terceiros como o pgAdmin e outros clientes compatíveis com o Postgres. Consulte a seção "Consulte seus dados" para obter mais opções.

Cada projeto contém um banco de dados default chamado databricks_postgres ao qual você pode se conectar. Este banco de dados pertence à função Postgres da sua identidade Databricks (por exemplo, user@databricks.com), que é criada automaticamente quando você cria um projeto. Para criar funções adicionais do Postgres, consulte Gerenciar funções do Postgres.

nota

Todas as conexões com o banco de dados estão sujeitas a um tempo limite de 24 horas do Parado e a um tempo máximo de conexão de 3 dias. Saiba mais: Tempo limite de conexão

Conecte-se com uma função OAuth

As funções OAuth permitem que você se conecte usando sua identidade Databricks com autenticação baseada em tokens. A função OAuth do proprietário do projeto é criada automaticamente. Para permitir que outras identidades do Databricks usem a autenticação OAuth, suas funções do Postgres devem ser criadas usando a extensão databricks_auth . Consulte Criar uma função OAuth.

Para conectar-se a uma função OAuth:

1. No aplicativo Lakebase, selecione seu projeto de banco de dados e clique em Conectar .
2. Selecione a filial, compute e o banco de dados aos quais deseja se conectar e, em seguida, selecione sua identidade Databricks no menu suspenso Funções .
3. Copie o trecho de conexão psql para o seu terminal e insira-o.
4. Quando solicitado a inserir uma senha, clique em Copiar tokens OAuth e digite-a como sua senha:

Conecte-se com a senha nativa do Postgres

A autenticação nativa por senha do Postgres permite que você se conecte usando uma função do Postgres com uma senha de banco de dados tradicional.

Para conectar-se com a autenticação de senha nativa do Postgres:

1. No aplicativo Lakebase, selecione seu projeto de banco de dados e clique em Conectar .
2. Selecione a ramificação, compute e o banco de dados aos quais deseja se conectar e, em seguida, selecione uma função do Postgres no menu suspenso Funções .
3. Copie o trecho de conexão psql para o seu terminal e insira-o para conectar.

nota

Entendendo a autenticação: o Lakebase usa dois sistemas separados - identidades do Databricks para autenticação OAuth e funções do Postgres para acesso ao banco de dados. Saiba mais: Autenticação

Entendendo stringsconexão

Uma string de conexão do Lakebase inclui a função, hostname e o nome do banco de dados. Para autenticação nativa por senha no Postgres, as strings de conexão também incluem a senha. Para autenticação OAuth usando psql, você fornece a senha (tokens OAuth ) separadamente quando solicitado.

Formato das cadeias de conexão

Autenticação OAuth:

postgresql://your-email@example.com@ep-abc-123.databricks.com/databricks_postgres?sslmode=require
             ^                      ^                         ^
       role -|                      |- hostname               |- database

Autenticação nativa de senha do Postgres:

postgresql://role_name:password@ep-abc-123.databricks.com/databricks_postgres?sslmode=require
             ^         ^        ^                         ^
       role -|         |        |- hostname               |- database
                       |
                       |- password

nota

O hostname inclui o ID do endpoint compute , que tem um prefixo ep- (por exemplo, ep-abc-123). Isso identifica o compute específico que atende ao seu banco de dados.

Componentes de cadeias de conexão

Você pode configurar sua conexão usando componentes individuais. Por exemplo, você pode colocar estes em um arquivo .env :

Bash

PGHOST=ep-abc-123.databricks.com
PGDATABASE=databricks_postgres
PGUSER=role_name
PGPASSWORD=your-password or token
PGPORT=5432

Ou atribua-os a uma variável DATABASE_URL :

Bash

DATABASE_URL="postgresql://role_name:password@ep-abc-123.databricks.com/databricks_postgres?sslmode=require"

Segurança da conexão

A Lakebase exige que todas as conexões utilizem criptografia SSL/TLS. O parâmetro sslmode=require impõe esse requisito. Todas strings de conexão fornecidas no aplicativo Lakebase incluem esse parâmetro por default.

Porta

O Lakebase usa a porta default do Postgres, 5432 .

Configuração de rede

Para conectar compute clássico ao Postgres, abra a porta TCP 5432 para o endereço 0.0.0.0/0 no seu grupo de segurança de rede.

Conecte-se a partir de aplicativos e estruturas

Os exemplos abaixo mostram como conectar-se ao seu banco de dados Lakebase a partir de diferentes linguagens de programação e frameworks. Você também pode obter trechos de código de conexão para esses idiomas na caixa de diálogo Conectar do aplicativo Lakebase.

Psql

Bash

psql 'postgresql://role_name:password@ep-abc-123.databricks.com/databricks_postgres?sslmode=require'

.env

ini

PGHOST=ep-abc-123.databricks.com
PGDATABASE=databricks_postgres
PGUSER=role_name
PGPASSWORD=password
PGPORT=5432

Prisma

JavaScript

import { PrismaClient } from '@prisma/client';

const prisma = new PrismaClient({
  datasources: {
    db: {
      url: process.env.DATABASE_URL,
    },
  },
});

.NET

Csharp

// Connection string
"Host=ep-abc-123.databricks.com;Database=databricks_postgres;Username=role_name;Password=password"

// with SSL
"Host=ep-abc-123.databricks.com;Database=databricks_postgres;Username=role_name;Password=password;SSL Mode=Require;Trust Server Certificate=true"

// Entity Framework (appsettings.json)
{
  ...
  "ConnectionStrings": {
    "DefaultConnection": "Host=ep-abc-123.databricks.com;Database=databricks_postgres;Username=role_name;Password=password;SSL Mode=Require;Trust Server Certificate=true"
  },
  ...
}

Django

Python

# settings.py
DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.postgresql',
        'NAME': 'databricks_postgres',
        'USER': 'role_name',
        'PASSWORD': 'password',
        'HOST': 'ep-abc-123.databricks.com',
        'PORT': '5432',
        'OPTIONS': {
            'sslmode': 'require',
        },
    }
}

SQLAlchemy

Python

from sqlalchemy import create_engine
import os

# Using environment variable
database_url = os.getenv('DATABASE_URL')
engine = create_engine(database_url)

# Or construct the connection string
engine = create_engine(
    'postgresql://role_name:password@ep-abc-123.databricks.com:5432/databricks_postgres?sslmode=require'
)

Symfony

Bash

# .env
DATABASE_URL="postgresql://role_name:password@ep-abc-123.databricks.com/databricks_postgres?sslmode=require&charset=utf8"

Go

Go

package main

import (
    "database/sql"
    "fmt"
    "log"
    "os"

    _ "github.com/lib/pq"
    "github.com/joho/godotenv"
)

func main() {
    err := godotenv.Load()
    if err != nil {
        log.Fatalf("Error loading .env file: %v", err)
    }

    connStr := os.Getenv("DATABASE_URL")
    if connStr == "" {
        panic("DATABASE_URL environment variable is not set")
    }

    db, err := sql.Open("postgres", connStr)
    if err != nil {
        panic(err)
    }
    defer db.Close()

    var version string
    if err := db.QueryRow("select version()").Scan(&version); err != nil {
        panic(err)
    }
    fmt.Printf("version=%s\n", version)
}

Próximos passos

• Autenticação - Compreenda como funcionam tokens OAuth e as senhas do Postgres, incluindo a expiração dos tokens e os tempos limite de conexão.
• Gerenciar funções do Postgres - Criar e gerenciar funções do Postgres para identidades Databricks e compreender funções pré-criadas.
• Gerenciar permissões - Aprenda como conceder acesso ao banco de dados para funções do Postgres por meio de privilégios.
• Consulte seus dados - Use o editor SQL, psql ou outras ferramentas do Postgres para consultar seu banco de dados.