Find

List records from specified collection

Finds database records. You can pass projection to return record fields you care about. Also, you can include referenced collections to have all that information in one place.

Ensure that your Project Id and API Key are correct
Ensure that your Service user holds enough permissions to query database collection.
If you use more than one database, please provide ClusterId; otherwise, the default database will be used.

GET - Gets all records from Collection "Companies."

curl --location --request GET 'https://api.codemash.io/v2/db/companies/find' \
--header 'X-CM-ProjectId: 7254937f-ad77-4d00-9b35-c2af7841d21b' \
--header 'Authorization: Bearer ebis52*******yUfrX'

POST - Gets all records from Collection "Companies" where company code is equal to "123"

curl --location --request POST 'https://api.codemash.io/v2/db/companies/find' \
--header 'X-CM-ProjectId: 7254937f-ad77-4d00-9b35-c2af7841d21b' \
--header 'Authorization: Bearer ebis52*******yUfrX' \
--header 'Content-Type: application/json' \
--data-raw '{ "filter": "{ code: 123 }"}'

import { db } from 'codemash';

// gets all first 100 employees 
export async function getEmployees() {
    return await db.getRecords('emplpyees', 0, 100);
}

// gets all first 100 active employees
// get only first name and last name - projection
// sort out by created on date in DESC order. 
export async function getActiveEmployees() {    

    const filter = JSON.stringify({ 'is_active': true });
    
    const response = 
        await db.getRecords('employees', 0, 100,
        { first_name: 1, last_name: 1 }, 
        filter, 
        { created_on: -1 });  
              
    return response;
}

var client = new CodeMashClient(apiKey, projectId);
var service = new CodeMashRepository<Person>(client);

var persons = await service.FindAsync(
    x => true,
    new DatabaseFindOptions()
);

Check the docs about entities on how the response records are deserialized into your class objects.

use Codemash\CodemashClient;
use Codemash\CodemashDb;

class CodemashService
{
    protected CodemashDb $codemashDb;
    protected string $collectionName = '{YOUR_COLLECTION_NAME}';

    public function __construct()
    {
        $secretKey = '{YOUR_SECRET_KEY}';
        $projectId = '{YOUR_PROJECT_ID}';

        $client = new CodemashClient($secretKey, $projectId);
        $this->codemashDb = new CodemashDb($client);
    }

    public function find()
    {
        $responseData = $this->codemashDb->findMany([
        	'collectionName' => 'employees',
        	'filter' => [
        		'address' => 'New York',
        	],
        ]);
    }
}

Check the docs on how to form projections, filters, sorting, paging. Check the docs on how to use references.

PreviousDistinct NextFind One

Last updated 2 years ago

Was this helpful?

curl --location --request POST 'https://api.codemash.io/v2/db/companies/find' \ --header 'X-CM-ProjectId: 7254937f-ad77-4d00-9b35-c2af7841d21b' \ --header 'Authorization: Bearer ebis52*******yUfrX' \ --header 'Content-Type: application/json' \ --data-raw '{ "filter": "{ code: 123 }"}'

import { db } from 'codemash'; // gets all first 100 employees export async function getEmployees() { return await db.getRecords('emplpyees', 0, 100); } // gets all first 100 active employees // get only first name and last name - projection // sort out by created on date in DESC order. export async function getActiveEmployees() { const filter = JSON.stringify({ 'is_active': true }); const response = await db.getRecords('employees', 0, 100, { first_name: 1, last_name: 1 }, filter, { created_on: -1 }); return response; }

use Codemash\CodemashClient; use Codemash\CodemashDb; class CodemashService { protected CodemashDb $codemashDb; protected string $collectionName = '{YOUR_COLLECTION_NAME}'; public function __construct() { $secretKey = '{YOUR_SECRET_KEY}'; $projectId = '{YOUR_PROJECT_ID}'; $client = new CodemashClient($secretKey, $projectId); $this->codemashDb = new CodemashDb($client); } public function find() { $responseData = $this->codemashDb->findMany([ 'collectionName' => 'employees', 'filter' => [ 'address' => 'New York', ], ]); } }

{ "total_count": 1, "schema": { "collection_name_as_title": "text", "collection_name": "text", "ui_schema": "text", "json_schema": "text", "database_id": "text", "schema_id": "text", "translatable_fields": [ "text" ] }, "response_status": { "error_code": "text", "message": "text", "stack_trace": "text", "meta": { "ANY_ADDITIONAL_PROPERTY": "text" }, "errors": [ { "error_code": "text", "field_name": "text", "message": "text", "meta": { "ANY_ADDITIONAL_PROPERTY": "text" } } ] }, "result": "text" }

Find

[Find] - List records from specified collection

[Find] - List records from specified collection