ExpandOption Classe

Opzioni strutturate per una $expand proprietà di navigazione.

Consente di specificare le opzioni annidate $select, $filter, $orderbye $top per un'espansione di una singola proprietà di navigazione, seguendo la sintassi OData $expand .

Esempio:


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

Costruttore

ExpandOption(relation: str)

Parametri

Nome	Descrizione
relation Necessario	str Nome della proprietà di navigazione (con distinzione tra maiuscole e minuscole).

Metodi

filter	Filtrare la raccolta espansa.
order_by	Ordinare la raccolta espansa.
select	Selezionare colonne specifiche dall'entità espansa.
to_odata	Compilare in sintassi OData `$expand` .
top	Limitare i risultati espansi.

filter

Filtrare la raccolta espansa.

filter(filter_str: str) -> ExpandOption

Parametri

Nome	Descrizione
filter_str Necessario	Espressione OData `$filter` .

Valori restituiti

Tipo	Descrizione
	Self-for method chaining.

order_by

Ordinare la raccolta espansa.

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

Parametri

Nome	Descrizione
column Necessario	Nome colonna per cui eseguire l'ordinamento.
descending	Ordinamento decrescente se `True`. Valore predefinito: False

Valori restituiti

Tipo	Descrizione
	Self-for method chaining.

select

Selezionare colonne specifiche dall'entità espansa.

select(*columns: str) -> ExpandOption

Parametri

Nome	Descrizione
columns Necessario	Nomi di colonna da selezionare.

Valori restituiti

Tipo	Descrizione
	Self-for method chaining.

to_odata

Compilare in sintassi OData $expand .

to_odata() -> str

Valori restituiti

Tipo	Descrizione
str	Stringa di espansione OData, ad esempio `"Nav($select=col1,col2;$filter=...)"`

top

Limitare i risultati espansi.

top(count: int) -> ExpandOption

Parametri

Nome	Descrizione
count Necessario	Numero massimo di record espansi.

Valori restituiti

Tipo	Descrizione
	Self-for method chaining.