Azure / Azure/data-api-builder

[Enh]: Add basic string $filter functions

Aperta
#3,240 0 commenti 8 reazioni 0 assegnatari Vedi su GitHub
2.x graphql mcp-server rest
Lingua principale
C#
Stelle
1.5k
Fork
370
Merge medio
3g 22h
PR unite (30g)
9

Descrizione

## What?

DAB lacks common string filter functions that developers expect when querying text fields. This proposal introduces a minimal and consistent set of string filtering capabilities.

## Why?

Finding specific records today requires creating stored procedures to perform text filtering. This is unnecessary friction for basic scenarios such as searching titles, descriptions, or message content.

Adding these operators enables common filtering patterns without requiring custom SQL while keeping the same query semantics across REST, GraphQL, and MCP.

### Important

The MCP implementation is both in `read-records` and `aggregate-records`.

## How?

## Keywords

### contains

Returns rows where the column contains the specified substring.

REST
`GET /api/Articles?$filter=contains(title,'Fabric')`

GraphQL

```
query {
articles(filter: { title: { contains: "Fabric" } }) {
id
title
}
}
```

TSQL

```
SELECT id, title
FROM dbo.Articles
WHERE title LIKE '%Fabric%'
```

PostgreSQL

```
SELECT id, title
FROM "Articles"
WHERE title LIKE '%Fabric%'
```

MySQL

```
SELECT id, title
FROM Articles
WHERE title LIKE '%Fabric%'
```

Cosmos DB (NoSQL SQL API)

```
SELECT c.id, c.title
FROM c
WHERE CONTAINS(c.title, "Fabric")
```

### startsWith

Returns rows where the column begins with the specified substring.

REST
`GET /api/Articles?$filter=startswith(title,'Fabric')`

GraphQL

```
query {
articles(filter: { title: { startsWith: "Fabric" } }) {
id
title
}
}
```

TSQL

```
SELECT id, title
FROM dbo.Articles
WHERE title LIKE 'Fabric%'
```

PostgreSQL

```
SELECT id, title
FROM "Articles"
WHERE title LIKE 'Fabric%'
```

MySQL

```
SELECT id, title
FROM Articles
WHERE title LIKE 'Fabric%'
```

Cosmos DB (NoSQL SQL API)

```
SELECT c.id, c.title
FROM c
WHERE STARTSWITH(c.title, "Fabric")
```

### endsWith

Returns rows where the column ends with the specified substring.

REST
`GET /api/Articles?$filter=endswith(title,'SQL')`

GraphQL

```
query {
articles(filter: { title: { endsWith: "SQL" } }) {
id
title
}
}
```

TSQL

```
SELECT id, title
FROM dbo.Articles
WHERE title LIKE '%SQL'
```

PostgreSQL

```
SELECT id, title
FROM "Articles"
WHERE title LIKE '%SQL'
```

MySQL

```
SELECT id, title
FROM Articles
WHERE title LIKE '%SQL'
```

Cosmos DB (NoSQL SQL API)

```
SELECT c.id, c.title
FROM c
WHERE ENDSWITH(c.title, "SQL")
```

### regex

Returns rows where the column matches the specified regular expression pattern. SQL Server support exists in SQL Server 2025, Azure SQL Database, Azure SQL Managed Instance, and SQL database in Microsoft Fabric through `REGEXP_LIKE`, and it requires compatibility level 170. PostgreSQL supports POSIX regex with the `~` operator. MySQL supports regex with `REGEXP_LIKE()` and `REGEXP`/`RLIKE`. Azure Cosmos DB for NoSQL supports `RegexMatch()`. ([[Microsoft Learn](https://learn.microsoft.com/en-us/sql/t-sql/functions/regexp-like-transact-sql?view=sql-server-ver17&utm_source=chatgpt.com)][1])

REST
`GET /api/Articles?$filter=regex(title,'SQL$')`

GraphQL

```graphql
query {
articles(filter: { title: { regex: "SQL$" } }) {
id
title
}
}
```

TSQL

```sql
SELECT id, title
FROM dbo.Articles
WHERE REGEXP_LIKE(title, 'SQL$')
```

PostgreSQL

```sql
SELECT id, title
FROM "Articles"
WHERE title ~ 'SQL$'
```

MySQL

```sql
SELECT id, title
FROM Articles
WHERE REGEXP_LIKE(title, 'SQL$')
```

Cosmos DB (NoSQL SQL API)

```sql
SELECT c.id, c.title
FROM c
WHERE RegexMatch(c.title, "SQL$")
```

[1]: https://learn.microsoft.com/en-us/sql/t-sql/functions/regexp-like-transact-sql?view=sql-server-ver17&utm_source=chatgpt.com "REGEXP_LIKE (Transact-SQL) - SQL Server"

### Configuration

```json
{
"data-source": {
"options": {
"allow-regular-expressions": true // default: true
}
}
}
```

This property lets developers explicitly enable or disable regular expression support for filtering operations. The reason a developer might disable regex is to prevent expensive pattern matching queries that can create unpredictable performance or increase database load.

```
Regular expression filtering is not supported by the configured data source.
```

#### Important

In addition, during startup, the engine also validates the capabilities of the configured data source. If the connected database version does not support regular expressions, the runtime automatically **forces** this setting to `false` to prevent unsupported operations from being exposed.

### Command Line

```bash
dab configure --data-source.options.allow-regular-expressions true
```

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Inizia tracciando come i filtri vengono analizzati e tradotti attraverso gli entry point read-records e aggregate-records di REST, GraphQL e MCP. Esamina la validazione delle capacità della sorgente dati e il comportamento delle query specifico del database indicato prima di definire la copertura degli operatori e della configurazione. Il lavoro è completato quando i comportamenti documentati di contains, startsWith, endsWith e regex funzionano in modo coerente dove supportati e vengono applicati la configurazione di regex e il comportamento per i database non supportati.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
csharp, graphql, mysql, postgresql, sql
Ambito
api, backend-api-design, cli, databases
Tipo di issue
Funzionalità
Difficoltà
5/5
Tempo stimato
Più di una settimana
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.