File: locking.py

package info (click to toggle)
python-django-postgres-extra 2.0.9-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,096 kB
  • sloc: python: 9,057; makefile: 17; sh: 7; sql: 1
file content (104 lines) | stat: -rw-r--r-- 2,878 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
from enum import Enum
from typing import Optional, Type

from django.db import DEFAULT_DB_ALIAS, connections, models


class PostgresTableLockMode(Enum):
    """List of table locking modes.

    See: https://www.postgresql.org/docs/current/explicit-locking.html
    """

    ACCESS_SHARE = "ACCESS SHARE"
    ROW_SHARE = "ROW SHARE"
    ROW_EXCLUSIVE = "ROW EXCLUSIVE"
    SHARE_UPDATE_EXCLUSIVE = "SHARE UPDATE EXCLUSIVE"
    SHARE = "SHARE"
    SHARE_ROW_EXCLUSIVE = "SHARE ROW EXCLUSIVE"
    EXCLUSIVE = "EXCLUSIVE"
    ACCESS_EXCLUSIVE = "ACCESS EXCLUSIVE"

    @property
    def alias(self) -> str:
        return (
            "".join([word.title() for word in self.name.lower().split("_")])
            + "Lock"
        )


def postgres_lock_table(
    table_name: str,
    lock_mode: PostgresTableLockMode,
    *,
    schema_name: Optional[str] = None,
    using: str = DEFAULT_DB_ALIAS,
) -> None:
    """Locks the specified table with the specified mode.

    The lock is held until the end of the current transaction.

    Arguments:
        table_name:
            Unquoted table name to acquire the lock on.

        lock_mode:
            Type of lock to acquire.

        schema_name:
            Optionally, the unquoted name of the schema
            the table to lock is in. If not specified,
            the table name is resolved by PostgreSQL
            using it's ``search_path``.

        using:
            Optional name of the database connection to use.
    """

    connection = connections[using]

    with connection.cursor() as cursor:
        quoted_fqn = connection.ops.quote_name(table_name)
        if schema_name:
            quoted_fqn = (
                connection.ops.quote_name(schema_name) + "." + quoted_fqn
            )

        cursor.execute(f"LOCK TABLE {quoted_fqn} IN {lock_mode.value} MODE")


def postgres_lock_model(
    model: Type[models.Model],
    lock_mode: PostgresTableLockMode,
    *,
    using: str = DEFAULT_DB_ALIAS,
    schema_name: Optional[str] = None,
) -> None:
    """Locks the specified model with the specified mode.

    The lock is held until the end of the current transaction.

    Arguments:
        model:
            The model of which to lock the table.

        lock_mode:
            Type of lock to acquire.

        schema_name:
            Optionally, the unquoted name of the schema
            the table to lock is in. If not specified,
            the table name is resolved by PostgreSQL
            using it's ``search_path``.

            Django models always reside in the default
            ("public") schema. You should not specify
            this unless you're doing something special.

        using:
            Optional name of the database connection to use.
    """

    postgres_lock_table(
        model._meta.db_table, lock_mode, schema_name=schema_name, using=using
    )