PostgreSQL becomes the default backend

Ouverte
#1,627 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Les mainteneurs répondent en général sous 6 jours

@dimitri-yatsenko y travaille déjà.

Depuis le 17/10/2026.

  • #1629 par @dimitri-yatsenko — ouverte

Évaluation

Difficulté
4/5
Temps estimé
3-5 jours
Accessibilité débutants
35/100
Type d'issue
Fonctionnalité
Clarté
Clairement spécifiée
Activité
À l'abandon
Stack technique
docker-compose, mysql, postgresql, python

Piste de recherche

Start with the database backend configuration and connection setup, then inspect the settings docstring, CLI help, docker-compose.yaml, and CONTRIBUTING.md; the issue does not name source files. Update PostgreSQL defaults and backend-aware port selection, while ensuring MySQL fixtures and users select MySQL explicitly. Run the relevant test suite and verify dj.config.save_template(), connection error behavior, and documentation examples.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

enhancement

Motivation

DataJoint supports PostgreSQL and MySQL as production backends, with the same features on both. Today database.backend defaults to "mysql", so a new user who installs DataJoint and connects without configuring a backend gets MySQL.

PostgreSQL becomes the default backend. A new install should work against PostgreSQL with no backend setting, and the documentation, examples, and test runs should lead with it. MySQL stays a fully supported backend; selecting it takes one setting.

The change

  • database.backend defaults to "postgresql", and the default port is 5432.

  • The port follows the backend unless it is set. Today the port is derived only when the settings are first built, so database.backend set in datajoint.json or assigned at run time leaves the other backend's port in place. After this change, backend: "mysql" with no port connects on 3306.

  • If a connection fails while the backend is still the default, so that neither the configuration nor the code chose one, the error adds:

    The default backend is postgresql since DataJoint 2.4; set database.backend='mysql' (DJ_BACKEND=mysql) for a MySQL server.
    

    A backend set by DJ_BACKEND, datajoint.json, dj.config, or the backend argument of dj.Connection / dj.Instance counts as chosen, and its connection errors are raised unchanged.

  • dj.config.save_template() writes "backend": "postgresql" and port 5432.

  • The settings docstring, CLI help, docker-compose.yaml, and CONTRIBUTING.md list PostgreSQL first.

  • The test fixtures that connect to the MySQL test server select MySQL explicitly instead of relying on the default.

Migration for MySQL users

Select the MySQL backend in any one of these ways:

  • Environment: export DJ_BACKEND=mysql

  • datajoint.json:

    {
      "database": {
        "backend": "mysql",
        "host": "db.example.org"
      }
    }
    
  • In code, before connecting: dj.config["database.backend"] = "mysql"

  • For an isolated instance: dj.Instance(host=..., user=..., password=..., backend="mysql")

With the backend set, the port defaults to 3306. A port set explicitly (DJ_PORT, database.port, or host:port) is kept as is. A MySQL setup that sets no backend fails to connect with the message above.

Langage dominant
Python
Étoiles
198
Forks
103
Merge moyen
6 j 1 h
PR mergées (30 j)
10

Préparer son environnement

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de datajoint/datajoint-python

Toutes les issues de datajoint/datajoint-python

Issues similaires

Plus d'issues Python

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.