Postgres support for Frappe (frappe#5919)

* [start] postgres

* [wip] started refactoring db_schema

* Add psycopg2 to requirements.txt

* Add support for Postgres SQL

- Separate frameworkSQL, database, schema, setup_db file for
mariaDB and postgres
- WIP

* Remove quotes from sql to make it compatible with postgres as well

* Moved some code from db_schema to database.py

* Move code from db_schema to schema.py

Add other required refactoring

* Add schema chages

* Remove redundant code in file

* Add invalid column name exception class to exceptions.py

* Add back tick in query wherever needed and replace ifnull with coalesce

* Update get_column_description code in database.py file

* Remove a print statement

* Add keys to get on_duplicate query

* Add bactick wherever necessary

- Remove db_schema.py file

* Remove DATE_SUB as it is incompatible with postgres

- Fix prepare_filter_condition

* Add backtick and quotes wherever necessary
- Move get_database_size to frappe.db namespace
- fix some left out bugs and errors

* Add code to create key and unique index
- added mysql and posgres in their respective database.py

* Add more bacticks in queries and fix some errors
- Pass keys to on_duplicate_update method
- Replace MONTH with EXTRACT function
- Remove DATEDIFF and CURDATE usage

* Cast state value to int in toggle_two_factor_auth
- since two_factor_auth has the datatype of Int

* Refactor
- Replace Timediff with normal arithmetic operator
- Add MAX_COLUMN_LENGTH
- Remove Redundant code
- Add regexp character constant
- Move create_help_table to database.py
- Add get_full_text_search_condition method
- Inherit MariaDBTable from DBTable

* Replace Database instance with get_db method

* Move db_manager to separate file

* Refactor
- Remove some unwanted code
- Separate alter table code for postgres and mysql
- Replace data_type with column_type in database.py

* Make fulltext search changes in global_search.py

* Add empty string check

* Add root_password to site config

* Create cli command for postgres console

* Move setup of help database to setup_db.py

* Add get_database_list method

* Fix exception handling
- Replace bad_field handler with missing_column handler

* Fix tests and sql queries

* Fix import error

* Fix typo db -> database

* Fix error with make_table in help.py

* Try test for postgres

* Remove pyhton 2.7 version to try postgres travis test

* Add test fixes

* Add db_type to the config of test_site_postgres

* Enable query debug to check the reason for travis fail

* Add backticks to check if the test passes

* Update travis.yml
- Add postgres addon

* Try appending 'd_' to hash for db_name
- since postgres does not support dbname starting with a number

* Try adding db_type for global help to make travis work

* Add print statements to debug travis failure

* Enable transaction and remove debug flag

* Fix help table creation query (postgres)

* Fix import issue

* Add some checks to prevent errors
- Some doctypes used to get called even before they are created

* Try fixes

* Update travis config

* Fix create index for help table

* Remove unused code

* Fix queries and update travis config

* Fix ifnull replace logic (regex)

* Add query fixes and code cleanup

* Fix typo
- get_column_description -> get_table_columns_description

* Fix tests
- Replace double quotes in query with single quote

* Replace psycopg2 with psycopg2-binary to avoid warnings
- http://initd.org/psycopg/docs/install.html#binary-install-from-pypi

* Add multisql api

* Add few multisql queries

* Remove print statements

* Remove get_fulltext_search_condition method and replace with multi query

* Remove text slicing in create user

* Set default for 'values' argument in multisql

* Fix incorrect queries and remove few debug flags
- Fix multisql bug

* Force delete user to fix test
- Fix Import error
- Fix incorrect query

* Fix query builder bug

* Fix bad query

* Fix query (minor)

* Convert boolean text to int since is_private has datatype of int
- Some query changes like removed double quotes
and replace with interpolated string to pass multiple
value pass in one of the query

* Extend database class from an object to support python 2

* Fix query
- Add quotes around value passed to the query for variable comparision

* Try setting host_name for each test site
- To avoid "RemoteDisconnected" error while testing data migration test
- Update travis.yml to add hosts
- Remove unwanted commit in setup_help_database

* Set site hostname to data migration connector (in test file)
- To connect the same site host

* Fix duplicate entry issue
- the problem is in naming series file.
In previous commits I unknowingly changed a part of a series query
due to which series were not getting reset

* Replace few sql queries with orm methods

* Fix codacy

* Fix 'Doctype Sessions not found' issue

* Fix bugs induced during codacy fixes

* Fix Notification Test

- Use ORM instead of raw sql

* Set Date fallback value to 0001-01-01

- 0000-00-00 is invalid date in Postgres
- 0001-01-01 works in both

* Fix date filter method

* Replace double quotes with single quote for literal value

* Remove print statement

* Replace double quotes with single

* Fix tests

- Replace few raw sql with ORM

* Separate query for postgres

- update_fields_to_fetch_query

* Fix tests

- replace locate with strpos for postgres

* Fix tests

- Skip test for datediff
- convert bytes to str in escape method

* Remove TestBot

* Skip fieldname extraction

* Replace docshare raw sql with ORM

* Fix typo

* Fix ancestor query test

* Fix test data migration

* Remove hardcoded hostname

* Add default option and option list for db_type

* Remove frappe.async module

* Remove a debug flag from test

* Fix codacy

* fix import issue

* Convert classmethod to static method

* Convert few instance methods to static methods

* Remove some unused imports

* Fix codacy

- Add exception type
- Replace few instance methods with static methods
- Remove unsued import

* Fix codacy

* Remove unused code

* Remove some unused codes

- Convert some instance methods to static function

* Fix a issue with query modification

* Fix add_index query

* Fix query

* Fix update_auth patch

* Fix a issue with exception handling

* Add try catch to a reload_doc

* Add try-catch to file_manager_hook patch

* import update_gravatar to set_user_gravatar patch

* Undo all the wrong patch fixes

* Fix db_setup code 😪
- previously it was not restoring db from source SQL
which is why few old patched were breaking
(because they were getting different schema structure)

* Fix typo !

* Fix exception(is_missing_column) handling

* Add deleted code
- This code is only used in a erpnext patch.
Can be moved to that patch file

* Fix codacy

* Replace a mariadb specific function in a query used in validate_series

* Remove a debug flag

* Revert changes (rename_parent_and_child)

* Fix validate_one_root method

* Fix date format issue

* Fix codacy
- Disable a pylint for variable argument warning
- Convert an instance method to static method

* Add bandit.yml

The Codacy seems to use Bandit which generates
warning for every subprocess import and its usage during pytest
Since we have carefully used subprocess (avoided user input),
warnings needs to be avoided.
This can be removed if we have any alternative for subprocess usage.

* Skip start_process_with_partial_path check

* Fix typo

* Add python 2.7 test

* Move python versions in travis.yml

* Add python versions to jobs

* Overwrite python version inheritance for postgres in travis.yml

* Add quotes around python version in .travis.yml

* Add quotes around the name of the job

* Try a travis fix

* Try .travis.yml fix

* Import missing subprocess

* Refactor travis.yml

* Refactor travis.yml
- move install and tests commands to separate files
- Use matrix to build combination of python version and db type

* Make install.sh and run-tests.sh executable

* Add sudo required to travis.yml to allow sudo cmmands in shell files

* Load nvm

* Remove verbose flag from scripts

* Remove command-trace-print flag

* Change to build dir in before script

* Add absolute path for scripts

* Fix tests

* Fix typo

* Fix codacy
- fixes - "echo won't expand escape sequences." warning

* Append (_) underscore instead of 'd' for db_name

* Remove printf and use mysql execute flag

.travis.yml

@@ -1,49 +1,41 @@
 language: python
 dist: trusty
+sudo: required
 
 python:
-  - "2.7"
-  - "3.6"
+  - 2.7
+  - 3.6
+
+env:
+  - DB=mariadb
+  - DB=postgres
 
 services:
   - mysql
 
-install:
-  - sudo rm /etc/apt/sources.list.d/mongodb*.list
-  - sudo rm /etc/apt/sources.list.d/docker.list
-  - sudo apt-get install hhvm && rm -rf /home/travis/.kiex/
-  - sudo apt-get purge -y mysql-common mysql-server mysql-client
-  - nvm install v8.10.0
-
-  - pip install python-coveralls
-
-  - wget https://raw.githubusercontent.com/frappe/bench/master/playbooks/install.py
+addons:
+  postgresql: "9.5"
+  hosts:
+    - test_site
+    - test_site_postgres
 
-  - sudo python install.py --develop --user travis --without-bench-setup
-  - sudo pip install -e ~/bench
+matrix:
+  allow_failures:
+  - python: 2.7
+    env: DB=postgres
+  fast_finish: true
 
-  - rm $TRAVIS_BUILD_DIR/.git/shallow
-  - cd ~/ && bench init frappe-bench --python $(which python) --frappe-path $TRAVIS_BUILD_DIR
-  - cp -r $TRAVIS_BUILD_DIR/test_sites/test_site ~/frappe-bench/sites/
+install:
+  - $TRAVIS_BUILD_DIR/.travis/install.sh
 
 before_script:
-  - mysql -u root -ptravis -e 'create database test_frappe'
-  - echo "USE mysql;\nCREATE USER 'test_frappe'@'localhost' IDENTIFIED BY 'test_frappe';\nFLUSH PRIVILEGES;\n" | mysql -u root -ptravis
-  - echo "USE mysql;\nGRANT ALL PRIVILEGES ON \`test_frappe\`.* TO 'test_frappe'@'localhost';\n" | mysql -u root -ptravis
-
-
   - cd ~/frappe-bench
-  - bench use test_site
-  - bench reinstall --yes
-  - bench setup-help
-  - bench setup-global-help --mariadb_root_password travis
-  - bench scheduler disable
   - sed -i 's/9000/9001/g' sites/common_site_config.json
   - bench start &
   - sleep 10
 
 script:
-  - bench run-tests --coverage
+  - $TRAVIS_BUILD_DIR/.travis/run-tests.sh
 
 after_script:
-  - coveralls -b apps/frappe -d ../../sites/.coverage
+  - coveralls -b apps/frappe -d ../../sites/.coverage

.travis/install.sh

@@ -0,0 +1,22 @@
+#!/bin/bash
+
+set -e
+
+sudo rm /etc/apt/sources.list.d/mongodb*.list
+sudo rm /etc/apt/sources.list.d/docker.list
+sudo apt-get install hhvm && rm -rf /home/travis/.kiex/
+sudo apt-get purge -y mysql-common mysql-server mysql-client
+source ~/.nvm/nvm.sh
+nvm install v8.10.0
+
+pip install python-coveralls
+
+wget https://raw.githubusercontent.com/frappe/bench/master/playbooks/install.py
+
+sudo python install.py --develop --user travis --without-bench-setup
+sudo pip install -e ~/bench
+
+rm $TRAVIS_BUILD_DIR/.git/shallow
+cd ~/ && bench init frappe-bench --python $(which python) --frappe-path $TRAVIS_BUILD_DIR
+cp -r $TRAVIS_BUILD_DIR/test_sites/test_site ~/frappe-bench/sites/
+cp -r $TRAVIS_BUILD_DIR/test_sites/test_site_postgres ~/frappe-bench/sites/

.travis/run-tests.sh

@@ -0,0 +1,22 @@
+#!/bin/bash
+
+set -e
+
+if [[ $DB == 'mariadb' ]]; then
+    mysql -u root -ptravis -e 'create database test_frappe'
+    mysql -u root -ptravis -e "USE mysql; CREATE USER 'test_frappe'@'localhost' IDENTIFIED BY 'test_frappe'; FLUSH PRIVILEGES; "
+    mysql -u root -ptravis -e "USE mysql; GRANT ALL PRIVILEGES ON \`test_frappe\`.* TO 'test_frappe'@'localhost';"
+    bench --site test_site reinstall --yes
+    bench --site test_site setup-help
+    bench setup-global-help --root_password travis
+    bench --site test_site scheduler disable
+    bench --site test_site run-tests --coverage
+elif [[ $DB == 'postgres' ]]; then
+    psql -c "CREATE DATABASE test_frappe;" -U postgres
+    psql -c "CREATE USER test_frappe WITH PASSWORD 'test_frappe';" -U postgres
+    bench --site test_site_postgres reinstall --yes
+    bench --site test_site_postgres setup-help
+    bench setup-global-help --db_type=postgres --root_password travis
+    bench --site test_site_postgres scheduler disable
+    bench --site test_site_postgres run-tests --coverage
+fi

bandit.yml

@@ -0,0 +1 @@
+skips: ['B605', 'B404', 'B603', 'B607']

frappe/__init__.py

@@ -168,17 +168,17 @@ def connect(site=None, db_name=None):
 
 	:param site: If site is given, calls `frappe.init`.
 	:param db_name: Optional. Will use from `site_config.json`."""
-	from frappe.database import Database
+	from frappe.database import get_db
 	if site:
 		init(site)
 
-	local.db = Database(user=db_name or local.conf.db_name)
+	local.db = get_db(user=db_name or local.conf.db_name)
 	set_user("Administrator")
 
 def connect_read_only():
-	from frappe.database import Database
+	from frappe.database import get_db
 
-	local.read_only_db = Database(local.conf.slave_host, local.conf.slave_db_name,
+	local.read_only_db = get_db(local.conf.slave_host, local.conf.slave_db_name,
 		local.conf.slave_db_password)
 
 	# swap db connections
@@ -259,7 +259,7 @@ def errprint(msg):
 	:param msg: Message."""
 	msg = as_unicode(msg)
 	if not request or (not "cmd" in local.form_dict) or conf.developer_mode:
-		print(msg.encode('utf-8'))
+		print(msg)
 
 	error_log.append(msg)
 

frappe/app.py

@@ -25,12 +25,6 @@
 from frappe.core.doctype.communication.comment import update_comments_in_parent_after_request
 from frappe import _
 
-# imports - third-party imports
-import pymysql
-from pymysql.constants import ER
-
-# imports - module imports
-
 local_manager = LocalManager([frappe.local])
 
 _site = None
@@ -148,8 +142,8 @@ def handle_exception(e):
 		response = frappe.utils.response.report_error(http_status_code)
 
 	elif (http_status_code==500
-		and isinstance(e, pymysql.InternalError)
-		and e.args[0] in (ER.LOCK_WAIT_TIMEOUT, ER.LOCK_DEADLOCK)):
+		and (frappe.db and isinstance(e, frappe.db.InternalError))
+		and (frappe.db and (frappe.db.is_deadlocked(e) or frappe.db.is_timedout(e)))):
 			http_status_code = 508
 
 	elif http_status_code==401:

frappe/auth.py

@@ -91,7 +91,7 @@ def get_db_name(self):
 
 	def connect(self, ac_name = None):
 		"""connect to db, from ac_name or db_name"""
-		frappe.local.db = frappe.database.Database(user = self.get_db_name(), \
+		frappe.local.db = frappe.database.get_db(user = self.get_db_name(), \
 			password = getattr(conf, 'db_password', ''))
 
 class LoginManager:

frappe/boot.py

@@ -128,19 +128,19 @@ def get_user_pages_or_reports(parent):
 
 	standard_roles = frappe.db.sql("""
 		select distinct
-			tab{parent}.name,
-			tab{parent}.modified,
+			`tab{parent}`.name as name,
+			`tab{parent}`.modified,
 			{column}
 		from `tabHas Role`, `tab{parent}`
 		where
 			`tabHas Role`.role in ({roles})
 			and `tabHas Role`.parent = `tab{parent}`.name
-			and tab{parent}.name not in (
+			and `tab{parent}`.`name` not in (
 				select `tabCustom Role`.{field} from `tabCustom Role`
 				where `tabCustom Role`.{field} is not null)
 			{condition}
 		""".format(parent=parent, column=column, roles = ', '.join(['%s']*len(roles)),
-			field=parent.lower(), condition="and tabReport.disabled=0" if parent == "Report" else ""),
+			field=parent.lower(), condition="and `tabReport`.disabled=0" if parent == "Report" else ""),
 			roles, as_dict=True)
 
 	for p in standard_roles:
@@ -157,7 +157,7 @@ def get_user_pages_or_reports(parent):
 			from `tab{parent}`
 			where
 				(select count(*) from `tabHas Role`
-				where `tabHas Role`.parent=tab{parent}.name) = 0
+				where `tabHas Role`.parent=`tab{parent}`.`name`) = 0
 		""".format(parent=parent, column=column), as_dict=1)
 
 		for p in pages_with_no_roles:
@@ -173,7 +173,7 @@ def get_user_pages_or_reports(parent):
 def get_column(doctype):
 	column = "`tabPage`.title as title"
 	if doctype == "Report":
-		column = "`tabReport`.name as name, `tabReport`.name as title, `tabReport`.ref_doctype, `tabReport`.report_type"
+		column = "`tabReport`.`name` as title, `tabReport`.ref_doctype, `tabReport`.report_type"
 
 	return column
 
@@ -193,9 +193,9 @@ def load_translations(bootinfo):
 
 def get_fullnames():
 	"""map of user fullnames"""
-	ret = frappe.db.sql("""select name, full_name as fullname,
-			user_image as image, gender, email, username
-		from tabUser where enabled=1 and user_type!="Website User" """, as_dict=1)
+	ret = frappe.db.sql("""select `name`, full_name as fullname,
+		user_image as image, gender, email, username
+		from tabUser where enabled=1 and user_type!='Website User'""", as_dict=1)
 
 	d = {}
 	for r in ret:
@@ -245,10 +245,10 @@ def load_print_css(bootinfo, print_settings):
 	bootinfo.print_css = frappe.www.printview.get_print_style(print_settings.print_style or "Modern", for_legacy=True)
 
 def get_unseen_notes():
-	return frappe.db.sql('''select name, title, content, notify_on_every_login from tabNote where notify_on_login=1
+	return frappe.db.sql('''select `name`, title, content, notify_on_every_login from `tabNote` where notify_on_login=1
 		and expire_notification_on > %s and %s not in
 			(select user from `tabNote Seen By` nsb
-				where nsb.parent=tabNote.name)''', (frappe.utils.now(), frappe.session.user), as_dict=True)
+				where nsb.parent=`tabNote`.name)''', (frappe.utils.now(), frappe.session.user), as_dict=True)
 
 def get_gsuite_status():
 	return (frappe.get_value('Gsuite Settings', None, 'enable') == '1')

frappe/cache_manager.py

@@ -67,9 +67,9 @@ def clear_single(dt):
 		clear_single(doctype)
 
 		# clear all parent doctypes
-		for dt in frappe.db.sql("""select parent from tabDocField
-			where fieldtype="Table" and options=%s""", (doctype,)):
-			clear_single(dt[0])
+
+		for dt in frappe.db.get_all('DocField', 'parent', dict(fieldtype='Table', options=doctype)):
+			clear_single(dt.parent)
 
 		# clear all notifications
 		delete_notification_count_for(doctype)

frappe/chat/doctype/chat_profile/chat_profile.py

@@ -79,7 +79,7 @@ def create(user, exists_ok = False, fields = None):
     result = frappe.db.sql("""
         SELECT *
         FROM `tabChat Profile`
-        WHERE user = "{user}"
+        WHERE `user` = '{user}'
     """.format(user = user))
 
     if result:

frappe/commands/site.py

@@ -10,38 +10,38 @@
 from frappe.utils import touch_file, get_site_path
 from six import text_type
 
-# imports - third-party imports
-from pymysql.constants import ER
-
-# imports - module imports
-from frappe.exceptions import SQLError
-
 @click.command('new-site')
 @click.argument('site')
 @click.option('--db-name', help='Database name')
+@click.option('--db-type', default='mariadb', type=click.Choice(['mariadb', 'postgres']), help='Optional "postgres" or "mariadb". Default is "mariadb"')
 @click.option('--mariadb-root-username', default='root', help='Root username for MariaDB')
 @click.option('--mariadb-root-password', help='Root password for MariaDB')
 @click.option('--admin-password', help='Administrator password for new site', default=None)
 @click.option('--verbose', is_flag=True, default=False, help='Verbose')
 @click.option('--force', help='Force restore if site/database already exists', is_flag=True, default=False)
 @click.option('--source_sql', help='Initiate database with a SQL file')
 @click.option('--install-app', multiple=True, help='Install app after installation')
-def new_site(site, mariadb_root_username=None, mariadb_root_password=None, admin_password=None, verbose=False, install_apps=None, source_sql=None, force=None, install_app=None, db_name=None):
+def new_site(site, mariadb_root_username=None, mariadb_root_password=None, admin_password=None,
+	verbose=False, install_apps=None, source_sql=None, force=None, install_app=None,
+	db_name=None, db_type=None):
 	"Create a new site"
 	frappe.init(site=site, new_site=True)
 
-	_new_site(db_name, site, mariadb_root_username=mariadb_root_username, mariadb_root_password=mariadb_root_password, admin_password=admin_password,
-			verbose=verbose, install_apps=install_app, source_sql=source_sql, force=force)
+	_new_site(db_name, site, mariadb_root_username=mariadb_root_username,
+			mariadb_root_password=mariadb_root_password, admin_password=admin_password,
+			verbose=verbose, install_apps=install_app, source_sql=source_sql, force=force,
+			db_type = db_type)
 
 	if len(frappe.utils.get_sites()) == 1:
 		use(site)
 
-def _new_site(db_name, site, mariadb_root_username=None, mariadb_root_password=None, admin_password=None,
-	verbose=False, install_apps=None, source_sql=None,force=False, reinstall=False):
+def _new_site(db_name, site, mariadb_root_username=None, mariadb_root_password=None,
+	admin_password=None, verbose=False, install_apps=None, source_sql=None,force=False,
+	reinstall=False, db_type=None):
 	"""Install a new Frappe site"""
 
 	if not db_name:
-		db_name = hashlib.sha1(site.encode()).hexdigest()[:16]
+		db_name = '_' + hashlib.sha1(site.encode()).hexdigest()[:16]
 
 	from frappe.installer import install_db, make_site_dirs
 	from frappe.installer import install_app as _install_app
@@ -61,8 +61,9 @@ def _new_site(db_name, site, mariadb_root_username=None, mariadb_root_password=N
 	try:
 		installing = touch_file(get_site_path('locks', 'installing.lock'))
 
-		install_db(root_login=mariadb_root_username, root_password=mariadb_root_password, db_name=db_name,
-			admin_password=admin_password, verbose=verbose, source_sql=source_sql,force=force, reinstall=reinstall)
+		install_db(root_login=mariadb_root_username, root_password=mariadb_root_password,
+			db_name=db_name, admin_password=admin_password, verbose=verbose,
+			source_sql=source_sql,force=force, reinstall=reinstall, db_type=db_type)
 
 		apps_to_install = ['frappe'] + (frappe.conf.get("install_apps") or []) + (list(install_apps) or [])
 		for app in apps_to_install:
@@ -347,34 +348,28 @@ def drop_site(site, root_login='root', root_password=None, archived_sites_path=N
 
 def _drop_site(site, root_login='root', root_password=None, archived_sites_path=None, force=False):
 	"Remove site from database and filesystem"
-	from frappe.installer import get_root_connection
-	from frappe.model.db_schema import DbManager
+	from frappe.database import drop_user_and_database
 	from frappe.utils.backups import scheduled_backup
 
 	frappe.init(site=site)
 	frappe.connect()
 
 	try:
 		scheduled_backup(ignore_files=False, force=True)
-	except SQLError as err:
-		if err[0] == ER.NO_SUCH_TABLE:
-			if force:
-				pass
-			else:
-				click.echo("="*80)
-				click.echo("Error: The operation has stopped because backup of {s}'s database failed.".format(s=site))
-				click.echo("Reason: {reason}{sep}".format(reason=err[1], sep="\n"))
-				click.echo("Fix the issue and try again.")
-				click.echo(
-					"Hint: Use 'bench drop-site {s} --force' to force the removal of {s}".format(sep="\n", tab="\t", s=site)
-				)
-				sys.exit(1)
-
-	db_name = frappe.local.conf.db_name
-	frappe.local.db = get_root_connection(root_login, root_password)
-	dbman = DbManager(frappe.local.db)
-	dbman.delete_user(db_name)
-	dbman.drop_database(db_name)
+	except Exception as err:
+		if force:
+			pass
+		else:
+			click.echo("="*80)
+			click.echo("Error: The operation has stopped because backup of {s}'s database failed.".format(s=site))
+			click.echo("Reason: {reason}{sep}".format(reason=err[1], sep="\n"))
+			click.echo("Fix the issue and try again.")
+			click.echo(
+				"Hint: Use 'bench drop-site {s} --force' to force the removal of {s}".format(sep="\n", tab="\t", s=site)
+			)
+			sys.exit(1)
+
+	drop_user_and_database(frappe.conf.db_name, root_login, root_password)
 
 	if not archived_sites_path:
 		archived_sites_path = os.path.join(frappe.get_app_path('frappe'), '..', '..', '..', 'archived_sites')