mirror of
https://github.com/HeidiSQL/HeidiSQL.git
synced 2026-03-13 09:24:25 +08:00
352 lines
12 KiB
ObjectPascal
352 lines
12 KiB
ObjectPascal
unit dbstructures;
|
|
|
|
// Column structures, dll loading
|
|
// For server constants, variables and data types see dbstructures.XXX.pas
|
|
|
|
interface
|
|
|
|
uses
|
|
gnugettext, Vcl.Graphics, Winapi.Windows, System.SysUtils, System.Classes, System.IOUtils,
|
|
System.Generics.Collections, StrUtils;
|
|
|
|
|
|
type
|
|
|
|
TNetType = (
|
|
ntMySQL_TCPIP,
|
|
ntMySQL_NamedPipe,
|
|
ntMySQL_SSHtunnel,
|
|
ntMSSQL_NamedPipe,
|
|
ntMSSQL_TCPIP,
|
|
ntMSSQL_SPX,
|
|
ntMSSQL_VINES,
|
|
ntMSSQL_RPC,
|
|
ntPgSQL_TCPIP,
|
|
ntPgSQL_SSHtunnel,
|
|
ntSQLite,
|
|
ntMySQL_ProxySQLAdmin,
|
|
ntInterbase_TCPIP,
|
|
ntInterbase_Local,
|
|
ntFirebird_TCPIP,
|
|
ntFirebird_Local,
|
|
ntMySQL_RDS,
|
|
ntSQLiteEncrypted
|
|
);
|
|
TNetTypeGroup = (ngMySQL, ngMSSQL, ngPgSQL, ngSQLite, ngInterbase);
|
|
TNetTypeLibs = TDictionary<TNetType, TStringList>;
|
|
|
|
// SQL query ids and provider
|
|
TQueryId = (qDatabaseTable, qDatabaseTableId, qDatabaseDrop,
|
|
qDbObjectsTable, qDbObjectsCreateCol, qDbObjectsUpdateCol, qDbObjectsTypeCol,
|
|
qEmptyTable, qRenameTable, qRenameView, qCurrentUserHost, qLikeCompare,
|
|
qAddColumn, qChangeColumn, qRenameColumn, qForeignKeyEventAction,
|
|
qGlobalStatus, qCommandsCounters, qSessionVariables, qGlobalVariables,
|
|
qISSchemaCol,
|
|
qUSEQuery, qKillQuery, qKillProcess,
|
|
qFuncLength, qFuncCeil, qFuncLeft, qFuncNow, qFuncLastAutoIncNumber,
|
|
qLockedTables, qDisableForeignKeyChecks, qEnableForeignKeyChecks,
|
|
qOrderAsc, qOrderDesc,
|
|
qForeignKeyDrop);
|
|
TSqlProvider = class
|
|
strict protected
|
|
FNetType: TNetType;
|
|
FServerVersion: Integer;
|
|
public
|
|
constructor Create(ANetType: TNetType);
|
|
function GetSql(AId: TQueryId): string; overload; virtual;
|
|
function GetSql(AId: TQueryId; const Args: array of const): string; overload;
|
|
property ServerVersion: Integer read FServerVersion write FServerVersion;
|
|
end;
|
|
|
|
// Column types
|
|
TDBDatatypeIndex = (dbdtTinyint, dbdtSmallint, dbdtMediumint, dbdtInt, dbdtUint, dbdtBigint, dbdtSerial, dbdtBigSerial,
|
|
dbdtFloat, dbdtDouble, dbdtDecimal, dbdtNumeric, dbdtReal, dbdtDoublePrecision, dbdtMoney, dbdtSmallmoney,
|
|
dbdtDate, dbdtTime, dbdtYear, dbdtDatetime, dbdtDatetime2, dbdtDatetimeOffset, dbdtSmalldatetime, dbdtTimestamp, dbdtInterval,
|
|
dbdtChar, dbdtNchar, dbdtVarchar, dbdtNvarchar, dbdtTinytext, dbdtText, dbdtCiText, dbdtNtext, dbdtMediumtext, dbdtLongtext,
|
|
dbdtJson, dbdtJsonB, dbdtCidr, dbdtInet, dbdtMacaddr,
|
|
dbdtBinary, dbdtVarbinary, dbdtTinyblob, dbdtBlob, dbdtMediumblob, dbdtLongblob, dbdtVector, dbdtImage,
|
|
dbdtEnum, dbdtSet, dbdtBit, dbdtVarBit, dbdtBool, dbdtRegClass, dbdtRegProc, dbdtUnknown,
|
|
dbdtCursor, dbdtSqlvariant, dbdtTable, dbdtUniqueidentifier, dbdtInet4, dbdtInet6, dbdtHierarchyid, dbdtXML,
|
|
dbdtPoint, dbdtLinestring, dbdtLineSegment, dbdtPolygon, dbdtGeometry, dbdtBox, dbdtPath, dbdtCircle, dbdtMultipoint, dbdtMultilinestring, dbdtMultipolygon, dbdtGeometrycollection
|
|
);
|
|
|
|
// Column type categorization
|
|
TDBDatatypeCategoryIndex = (dtcInteger, dtcReal, dtcText, dtcBinary, dtcTemporal, dtcSpatial, dtcOther);
|
|
|
|
// Column type structure
|
|
TDBDatatype = record
|
|
Index: TDBDatatypeIndex;
|
|
NativeType: Integer; // MySQL column type constant (e.g. 1 = TINYINT). See include/mysql.h.pp.
|
|
NativeTypes: String; // Same as above, but for multiple ids (e.g. PostgreSQL oids). Prefer over NativeType. See GetDatatypeByNativeType.
|
|
Name: String;
|
|
Names: String;
|
|
Description: String;
|
|
HasLength: Boolean; // Can have Length- or Set-attribute?
|
|
RequiresLength: Boolean; // Must have a Length- or Set-attribute?
|
|
MaxSize: Int64;
|
|
DefaultSize: Int64; // TEXT and BLOB allow custom length, but we want to leave the default max length away from ALTER TABLE's
|
|
HasBinary: Boolean; // Can be binary?
|
|
HasDefault: Boolean; // Can have a default value?
|
|
LoadPart: Boolean; // Select per SUBSTR() or LEFT()
|
|
DefLengthSet: String; // Should be set for types which require a length/set
|
|
Format: String; // Used for date/time values when displaying and generating queries
|
|
ValueMustMatch: String;
|
|
Category: TDBDatatypeCategoryIndex;
|
|
MinVersion: Integer;
|
|
end;
|
|
|
|
// Column type category structure
|
|
TDBDatatypeCategory = record
|
|
Index: TDBDatatypeCategoryIndex;
|
|
Name: String;
|
|
Color: TColor;
|
|
NullColor: TColor;
|
|
end;
|
|
|
|
// Server variables
|
|
TVarScope = (vsGlobal, vsSession, vsBoth);
|
|
TServerVariable = record
|
|
Name: String;
|
|
IsDynamic: Boolean;
|
|
VarScope: TVarScope;
|
|
EnumValues: String;
|
|
end;
|
|
|
|
// Custom exception class for any connection or database related error
|
|
EDbError = class(Exception)
|
|
private
|
|
FErrorCode: Cardinal;
|
|
FHint: String;
|
|
public
|
|
property ErrorCode: Cardinal read FErrorCode;
|
|
property Hint: String read FHint;
|
|
constructor Create(const Msg: string; const ErrorCode_: Cardinal=0; const Hint_: String='');
|
|
end;
|
|
|
|
// DLL loading
|
|
TDbLib = class(TObject)
|
|
const
|
|
LIB_PROC_ERROR: Cardinal = 1000;
|
|
private
|
|
FHandle: HMODULE;
|
|
protected
|
|
FDllFile: String;
|
|
procedure AssignProc(var Proc: FARPROC; Name: PAnsiChar; Mandantory: Boolean=True);
|
|
procedure AssignProcedures; virtual; abstract;
|
|
public
|
|
property Handle: HMODULE read FHandle;
|
|
property DllFile: String read FDllFile;
|
|
constructor Create(UsedDllFile, HintDefaultDll: String); virtual;
|
|
destructor Destroy; override;
|
|
end;
|
|
|
|
|
|
var
|
|
|
|
// Column type categories
|
|
DatatypeCategories: array[TDBDatatypeCategoryIndex] of TDBDatatypeCategory = (
|
|
(
|
|
Index: dtcInteger;
|
|
Name: 'Integer'
|
|
),
|
|
(
|
|
Index: dtcReal;
|
|
Name: 'Real'
|
|
),
|
|
(
|
|
Index: dtcText;
|
|
Name: 'Text'
|
|
),
|
|
(
|
|
Index: dtcBinary;
|
|
Name: 'Binary'
|
|
),
|
|
(
|
|
Index: dtcTemporal;
|
|
Name: 'Temporal (time)'
|
|
),
|
|
(
|
|
Index: dtcSpatial;
|
|
Name: 'Spatial (geometry)'
|
|
),
|
|
(
|
|
Index: dtcOther;
|
|
Name: 'Other'
|
|
)
|
|
);
|
|
|
|
|
|
|
|
implementation
|
|
|
|
uses apphelpers;
|
|
|
|
|
|
{ TSqlProvider }
|
|
|
|
constructor TSqlProvider.Create(ANetType: TNetType);
|
|
begin
|
|
FNetType := ANetType;
|
|
FServerVersion := 0;
|
|
end;
|
|
|
|
function TSqlProvider.GetSql(AId: TQueryId): string;
|
|
begin
|
|
// This provides default values for queries, basically MySQL syntax
|
|
case AId of
|
|
// qDatabaseTable: MSSQL only
|
|
// qDatabaseTableId: MSSQL only
|
|
qDatabaseDrop: Result := 'DROP DATABASE %s';
|
|
// qDbObjectsTable: MSSQL only
|
|
// qDbObjectsCreateCol: MSSQL only
|
|
// qDbObjectsUpdateCol: MSSQL only
|
|
// qDbObjectsTypeCol: MSSQL only
|
|
qEmptyTable: Result := 'TRUNCATE ';
|
|
qRenameTable: Result := 'RENAME TABLE %s TO %s';
|
|
qRenameView: Result := 'RENAME TABLE %s TO %s';
|
|
qCurrentUserHost: Result := 'SELECT CURRENT_USER()';
|
|
qLikeCompare: Result := '%s LIKE %s';
|
|
qAddColumn: Result := 'ADD COLUMN %s';
|
|
qChangeColumn: Result := 'CHANGE COLUMN %s %s';
|
|
// qRenameColumn: PostgreSQL only
|
|
qForeignKeyEventAction: Result := 'RESTRICT,CASCADE,SET NULL,NO ACTION';
|
|
qGlobalStatus: Result := IfThen(
|
|
FNetType = ntMySQL_ProxySQLAdmin,
|
|
'SELECT * FROM stats_mysql_global',
|
|
'SHOW /*!50002 GLOBAL */ STATUS'
|
|
);
|
|
qCommandsCounters: Result := IfThen(
|
|
FNetType = ntMySQL_ProxySQLAdmin,
|
|
'SELECT * FROM stats_mysql_commands_counters',
|
|
'SHOW /*!50002 GLOBAL */ STATUS LIKE ''Com\_%'''
|
|
);
|
|
qSessionVariables: Result := 'SHOW VARIABLES';
|
|
qGlobalVariables: Result := 'SHOW GLOBAL VARIABLES';
|
|
qISSchemaCol: Result := '%s_SCHEMA';
|
|
qUSEQuery: Result := 'USE %s';
|
|
qKillQuery: Result := IfThen(
|
|
FNetType = ntMySQL_RDS,
|
|
'CALL mysql.rds_kill_query(%d)',
|
|
'KILL %d'
|
|
);
|
|
qKillProcess: Result := IfThen(
|
|
FNetType = ntMySQL_RDS,
|
|
'CALL mysql.rds_kill(%d)',
|
|
'KILL %d'
|
|
);
|
|
qFuncLength: Result := 'LENGTH';
|
|
qFuncCeil: Result := 'CEIL';
|
|
qFuncLeft: Result := IfThen(
|
|
FNetType = ntMySQL_ProxySQLAdmin,
|
|
'SUBSTR(%s, 1, %d)',
|
|
'LEFT(%s, %d)'
|
|
);
|
|
qFuncNow: Result := IfThen(
|
|
FNetType = ntMySQL_ProxySQLAdmin,
|
|
'CURRENT_TIMESTAMP',
|
|
'NOW()'
|
|
);
|
|
qFuncLastAutoIncNumber: Result := 'LAST_INSERT_ID()';
|
|
qLockedTables: Result := IfThen(
|
|
(FNetType <> ntMySQL_ProxySQLAdmin) and (FServerVersion >= 50124),
|
|
'SHOW OPEN TABLES FROM %s WHERE in_use!=0',
|
|
''
|
|
);
|
|
qDisableForeignKeyChecks: Result := 'SET @OLD_FOREIGN_KEY_CHECKS=@@FOREIGN_KEY_CHECKS, FOREIGN_KEY_CHECKS=0';
|
|
qEnableForeignKeyChecks: Result := 'SET FOREIGN_KEY_CHECKS=IFNULL(@OLD_FOREIGN_KEY_CHECKS, 1)';
|
|
qOrderAsc: Result := 'ASC';
|
|
qOrderDesc: Result := 'DESC';
|
|
qForeignKeyDrop: Result := 'DROP FOREIGN KEY %s';
|
|
else Result := '';
|
|
end;
|
|
end;
|
|
|
|
function TSqlProvider.GetSql(AId: TQueryId; const Args: array of const): string;
|
|
begin
|
|
Result := GetSql(AId);
|
|
if not Result.IsEmpty then
|
|
Result := Format(Result, Args);
|
|
end;
|
|
|
|
|
|
|
|
|
|
{ EDbError }
|
|
|
|
constructor EDbError.Create(const Msg: string; const ErrorCode_: Cardinal=0; const Hint_: String='');
|
|
begin
|
|
FErrorCode := ErrorCode_;
|
|
FHint := Hint_;
|
|
inherited Create(Msg);
|
|
end;
|
|
|
|
|
|
|
|
{ TDbLib }
|
|
|
|
constructor TDbLib.Create(UsedDllFile, HintDefaultDll: String);
|
|
var
|
|
msg, ErrorHint: String;
|
|
begin
|
|
// Load DLL as is (with or without path)
|
|
inherited Create;
|
|
FDllFile := UsedDllFile;
|
|
// On Windows, we have the full path to the dll file here, so even if the file portion is empty, FDllFile contains a path / non-empty string
|
|
if not FileExists(FDllFile) then begin
|
|
Raise EdbError.Create(_('No library selected. Please select one of the provided libraries in the drop-down.'));
|
|
end;
|
|
|
|
FHandle := LoadLibrary(PWideChar(FDllFile));
|
|
if FHandle = 0 then begin
|
|
msg := f_('Library %s could not be loaded. Please select a different one.',
|
|
[ExtractFileName(FDllFile)]
|
|
);
|
|
if GetLastError <> 0 then begin
|
|
msg := msg + sLineBreak + sLineBreak + f_('Internal error %d: %s', [GetLastError, SysErrorMessage(GetLastError)]);
|
|
end;
|
|
if (HintDefaultDll <> '') and (ExtractFileName(FDllFile) <> HintDefaultDll) then begin
|
|
ErrorHint := f_('You could try the default library %s in your session settings. (Current: %s)',
|
|
[HintDefaultDll, ExtractFileName(FDllFile)]
|
|
);
|
|
end else begin
|
|
ErrorHint := '';
|
|
end;
|
|
Raise EDbError.Create(msg, GetLastError, ErrorHint);
|
|
end;
|
|
|
|
// Dll was loaded, now initialize required procedures
|
|
AssignProcedures;
|
|
end;
|
|
|
|
|
|
destructor TDbLib.Destroy;
|
|
begin
|
|
if FHandle <> 0 then begin
|
|
FreeLibrary(FHandle);
|
|
FHandle := 0;
|
|
end;
|
|
inherited;
|
|
end;
|
|
|
|
|
|
procedure TDbLib.AssignProc(var Proc: FARPROC; Name: PAnsiChar; Mandantory: Boolean=True);
|
|
var
|
|
msg: String;
|
|
begin
|
|
// Map library procedure to internal procedure
|
|
Proc := GetProcAddress(FHandle, Name);
|
|
if Proc = nil then begin
|
|
if Mandantory then begin
|
|
msg := f_('Library error in %s: Could not find procedure address for "%s"',
|
|
[ExtractFileName(FDllFile), Name]
|
|
);
|
|
if GetLastError <> 0 then
|
|
msg := msg + sLineBreak + sLineBreak + f_('Internal error %d: %s', [GetLastError, SysErrorMessage(GetLastError)]);
|
|
Raise EDbError.Create(msg, LIB_PROC_ERROR);
|
|
end;
|
|
end;
|
|
end;
|
|
|
|
|
|
end.
|