Azure / Azure/data-api-builder

[Enhancement]: Predicate operators in REST for GraphQL parity

Offen
#2,823 1 Kommentar 1 Reaktion 0 zugewiesene Personen Auf GitHub ansehen
2.x azure-host ⛅ rest
Vorherrschende Sprache
C#
Sterne
1.5k
Forks
370
Ø Merge
3 T. 22 Std.
Gemergte PRs (30 T.)
9

Beschreibung

## Graphql currently supports:

- `in`: checks if a column's value exists in a specified set of values.
- `contains`: finds a fragment anywhere in a string
- `notContains`: excludes strings containing a fragment
- `startsWith`: matches the beginning of a string
- `endsWith`: matches the end of a string

https://github.com/Azure/data-api-builder/blob/main/src/Core/Models/GraphQLFilterParsers.cs#L655-L701

## What?

Bring REST in parity with GraphQL.

## Why?

REST is our most popular endpoint type.

## How?

Here are the SQL `WHERE` clause equivalents for each `$filter` expression:

### `$filter=Category in ('Books', 'Movies', 'Games')`

```sql
WHERE Category IN ('Books', 'Movies', 'Games')
```

### `$filter=contains(Name, 'son')`

```sql
WHERE Name LIKE '%son%'
```

### `$filter=not contains(Description,'beta')`

or

### `$filter=not(contains(Description, 'beta'))`

```sql
WHERE Description NOT LIKE '%beta%'
```

### `$filter=startsWith(Name, 'Al')`

```sql
WHERE Name LIKE 'Al%'
```

### `$filter=endsWith(Name, 'son')`

```sql
WHERE Name LIKE '%son'
```

### `$filter=contains(Name, 'son') and Category in ('Books', 'Movies')`

```sql
WHERE Name LIKE '%son%' AND Category IN ('Books', 'Movies')
```

## Support

GraphQL only supports these for SQL, we can start there with REST.

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Beginnen Sie mit src/Core/Models/GraphQLFilterParsers.cs in den Zeilen 655-701, um das bestehende Verhalten der Operatoren zu verstehen, und verfolgen Sie anschließend, wo REST $filter-Ausdrücke geparst werden. Als erledigt gilt die Aufgabe, wenn SQL-basierte REST-Filter in, contains, not contains, startsWith und endsWith unterstützen, einschließlich der gezeigten Kombinationen; überprüfen Sie die dokumentierten Beispiele anhand von REST-Antworten.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
csharp, graphql, sql
Bereich
api, backend
Issue-Typ
Feature
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Aktiv
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
58/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.