ExpandOption Klasa

Opcje ustrukturyzowane właściwości $expand nawigacji.

Umożliwia określenie zagnieżdżonych $selectopcji , $filter, $orderbyi $top dla rozszerzenia pojedynczej właściwości nawigacji zgodnie ze składnią OData $expand .

Example:


   # 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)

Parametry

Nazwa	Opis
relation Wymagane	str Nazwa właściwości nawigacji (z uwzględnieniem wielkości liter).

Metody

filter	Filtruj rozszerzoną kolekcję.
order_by	Sortuj rozszerzoną kolekcję.
select	Wybierz określone kolumny z rozwiniętej jednostki.
to_odata	Skompiluj składnię OData `$expand` .
top	Ogranicz rozwinięte wyniki.

filter

Filtruj rozszerzoną kolekcję.

filter(filter_str: str) -> ExpandOption

Parametry

Nazwa	Opis
filter_str Wymagane	Wyrażenie OData `$filter` .

Zwraca

Typ	Opis
	Self for method chaining (Samozwańce do tworzenia łańcuchów metod).

order_by

Sortuj rozszerzoną kolekcję.

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

Parametry

Nazwa	Opis
column Wymagane	Nazwa kolumny do sortowania według.
descending	Sortuj malejąco, jeśli `True`. Domyślna wartość: False

Zwraca

Typ	Opis
	Self for method chaining (Samozwańce do tworzenia łańcuchów metod).

select

Wybierz określone kolumny z rozwiniętej jednostki.

select(*columns: str) -> ExpandOption

Parametry

Nazwa	Opis
columns Wymagane	Nazwy kolumn do wybrania.

Zwraca

Typ	Opis
	Self for method chaining (Samozwańce do tworzenia łańcuchów metod).

to_odata

Skompiluj składnię OData $expand .

to_odata() -> str

Zwraca

Typ	Opis
str	Rozwiń ciąg OData, taki jak `"Nav($select=col1,col2;$filter=...)"`

top

Ogranicz rozwinięte wyniki.

top(count: int) -> ExpandOption

Parametry

Nazwa	Opis
count Wymagane	Maksymalna liczba rozszerzonych rekordów.

Zwraca

Typ	Opis
	Self for method chaining (Samozwańce do tworzenia łańcuchów metod).