# MSSQL (Microsoft SQL Server) Client

Execute SQL queries and statements against Microsoft SQL Server databases with full type safety and runtime validation.

## Methods

| Method                                      | Description                                                                |
| ------------------------------------------- | -------------------------------------------------------------------------- |
| `query<T>(sql, schema, params?, metadata?)` | Execute a SELECT query and return validated, typed results                 |
| `execute(sql, params?, metadata?)`          | Execute a statement (INSERT, UPDATE, DELETE) and return affected row count |

## Usage

### Basic Query with Schema Validation

```typescript
import { api, z, mssql } from "@superblocksteam/sdk-api";

// Integration ID from the integrations panel
const PROD_MSSQL = "a1b2c3d4-5678-90ab-cdef-mssql0000001";

const UserSchema = z.object({
  id: z.number(),
  name: z.string(),
  email: z.string().email(),
  created_at: z.string(),
});

export default api({
  integrations: {
    mssql: mssql(PROD_MSSQL),
  },
  name: "MSSQLExample",
  input: z.object({
    status: z.string(),
  }),
  output: z.object({
    users: z.array(UserSchema),
  }),
  async run(ctx, { status }) {
    const users = await ctx.integrations.mssql.query(
      "SELECT id, name, email, created_at FROM users WHERE status = @PARAM_1",
      UserSchema,
      [status],
    );

    return { users };
  },
});
```

### Executing INSERT, UPDATE, DELETE Statements

```typescript
// INSERT
await ctx.integrations.mssql.execute(
  "INSERT INTO users (name, email) VALUES (@PARAM_1, @PARAM_2)",
  ["John Doe", "john@example.com"],
);

// UPDATE
const updateResult = await ctx.integrations.mssql.execute(
  "UPDATE users SET last_login = GETDATE() WHERE id = @PARAM_1",
  [userId],
);
console.log(`Updated ${updateResult.rowCount} rows`);

// DELETE
const deleteResult = await ctx.integrations.mssql.execute(
  "DELETE FROM sessions WHERE expires_at < GETDATE()",
);
console.log(`Deleted ${deleteResult.rowCount} expired sessions`);
```

### Using SQL Server-Specific Functions

```typescript
const AnalyticsSchema = z.object({
  date: z.string(),
  total_sales: z.string(),
  order_count: z.coerce.number(),
});

const analytics = await ctx.integrations.mssql.query(
  `SELECT
    CONVERT(DATE, order_date) as date,
    SUM(total) as total_sales,
    COUNT(*) as order_count
  FROM orders
  WHERE order_date >= DATEADD(day, -30, GETDATE())
  GROUP BY CONVERT(DATE, order_date)
  ORDER BY date DESC`,
  AnalyticsSchema,
);
```

## Trace Metadata

All methods accept an optional `metadata` parameter as the last argument for diagnostics labeling. See the [root SDK README](../../../README.md#trace-metadata) for details.

## Common Pitfalls

### BIGINT Values Returned as Strings

```typescript
const schema = z.object({
  id: z.coerce.number(),
  count: z.coerce.number(),
});
```

### MONEY/DECIMAL Values Returned as Strings

```typescript
const schema = z.object({
  price: z.string().transform((val) => parseFloat(val)),
});
```

### Schema Parameter is Required

```typescript
// CORRECT - Schema is required
const users = await ctx.integrations.mssql.query(
  "SELECT * FROM users",
  UserSchema,
);
```

### NULL Handling

```typescript
const schema = z.object({
  name: z.string(),
  bio: z.string().nullable(),
});
```

## Error Handling

```typescript
import { QueryValidationError } from "@superblocksteam/sdk-api";

try {
  const users = await ctx.integrations.mssql.query(
    "SELECT * FROM users",
    UserSchema,
  );
} catch (error) {
  if (error instanceof QueryValidationError) {
    console.error("Row index:", error.details.rowIndex);
    console.error("Validation errors:", error.details.errors);
  }
}
```

## API Reference

- [SQL Server Documentation](https://docs.microsoft.com/en-us/sql/sql-server/)
- [SQL Server Data Types](https://docs.microsoft.com/en-us/sql/t-sql/data-types/data-types-transact-sql)