dart_odbc 1.1.0+1

A Dart package for interacting with ODBC databases. It allows you to connect to ODBC data sources and execute SQL queries directly from your Dart applications.

dart_odbc

This is an api library for communicating with the odbc driver from dart This package is inspired by the original odbc (obsolete).

Usage

• Instanciate the ODBC class by providing the path to the odbc driver on the host machine

  final odbc = DartOdbc('/path/to/the/odbc/driver');

Path to ODBC Driver

Path to the ODBC driver can be found in the ODBC driver manager. In windows this is a .dll file that is there in the installation folder of the ODBC driver. In linux this has an extension of .so. In macos this should have an extension of .dylib.

• Connect to the database by providing the DSN (Data Source Name) configured in the ODBC Driver Manager

  odbc.connect(
    dsn: '<your_dsn>',
    username: 'db_username',
    password: 'db_password',
  );

DSN (Data Source Name)

This is the name you gave when setting up the driver manager. For more information, visit this page from the MySQL Documentation

• In case the path privided to the driver is invalid or there is any issue with setting up the environment/connecting to the database, an Exception will be thrown when intanciating the ODBC or connecting to the database.
• Execute your queries directly as follows

  final result = odbc.execute("SELECT 10");

• Result will be a List of Map objects where each Map represents a row. If anything goes wrong an Exception will be thrown

Accessing low level API

• Since this package is at its early stage, most advanced functionalities are not implemented or tested yet. In case you need more functionality, the direct access to the ODBC driver can be obtained by importing the LibODBC class from ffi/libodbc.dart.

• For more information on the ODBC api go to Microsoft ODBC Documentation

TODO:

• ✅ Implement query sanitization
• ❌ Do more testing on different databases
  • ✅ MS SQL Server
  • ❌ Oracle server
• ❌ Improve documentation