easy_mssql_windows library

Classes

OdbcColumnMeta

Represents metadata for a single column in a result set. This class is used to store information about a column, such as its name and SQL data type, typically obtained from SQLDescribeColW.

OdbcConnector

Manages the lifecycle of an ODBC connection and facilitates query execution.

Extensions

EasyQuery on OdbcConnector

Provides convenience extension methods for the OdbcConnector class, simplifying common database query operations.

Constants

sqlAttrOdbcVersion → const int

sqlcDataTypeBit → const int

sqlcDataTypeChar → const int

sqlcDataTypeDate → const int

sqlcDataTypeDefault → const int

sqlcDataTypeDouble → const int

sqlcDataTypeNumeric → const int

sqlcDataTypeSlong → const int

sqlcDataTypeTime → const int

sqlcDataTypeTimestamp → const int

sqlcDataTypeWchar → const int

sqlDataAtExec → const int

sqlDataTypeBit → const int

sqlDataTypeChar → const int

sqlDataTypeDate → const int

sqlDataTypeDecimal → const int

sqlDataTypeDouble → const int

sqlDataTypeFloat → const int

sqlDataTypeInteger → const int

sqlDataTypeLongvarchar → const int

sqlDataTypeNumeric → const int

sqlDataTypeReal → const int

sqlDataTypeSmallint → const int

sqlDataTypeTime → const int

sqlDataTypeTimestamp → const int

sqlDataTypeVarchar → const int

sqlDataTypeWchar → const int

sqlDataTypeWlongvarchar → const int

sqlDataTypeWvarchar → const int

sqlDriverComplete → const int

sqlDriverNoprompt → const int

sqlError → const int

sqlFreeStmtClose → const int

sqlHandleTypeDbc → const int

sqlHandleTypeEnv → const int

sqlHandleTypeStmt → const int

sqlInvalidHandle → const int

sqlNoData → const int

sqlNoTotal → const int

sqlNts → const int

sqlNullData → const int

sqlOdbcVersion3 → const int

sqlSuccess → const int

sqlSuccessWithInfo → const int

Typedefs

SQLAllocHandleDart = int Function(int handleType, SQLHANDLE inputHandle, Pointer<SQLHANDLE> outputHandle)

Dart signature for SQLAllocHandle.

SQLAllocHandleNative = SQLRETURN Function(Int16 handleType, SQLHANDLE inputHandle, Pointer<SQLHANDLE> outputHandle)

Native signature for SQLAllocHandle. Allocates an environment, connection, statement, or descriptor handle.

SQLDescribeColWDart = int Function(SQLHANDLE stmtHandle, int columnNumber, Pointer<Utf16> columnNamePtr, int nameBufferLength, Pointer<Int16> nameLengthPtr, Pointer<Int16> dataTypePtr, Pointer<Int32> columnSizePtr, Pointer<Int16> decimalDigitsPtr, Pointer<Int16> nullablePtr)

Dart signature for SQLDescribeColW.

SQLDescribeColWNative = SQLRETURN Function(SQLHANDLE stmtHandle, Uint16 columnNumber, Pointer<Utf16> columnNamePtr, Int16 nameBufferLength, Pointer<Int16> nameLengthPtr, Pointer<Int16> dataTypePtr, Pointer<Int32> columnSizePtr, Pointer<Int16> decimalDigitsPtr, Pointer<Int16> nullablePtr)

Native signature for SQLDescribeColW (Unicode version). Returns the result descriptor—column name, type, size, etc.—for one column in the result set.

SQLDisconnectDart = int Function(SQLHANDLE connectionHandle)

Dart signature for the SQLDisconnect ODBC function.

SQLDisconnectNative = SQLRETURN Function(SQLHANDLE connectionHandle)

Native signature for the SQLDisconnect ODBC function. This function closes the connection associated with a specific connection handle.

SQLDriverConnectWDart = int Function(SQLHANDLE dbc, int hwnd, Pointer<Utf16> inConnStr, int inConnStrLen, Pointer<Utf16> outConnStr, int outConnStrMax, Pointer<Int16> outConnStrLen, int completion)

Dart signature for SQLDriverConnectW.

SQLDriverConnectWNative = SQLRETURN Function(SQLHANDLE dbc, IntPtr hwnd, Pointer<Utf16> inConnStr, Int16 inConnStrLen, Pointer<Utf16> outConnStr, Int16 outConnStrMax, Pointer<Int16> outConnStrLen, Int16 completion)

Native signature for SQLDriverConnectW (Unicode version). Establishes a connection to a driver and a data source. More flexible than SQLConnect.

SQLExecDirectWDart = int Function(SQLHANDLE stmt, Pointer<Utf16> sqlStr, int textLength)

Dart signature for SQLExecDirectW.

SQLExecDirectWNative = SQLRETURN Function(SQLHANDLE stmt, Pointer<Utf16> sqlStr, Int32 textLength)

Native signature for SQLExecDirectW (Unicode version). Executes a preparable statement, using the current values of the parameter marker variables if any exist.

SQLFetchDart = int Function(SQLHANDLE stmt)

Dart signature for SQLFetch.

SQLFetchNative = SQLRETURN Function(SQLHANDLE stmt)

Native signature for SQLFetch. Fetches the next rowset of data from the result set and returns data for all bound columns.

SQLFreeHandleDart = int Function(int handleType, SQLHANDLE handle)

Dart signature for SQLFreeHandle.

SQLFreeHandleNative = SQLRETURN Function(Int16 handleType, SQLHANDLE handle)

Native signature for SQLFreeHandle. Frees resources associated with a specific environment, connection, statement, or descriptor handle.

SQLFreeStmtDart = int Function(SQLHANDLE statementHandle, int option)

Dart signature for SQLFreeStmt.

SQLFreeStmtNative = SQLRETURN Function(SQLHANDLE statementHandle, Uint16 option)

Native signature for SQLFreeStmt. Stops processing associated with a specific statement, closes any open cursors, discards pending results, or optionally frees the statement handle.

SQLGetDataDart = int Function(SQLHANDLE stmt, int colNumber, int targetType, Pointer<Void> targetValue, int bufferLength, Pointer<Int64> strLenOrIndPtr)

Dart signature for SQLGetData.

SQLGetDataNative = SQLRETURN Function(SQLHANDLE stmt, Uint16 colNumber, Uint16 targetType, Pointer<Void> targetValue, Int64 bufferLength, Pointer<Int64> strLenOrIndPtr)

Native signature for SQLGetData. Retrieves data for a single column in the current row of the result set. Typically called after SQLFetch.

SQLHANDLE = Pointer<Void>

A generic ODBC handle (e.g., for environment, connection, statement, or descriptor). In C, this is usually a void* or a specific struct pointer.

SQLNumResultColsDart = int Function(SQLHANDLE stmtHandle, Pointer<Int16> columnCountPtr)

Dart signature for SQLNumResultCols.

SQLNumResultColsNative = SQLRETURN Function(SQLHANDLE stmtHandle, Pointer<Int16> columnCountPtr)

Native signature for SQLNumResultCols. Returns the number of columns in a result set.

SQLPOINTER = Pointer<Void>

A generic pointer type used in ODBC, often for output parameters or data buffers.

SQLRETURN = Int16

Represents the return code from an ODBC function. Typically, SQL_SUCCESS (0) or SQL_SUCCESS_WITH_INFO (1) indicate success.

SQLSetEnvAttrDart = int Function(SQLHANDLE envHandle, int attribute, SQLPOINTER valuePtr, int stringLength)

Dart signature for SQLSetEnvAttr.

SQLSetEnvAttrNative = SQLRETURN Function(SQLHANDLE envHandle, Int32 attribute, SQLPOINTER valuePtr, Int32 stringLength)

Native signature for SQLSetEnvAttr. Sets attributes that govern aspects of environments.