Provide Filtering capability for designate queries

Registered by Emmanuel Ankutse

Filtering provides the ability to qualify the result set returned by a query to the designate api and thereby provides a search capability. Filtering will ultimately be available on all collections - zones, record sets, rdata of record sets, and pools. However, the first implementation of Filtering will restrict filtering to zones, record sets. Where applicable, privileged users (support and admin) will be able to perform filtering across all tenants by specifying an additional parameter, all_tenants=true, in their queries.

Blueprint information

Status:
Complete
Approver:
None
Priority:
Undefined
Drafter:
None
Direction:
Needs approval
Assignee:
Emmanuel Ankutse
Definition:
Obsolete
Series goal:
None
Implementation:
Unknown
Milestone target:
None
Completed by
Tim Simmons

Related branches

Whiteboard

Basic filtering has been accomplished, i.e. filtering zones, recordsets, etc., each with a limited set of attributes to filter by. Substring matching has also been accomplished, though the functionality of substring matching may need to be restricted to right-side matching to protect the Cloud DNS databases from excessively long search queries.

Implementation of search/filter api for /zones/"record data" (i.e. filtering by IP address) is TBD. Work can begin on the basic implementation, though the API still needs to be finalized.

UPDATE 5/29/25
Filtering zones/id/recordsets?data=x has been implemented. Filtering across all of your zones for a piece of recorddata has not been implemented, but probably doesn't belong in a "filtering" spec, if in Designate at all.

(?)

Work Items

This blueprint contains Public information 
Everyone can see this information.