ColumnProxy Class

Fluent proxy for building OData filter expressions from a column name.

Returned by col. Operator overloads and methods produce FilterExpression instances that can be passed to QueryBuilder.where().

Example:


   from PowerPlatform.Dataverse.models.filters import col

   expr = col("statecode") == 0               # equality
   expr = col("revenue") > 1_000_000          # comparison
   expr = col("name").like("Contoso%")        # startswith
   expr = col("name").is_null()               # null check
   expr = col("statecode").in_([0, 1])        # in

Constructor

ColumnProxy(name: str)

Parameters

Name	Description
name Required

Methods

between	Between filter: `(column ge lo and column le hi)`.
contains	Contains filter: `contains(column, value)`.
endswith	Endswith filter: `endswith(column, value)`.
in_	In filter using `Microsoft.Dynamics.CRM.In`.
is_not_null	Column not null: `column ne null`.
is_null	Column equals null: `column eq null`.
like	Pattern-match filter compiled to the closest OData equivalent.
not_between	Not-between filter: `not (column ge lo and column le hi)`.
not_in	Not-in filter using `Microsoft.Dynamics.CRM.NotIn`.
not_like	Negated pattern-match filter; mirrors like rules then negates.
startswith	Startswith filter: `startswith(column, value)`.

between

Between filter: (column ge lo and column le hi).

between(lo: Any, hi: Any) -> FilterExpression

Parameters

Name	Description
lo Required
hi Required

contains

Contains filter: contains(column, value).

contains(value: str) -> FilterExpression

Parameters

Name	Description
value Required

endswith

Endswith filter: endswith(column, value).

endswith(value: str) -> FilterExpression

Parameters

Name	Description
value Required

in_

In filter using Microsoft.Dynamics.CRM.In.

in_(values: Collection[Any]) -> FilterExpression

Parameters

Name	Description
values Required	Non-empty collection of values.

Exceptions

Type	Description
ValueError	If `values` is empty.

is_not_null

Column not null: column ne null.

is_not_null() -> FilterExpression

is_null

Column equals null: column eq null.

is_null() -> FilterExpression

like

Pattern-match filter compiled to the closest OData equivalent.

like(pattern: str) -> FilterExpression

Parameters

Name	Description
pattern Required	LIKE-style pattern string.

Exceptions

Type	Description
ValueError	If the pattern cannot be reduced to a single OData function.

not_between

Not-between filter: not (column ge lo and column le hi).

not_between(lo: Any, hi: Any) -> FilterExpression

Parameters

Name	Description
lo Required
hi Required

not_in

Not-in filter using Microsoft.Dynamics.CRM.NotIn.

not_in(values: Collection[Any]) -> FilterExpression

Parameters

Name	Description
values Required	Non-empty collection of values.

Exceptions

Type	Description
ValueError	If `values` is empty.

not_like

Negated pattern-match filter; mirrors like rules then negates.

not_like(pattern: str) -> FilterExpression

Parameters

Name	Description
pattern Required	LIKE-style pattern string (same rules as like).

Exceptions

Type	Description
ValueError	If the pattern cannot be reduced to a single OData function.

startswith

Startswith filter: startswith(column, value).

startswith(value: str) -> FilterExpression

Parameters

Name	Description
value Required