1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
|
Querying
========
Get one entity identified by its key value
------------------------------------------
Get employee identified by 1 and print employee first name:
.. code-block:: python
employee1 = northwind.entity_sets.Employees.get_entity(1).execute()
print(employee1.FirstName)
Get one entity identified by its key value which is not scalar
--------------------------------------------------------------
Get number of orderd units in the order identified by ProductID 42 and OrderID 10248:
.. code-block:: python
order = northwind.entity_sets.Order_Details.get_entity(OrderID=10248, ProductID=42).execute()
print(order.Quantity)
Get all entities of an entity set
---------------------------------
Print unique identification (Id) and last name of all employees:
.. code-block:: python
employees = northwind.entity_sets.Employees.get_entities().select('EmployeeID,LastName').execute()
for employee in employees:
print(employee.EmployeeID, employee.LastName)
Get entities matching a filter
------------------------------
Print unique identification (Id) of all employees with name John Smith:
.. code-block:: python
smith_employees_request = northwind.entity_sets.Employees.get_entities()
smith_employees_request = smith_employees_request.filter("FirstName eq 'John' and LastName eq 'Smith'")
for smith in smith_employees_request.execute():
print(smith.EmployeeID)
Get entities matching a filter in more Pythonic way
---------------------------------------------------
Print unique identification (Id) of all employees with name John Smith:
.. code-block:: python
from pyodata.v2.service import GetEntitySetFilter as esf
smith_employees_request = northwind.entity_sets.Employees.get_entities()
smith_employees_request = smith_employees_request.filter(esf.and_(
smith_employees_request.FirstName == 'Jonh',
smith_employees_request.LastName == 'Smith'))
for smith in smith_employees_request.execute():
print(smith.EmployeeID)
Get entities matching a filter in ORM style
---------------------------------------------------
Print unique identification (Id) of all employees with name John Smith:
.. code-block:: python
from pyodata.v2.service import GetEntitySetFilter as esf
smith_employees_request = northwind.entity_sets.Employees.get_entities()
smith_employees_request = smith_employees_request.filter(FirstName="John", LastName="Smith")
for smith in smith_employees_request.execute():
print(smith.EmployeeID)
Get entities matching a complex filter in ORM style
---------------------------------------------------
Print unique identification (Id) of all employees with name John Smith:
.. code-block:: python
from pyodata.v2.service import GetEntitySetFilter as esf
smith_employees_request = northwind.entity_sets.Employees.get_entities()
smith_employees_request = smith_employees_request.filter(FirstName__contains="oh", LastName__startswith="Smi")
for smith in smith_employees_request.execute():
print(smith.EmployeeID)
Get a count of entities
-----------------------
Print a count of all employees:
.. code-block:: python
count = northwind.entity_sets.Employees.get_entities().count().execute()
print(count)
Print all employees and their count:
.. code-block:: python
employees = northwind.entity_sets.Employees.get_entities().count(inline=True).execute()
print(employees.total_count)
for employee in employees:
print(employee.EmployeeID, employee.LastName)
Get a count of entities via navigation property
-----------------------------------------------
Print a count of all orders associated with Employee 1:
.. code-block:: python
count = northwind.entity_sets.Employees.get_entity(1).nav('Orders').get_entities().count().execute()
print(count)
Print all orders associated with Employee 1 and their count:
.. code-block:: python
orders = northwind.entity_sets.Employees.get_entity(1).nav('Orders').get_entities().count(inline=True).execute()
print(orders.total_count)
for order in orders:
print(order.OrderID, order.ProductID)
Use non-standard OData URL Query parameters
-------------------------------------------
Sometimes services implement extension to OData model and require addition URL
query parameters. In such a case, you can enrich HTTP request made by pyodata with
these parameters by the method `custom(name: str, value: str)`.
.. code-block:: python
employee = northwind.entity_sets.Employees.get_entity(1).custom('sap-client', '100').execute()
.. code-block:: python
employees = northwind.entity_sets.Employees.get_entities().custom('sap-client', '100').custom('$skiptoken', 'ABCD').top(10).execute()
Encode OData URL Path
-------------------------------------------
By default the resource paths of requests are percent encoded. However if this is not what your API expects,
you can disable the encoding with the variable encode_path by setting it to False.
.. code-block:: python
employee = northwind.entity_sets.Employees.get_entity(1, encode_path=False).execute()
Query server-side paginations using the __next field
-------------------------------------------------------------------
Response may contains ony partial listings of the Collection. In this case, "__next" name/value
pair is included, where the value is a URI which identifies the next partial set of entities.
.. code-block:: python
employees = northwind.entity_sets.Employees.get_entities().select('EmployeeID,LastName').execute()
while True:
for employee in employees:
print(employee.EmployeeID, employee.LastName)
# Stop if server has no more entities left
if employees.next_url is None:
break
# We got a partial answer - continue with next page
employees = northwind.entity_sets.Employees.get_entities().next_url(employees.next_url).execute()
|
