seitime-frappe/frappe/database/__init__.py
Sagar Vora b2cab51849
feat: re-introduce mysqlclient 🚀 (#31719)
* feat: mysqlclient

* fix: update error attrs

* fix: decode mogrified query to unicode

* fix: do some cleanup

* chore: disable cleanup for now

* fix: remove unnecessary call to as_unicode

* test: skip perf test for now

* fix: fallback to empty str

* fix: unbuffered cursor support

* fix: update converters and other changes

* fix: add cleanup back

* perf: improve timedelta converter

* fix: dont attempt to run query when explain flag is set

* test: cleanup tests

* chore: remove commented code

* perf: store conf as local var

* chore: ensure sequence

---------

Co-authored-by: Ankush Menat <ankush@frappe.io>
2025-03-15 09:48:21 +05:30

138 lines
3.4 KiB
Python

# Copyright (c) 2015, Frappe Technologies Pvt. Ltd. and Contributors
# License: MIT. See LICENSE
# Database Module
# --------------------
from shutil import which
from frappe.database.database import savepoint
def setup_database(force, verbose=None, mariadb_user_host_login_scope=None):
import frappe
if frappe.conf.db_type == "postgres":
import frappe.database.postgres.setup_db
return frappe.database.postgres.setup_db.setup_database()
else:
import frappe.database.mariadb.setup_db
return frappe.database.mariadb.setup_db.setup_database(force, verbose, mariadb_user_host_login_scope)
def bootstrap_database(verbose=None, source_sql=None):
import frappe
if frappe.conf.db_type == "postgres":
import frappe.database.postgres.setup_db
return frappe.database.postgres.setup_db.bootstrap_database(verbose, source_sql)
else:
import frappe.database.mariadb.setup_db
return frappe.database.mariadb.setup_db.bootstrap_database(verbose, source_sql)
def drop_user_and_database(db_name, db_user):
import frappe
if frappe.conf.db_type == "postgres":
import frappe.database.postgres.setup_db
return frappe.database.postgres.setup_db.drop_user_and_database(db_name, db_user)
else:
import frappe.database.mariadb.setup_db
return frappe.database.mariadb.setup_db.drop_user_and_database(db_name, db_user)
def get_db(socket=None, host=None, user=None, password=None, port=None, cur_db_name=None):
import frappe
conf = frappe.local.conf
if conf.db_type == "postgres":
import frappe.database.postgres.database
return frappe.database.postgres.database.PostgresDatabase(
socket, host, user, password, port, cur_db_name
)
elif conf.use_mysqlclient:
import frappe.database.mariadb.mysqlclient
return frappe.database.mariadb.mysqlclient.MariaDBDatabase(
socket, host, user, password, port, cur_db_name
)
else:
import frappe.database.mariadb.database
return frappe.database.mariadb.database.MariaDBDatabase(
socket, host, user, password, port, cur_db_name
)
def get_command(
socket=None, host=None, port=None, user=None, password=None, db_name=None, extra=None, dump=False
):
import frappe
if frappe.conf.db_type == "postgres":
if dump:
bin, bin_name = which("pg_dump"), "pg_dump"
else:
bin, bin_name = which("psql"), "psql"
if socket and password:
conn_string = f"postgresql://{user}:{password}@/{db_name}?host={socket}"
elif socket:
conn_string = f"postgresql://{user}@/{db_name}?host={socket}"
elif password:
conn_string = f"postgresql://{user}:{password}@{host}:{port}/{db_name}"
else:
conn_string = f"postgresql://{user}@{host}:{port}/{db_name}"
command = [conn_string]
if extra:
command.extend(extra)
else:
if dump:
bin, bin_name = which("mariadb-dump") or which("mysqldump"), "mariadb-dump"
else:
bin, bin_name = which("mariadb") or which("mysql"), "mariadb"
command = [f"--user={user}"]
if socket:
command.append(f"--socket={socket}")
elif host and port:
command.append(f"--host={host}")
command.append(f"--port={port}")
if password:
command.append(f"--password={password}")
if dump:
command.extend(
[
"--single-transaction",
"--quick",
"--lock-tables=false",
]
)
else:
command.extend(
[
"--pager=less -SFX",
"--safe-updates",
"--no-auto-rehash",
]
)
command.append(db_name)
if extra:
command.extend(extra)
return bin, command, bin_name