A SODA Entries In ORDS Configuration File
You use <entry>
elements in the Oracle REST Data Services
(ORDS) configuration file, default.xml
, to configure SODA for REST
behavior.
You specify an <entry>
element as follows in configuration file
default.xml
. This particular entry specifies the value of
1000
for configuration parameter
soda.maxLimit
.
<entry key="soda.maxLimit">1000</entry>
These are the values of entry
attribute key
that
affect SODA behavior:
-
soda.maxLimit
(default:1000
) — The maximum number of records that can be returned at a time, when listing all documents in a collection or using a query-by-example (QBE).This limit takes precedence over a
limit
parameter value used in a REST HTTP operation. For example, ifsoda.maxLimit
is1000
and the value of parameterlimit
is2000
in a givenGET collection
operation, to list the documents in a collection, then at most 1000 documents are listed. -
soda.defaultLimit
(default:100
) — The default number of records to return at a time, when listing all documents in a collection or using a query-by-example (QBE).This limit is overridden by
soda.maxLimit
. -
soda.cachingEnabled
(default:"false"
) — Whether to enable ("true"
) or disable ("false"
) caching of collection metadata. Caching can improve performance by avoiding round-trips when opening a collection. For a production system Oracle recommends setting this to"true"
.Note:
If caching is enabled and you drop a collection and then re-create it, Oracle recommends that you then shut down and then restart ORDS. Otherwise, the collection cache could retain stale entries, which can make SODA operations raise errors or return unpredictable results. For this reason, Oracle recommends a
"true"
value only for a production system, where collections are not being dropped and re-created. -
soda.disableDropCollection
(default:"false"
) — Whether to disable ("true"
) or enable ("false"
) collection dropping. When disabled (attribute value"true"
), attempting to drop a collection raises an error.
See Also:
Understanding Configurable Parameters in Oracle REST Data Services Installation, Configuration, and Development Guide for information about the SODA for REST configuration parameters