bknd-crud-read_skill

Overview

This skill helps you query and retrieve data from Bknd entities using the SDK or REST API. It covers single and multiple reads, field selection, filtering, sorting, pagination, loading relations (with/join), and response handling to build reliable data reads for apps and integrations.

How this skill works

Use the SDK methods (readOne, readOneBy, readMany) or REST endpoints to run queries against your Bknd project. Compose a query object with where, sort, select, limit/offset, with or join to shape results; inspect the returned ok/data/meta/error structure to handle success and failures. For complex filters use POST /api/data/:entity/query and for related-field filters include join.

When to use it

• Display lists, tables, or detail pages in an application
• Implement search, filters, and paginated views
• Load related data (author, comments) efficiently
• Run admin or integration read-only operations via API
• Verify data during development or debugging

Best practices

• Always check ok and handle undefined data before accessing fields
• Use select to reduce payload and improve performance
• Prefer with to batch-load relations and avoid N+1 queries
• Use join when you need to filter or sort by related fields
• Use $ilike for case-insensitive text searches and correct operator syntax

Example use cases

• Fetch a single post with author and comments for a detail page using readOne with with
• List published posts with sorting and pagination via readMany with limit/offset
• Search posts by title with debounce using readMany and $ilike
• Filter posts by author.role using join and a where clause on the joined field
• Count or check existence (count/exists) to show totals or guard creation flows