ExpandOption Klasse

Strukturierte Optionen für eine $expand Navigationseigenschaft.

Ermöglicht das Angeben von geschachtelten $select, $filter, $orderbyund $top Optionen für eine einzelne Navigationseigenschaftserweiterung, die auf die OData-Syntax $expand folgt.

Beispiel:


   # Expand Account_Tasks with nested options
   opt = (ExpandOption("Account_Tasks")
          .select("subject", "createdon")
          .filter("contains(subject,'Task')")
          .order_by("createdon", descending=True)
          .top(5))

   query = (client.query.builder("account")
            .select("name")
            .expand(opt)
            .execute())

Konstruktor

ExpandOption(relation: str)

Parameter

Name	Beschreibung
relation Erforderlich	str Name der Navigationseigenschaft (Groß-/Kleinschreibung wird beachtet).

Methoden

filter	Filtern Sie die erweiterte Auflistung.
order_by	Sortieren Sie die erweiterte Auflistung.
select	Wählen Sie bestimmte Spalten aus der erweiterten Entität aus.
to_odata	Kompilieren in OData-Syntax `$expand` .
top	Beschränken Sie erweiterte Ergebnisse.

filter

Filtern Sie die erweiterte Auflistung.

filter(filter_str: str) -> ExpandOption

Parameter

Name	Beschreibung
filter_str Erforderlich	OData-Ausdruck `$filter` .

Gibt zurück

Typ	Beschreibung
	Self for method chaining.

order_by

Sortieren Sie die erweiterte Auflistung.

order_by(column: str, descending: bool = False) -> ExpandOption

Parameter

Name	Beschreibung
column Erforderlich	Spaltenname, nach dem sortiert werden soll.
descending	Absteigend sortieren, wenn `True`. Standardwert: False

Gibt zurück

Typ	Beschreibung
	Self for method chaining.

select

Wählen Sie bestimmte Spalten aus der erweiterten Entität aus.

select(*columns: str) -> ExpandOption

Parameter

Name	Beschreibung
columns Erforderlich	Spaltennamen, die ausgewählt werden sollen.

Gibt zurück

Typ	Beschreibung
	Self for method chaining.

to_odata

Kompilieren in OData-Syntax $expand .

to_odata() -> str

Gibt zurück

Typ	Beschreibung
str	OData-Erweiterungszeichenfolge wie `"Nav($select=col1,col2;$filter=...)"`

top

Beschränken Sie erweiterte Ergebnisse.

top(count: int) -> ExpandOption

Parameter

Name	Beschreibung
count Erforderlich	Maximale Anzahl erweiterter Datensätze.

Gibt zurück

Typ	Beschreibung
	Self for method chaining.