Skip to content

Fix schema connection caching #959

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
circulon wants to merge 5 commits into
base: 3.x
Choose a base branch
from
Open

Fix schema connection caching #959

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
9890597
fixed connection caching
circulon Mar 26, 2026
98f34c7
use get_connection() instead of new_connection()
circulon Mar 26, 2026
98fdd26
added Schema tests for connection caching
circulon Mar 26, 2026
bbb85fd
removed debuging print statement
circulon Mar 26, 2026
e6ef7c4
add helper method for query builder
circulon Mar 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 38 additions & 14 deletions src/masoniteorm/schema/Schema.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@ def __init__(
self._dry = dry
self.connection = connection
self.connection_class = connection_class
self._connection_driver = None
self._connection = None
self.grammar = grammar
self.platform = platform
Expand Down Expand Up @@ -132,7 +133,7 @@ def create(self, table):

self._blueprint = Blueprint(
self.grammar,
connection=self.new_connection(),
connection=self.get_connection(),
table=Table(table),
action="create",
platform=self.platform,
Expand All @@ -148,7 +149,7 @@ def create_table_if_not_exists(self, table):

self._blueprint = Blueprint(
self.grammar,
connection=self.new_connection(),
connection=self.get_connection(),
table=Table(table),
action="create_table_if_not_exists",
platform=self.platform,
Expand All @@ -174,7 +175,7 @@ def table(self, table):

self._blueprint = Blueprint(
self.grammar,
connection=self.new_connection(),
connection=self.get_connection(),
table=TableDiff(table),
action="alter",
platform=self.platform,
Expand Down Expand Up @@ -212,15 +213,25 @@ def get_connection_information(self):
}

def new_connection(self):
"""Explicitly creates a new connection."""
if self._dry:
return

self._connection = (
return (
self.connection_class(**self.get_connection_information())
.set_schema(self.schema)
.make_connection()
)

def get_connection(self):
"""Create"""
if self._dry:
return

if self._connection:
return self._connection

self._connection = self.new_connection()
return self._connection

def has_column(self, table, column, query_only=False):
Expand All @@ -238,11 +249,11 @@ def has_column(self, table, column, query_only=False):
self._sql = sql
return sql

return bool(self.new_connection().query(sql, ()))
return bool(self.get_connection().query(sql, ()))

def get_columns(self, table, dict=True):
table = self.platform().get_current_schema(
self.new_connection(), table, schema=self.get_schema()
self.get_connection(), table, schema=self.get_schema()
)
result = {}
if dict:
Expand All @@ -264,7 +275,7 @@ def drop_table(self, table, query_only=False):
self._sql = sql
return sql

return bool(self.new_connection().query(sql, ()))
return bool(self.get_connection().query(sql, ()))

def drop(self, *args, **kwargs):
return self.drop_table(*args, **kwargs)
Expand All @@ -276,7 +287,7 @@ def drop_table_if_exists(self, table, exists=False, query_only=False):
self._sql = sql
return sql

return bool(self.new_connection().query(sql, ()))
return bool(self.get_connection().query(sql, ()))

def rename(self, table, new_name):
sql = self.platform().compile_rename_table(table, new_name)
Expand All @@ -285,7 +296,7 @@ def rename(self, table, new_name):
self._sql = sql
return sql

return bool(self.new_connection().query(sql, ()))
return bool(self.get_connection().query(sql, ()))

def truncate(self, table, foreign_keys=False):
sql = self.platform().compile_truncate(
Expand All @@ -296,7 +307,7 @@ def truncate(self, table, foreign_keys=False):
self._sql = sql
return sql

return bool(self.new_connection().query(sql, ()))
return bool(self.get_connection().query(sql, ()))

def get_schema(self):
"""Gets the schema set on the migration class"""
Expand All @@ -315,7 +326,7 @@ def get_all_tables(self):
self._sql = sql
return sql

result = self.new_connection().query(sql, ())
result = self.get_connection().query(sql, ())

return (
list(map(lambda t: list(t.values())[0], result)) if result else []
Expand All @@ -338,7 +349,7 @@ def has_table(self, table, query_only=False):
self._sql = sql
return sql

return bool(self.new_connection().query(sql, ()))
return bool(self.get_connection().query(sql, ()))

def enable_foreign_key_constraints(self):
sql = self.platform().enable_foreign_key_constraints()
Expand All @@ -347,7 +358,7 @@ def enable_foreign_key_constraints(self):
self._sql = sql
return sql

return bool(self.new_connection().query(sql, ()))
return bool(self.get_connection().query(sql, ()))

def disable_foreign_key_constraints(self):
sql = self.platform().disable_foreign_key_constraints()
Expand All @@ -356,4 +367,17 @@ def disable_foreign_key_constraints(self):
self._sql = sql
return sql

return bool(self.new_connection().query(sql, ()))
return bool(self.get_connection().query(sql, ()))

def query_builder(self):
"""Get a query builder for the schema connection"""
from ..query import QueryBuilder

return QueryBuilder(
connection=self.connection,
connection_class=self.connection_class,
connection_driver=self._connection_driver,
connection_details=self.connection_details,
schema=self.schema,
dry=self.dry,
)
43 changes: 43 additions & 0 deletions tests/schema/test_schema.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
import unittest

from src.masoniteorm.query import QueryBuilder
from src.masoniteorm.schema import Schema
from src.masoniteorm.schema.platforms import SQLitePlatform
from tests.integrations.config.database import DATABASES
from tests.utils import MockSQLiteConnection


class TestSchema(unittest.TestCase):
maxDiff = None

def get_schema(self):
return Schema(
connection="dev",
connection_class=MockSQLiteConnection,
connection_details=DATABASES,
platform=SQLitePlatform,
)

def test_connection_is_cached(self):
schema = self.get_schema()
first_connection = schema.get_connection()
self.assertIsNotNone(first_connection)
second_connection = schema.get_connection()
self.assertIsNotNone(second_connection)
self.assertEqual(first_connection, second_connection)

def test_new_connection_is_not_cached(self):
schema = self.get_schema()
first_connection = schema.get_connection()
self.assertIsNotNone(first_connection)
new_connection = schema.new_connection()
self.assertIsNotNone(new_connection)
second_connection = schema.get_connection()
self.assertIsNotNone(second_connection)
self.assertEqual(first_connection, second_connection)
self.assertNotEqual(new_connection, first_connection)

def test_can_get_query_builder(self):
schema = self.get_schema()
builder = schema.query_builder()
self.assertIsInstance(builder, QueryBuilder)
Loading