summaryrefslogtreecommitdiff
path: root/django/db/backends/base/client.py
blob: 69e061b4e976746630b53091523267f5cfb3479b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
class BaseDatabaseClient:
    """
    This class encapsulates all backend-specific methods for opening a
    client shell.
    """
    # This should be a string representing the name of the executable
    # (e.g., "psql"). Subclasses must override this.
    executable_name = None

    def __init__(self, connection):
        # connection is an instance of BaseDatabaseWrapper.
        self.connection = connection

    def runshell(self):
        raise NotImplementedError('subclasses of BaseDatabaseClient must provide a runshell() method')