From f89f469e01e47efe1825d83178e470ec934d19e5 Mon Sep 17 00:00:00 2001
From: mike12345567 <me@michaeldrury.co.uk>
Date: Tue, 28 May 2024 18:31:19 +0100
Subject: [PATCH] Comment to explain what the new documentType meta option
 does.

---
 packages/types/src/sdk/search.ts | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/packages/types/src/sdk/search.ts b/packages/types/src/sdk/search.ts
index a4221280bf..322afa81b7 100644
--- a/packages/types/src/sdk/search.ts
+++ b/packages/types/src/sdk/search.ts
@@ -117,6 +117,9 @@ export interface QueryJson {
     table: Table
     tables?: Record<string, Table>
     renamed?: RenameColumn
+    // specific to SQS/SQLite search on internal tables this can be used
+    // to make sure the documents returned are always filtered down to a
+    // specific document type (such as just rows)
     documentType?: DocumentType
   }
   extra?: {