/usr/share/pyshared/trytond/backend/table.py is in tryton-server 2.2.1-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 | #This file is part of Tryton. The COPYRIGHT file at the top level of
#this repository contains the full copyright notices and license terms.
class TableHandlerInterface(object):
'''
Define generic interface to handle database table
'''
def __init__(self, cursor, model, module_name=None, history=False):
'''
:param cursor: the database cursor
:param model: the Model linked to the table
:param module_name: the module name
:param history: a boolean to define if it is a history table
'''
super(TableHandlerInterface, self).__init__()
self.cursor = cursor
if history:
self.table_name = model._table + '__history'
else:
self.table_name = model._table
self.object_name = model._name
if history:
self.sequence_name = self.table_name + '___id_seq'
else:
self.sequence_name = self.table_name + '_id_seq'
self.module_name = module_name
self.history = history
@staticmethod
def table_exist(cursor, table_name):
'''
Table exist
:param cursor: the database cursor
:param table_name: the table name
:return: a boolean
'''
raise NotImplementedError
@staticmethod
def table_rename(cursor, old_name, new_name):
'''
Rename table
:param cursor: the database cursor
:param old_name: the old table name
:param new_name: the new table name
'''
raise NotImplementedError
@staticmethod
def sequence_exist(cursor, sequence_name):
'''
Sequence exist
:param cursor: the database cursor
:param sequence_name: the sequence name
:return: a boolean
'''
raise NotImplementedError
@staticmethod
def sequence_rename(cursor, old_name, new_name):
'''
Rename sequence
:param cursor: the database cursor
:param old_name: the old sequence name
:param new_name: the new sequence name
'''
raise NotImplementedError
def column_exist(self, column_name):
'''
Column exist
:param column_name: the column name
:return: a boolean
'''
raise NotImplementedError
def column_rename(self, old_name, new_name, exception=False):
'''
Rename column
:param old_name: the name of the existing column
:param new_name: the new name of the column
:param exception: a boolean to raise or not an exception
if it is not possible to rename the column.
'''
raise NotImplementedError
def alter_size(self, column_name, column_type):
'''
Modify size of a column
:param column_name: the column name
:param column_type: the column definition
'''
raise NotImplementedError
def alter_type(self, column_name, column_type):
'''
Modify type of a column
:param column_name: the column name
:param column_type: the column definition
'''
raise NotImplementedError
def db_default(self, column_name, value):
'''
Set a default on a column
:param column_name: the column name
:param value: the default value
'''
raise NotImplementedError
def add_raw_column(self, column_name, column_type, column_format,
default_fun=None, field_size=None, migrate=True,
string=''):
'''
Add a column
:param column_name: the column name
:param column_type: the column definition
:param column_format: the function to format default value
:param default_fun: the function that return the default value
:param field_size: the size of the column if there is one
:param migrate: boolean to try to migrate the column if exists
:param string: the label of the column
'''
raise NotImplementedError
def add_fk(self, column_name, reference, on_delete=None):
'''
Add a foreign key
:param column_name: the column name
:param reference: the foreign table name
:param on_delete: the "on delete" value
'''
raise NotImplementedError
def drop_fk(self, column_name, table=None):
'''
Drop a foreign key
:param column_name: the column name
:param table: optional table name
'''
raise NotImplementedError
def index_action(self, column_name, action='add', table=None):
'''
Add/remove an index
:param column_name: the column name or a list of column name
:param action: 'add' or 'remove'
:param table: optional table name
'''
raise NotImplementedError
def not_null_action(self, column_name, action='add'):
'''
Add/remove a "not null"
:param column_name: the column name
:param action: 'add' or 'remove'
'''
raise NotImplementedError
def add_constraint(self, ident, constraint, exception=False):
'''
Add a constraint
:param ident: the name of the constraint
:param constraint: the definition of the constraint
:param exception: a boolean to raise or not an exception
if it is not possible to add the constraint
'''
raise NotImplementedError
def drop_constraint(self, ident, exception=False, table=None):
'''
Remove a constraint
:param ident: the name of the constraint
:param exception: a boolean to raise or not an exception
if it is not possible to remove the constraint
:param table: optional table name
'''
raise NotImplementedError
def drop_column(self, column_name, exception=False):
'''
Remove a column
:param column_name: the column name
:param exception: a boolean to raise or not an exception
if it is not possible to remove the column
'''
raise NotImplementedError
@staticmethod
def drop_table(cursor, model, table, cascade=False):
'''
Remove a table and clean ir_model_data from the given model.
:param model: the model name
:param table: the table name
:param cascade: a boolean to add "CASCADE" to the delete query
'''
raise NotImplementedError
|