mssql_io 0.0.1

A Flutter plugin that exposes Microsoft SQL Server access using Dart FFI and FreeTDS. Supports Windows, Android, iOS, macOS, and Linux with queries, transactions, bulk insert, and more.

MSSQL IO

A Flutter plugin for connecting to Microsoft SQL Server. Supports Android, iOS, Windows, macOS, and Linux.

Features

• Direct FFI access for high performance
• Parameterized queries to prevent SQL injection
• Transaction support (BEGIN, COMMIT, ROLLBACK)
• Bulk insert operations
• Cross-platform compatibility

Installation

dependencies:
  mssql_io: ^0.0.1

flutter pub get

Setup

Mobile (Android & iOS)

Run the automated build script:

# Android
cd android && ./build_freetds.sh

# iOS (requires macOS)
cd ios && ./build_freetds.sh

First build takes 15-20 minutes (builds FreeTDS library). Subsequent builds are fast.

Desktop

macOS:

brew install freetds

Linux:

sudo apt-get install freetds-dev

Windows:

vcpkg install freetds:x64-windows

Usage

import 'package:mssql_io/mssql_io.dart';

// Connect
final conn = MssqlConnection.getInstance();
await conn.connect(
  host: '192.168.1.100',
  databaseName: 'MyDB',
  username: 'sa',
  password: 'Password123',
);

// Query
final result = await conn.getData('SELECT * FROM Users');
for (final row in result.rows) {
  print('User: ${row['Name']}');
}

// Disconnect
await conn.disconnect();

Common Examples

Parameterized Queries (Prevents SQL Injection)

final result = await conn.getDataWithParams(
  'SELECT * FROM Users WHERE Age > @age',
  [SqlParameter(name: 'age', value: 18)],
);

Insert/Update/Delete

final rows = await conn.writeDataWithParams(
  'INSERT INTO Users (Name, Email) VALUES (@name, @email)',
  [
    SqlParameter(name: 'name', value: 'Alice'),
    SqlParameter(name: 'email', value: '[e-mail]'),
  ],
);
print('Inserted $rows rows');

Transactions

await conn.beginTransaction();
try {
  await conn.writeData('INSERT INTO Orders VALUES (1, 99.99)');
  await conn.writeData('UPDATE Inventory SET Stock = Stock - 1');
  await conn.commit();
} catch (e) {
  await conn.rollback();
}

Bulk Insert

final rows = List.generate(1000, (i) => {'Name': 'User$i', 'Age': 20 + i});
await conn.bulkInsert('Users', rows, batchSize: 500);

API

Main Methods:

• connect() - Connect to SQL Server
• getData() - Execute SELECT query
• getDataWithParams() - Secure parameterized query
• writeData() - Execute INSERT/UPDATE/DELETE
• writeDataWithParams() - Secure parameterized write
• beginTransaction(), commit(), rollback() - Transactions
• bulkInsert() - Batch insert rows
• disconnect() - Close connection

Result Object:

QueryResult {
  columns: ['Id', 'Name', 'Age'],
  rows: [{'Id': 1, 'Name': 'Alice', 'Age': 25}],
  affectedRows: 0
}

Security

Always use parameterized queries to prevent SQL injection:

// Good - Safe
await conn.getDataWithParams(
  'SELECT * FROM Users WHERE Name = @name',
  [SqlParameter(name: 'name', value: userInput)],
);

// Bad - SQL Injection Risk!
await conn.getData("SELECT * FROM Users WHERE Name = '$userInput'");

Troubleshooting

Can't connect?

• Check SQL Server is running on port 1433
• Verify firewall allows connections
• Test: telnet your-server 1433

Library not found?

• Run ./build_freetds.sh in android/ or ios/ folder
• Desktop: Install FreeTDS (brew install freetds on macOS)

Build errors?

flutter clean
flutter pub get
flutter build apk  # or ios

See CONTRIBUTING.md for detailed troubleshooting.

Documentation

• API Documentation
• Example App
• Report Issues
• Changelog
• Contributing

Author

Farhan Sadik Galib - farhansadikgalib.com

License

MIT License - see LICENSE file