firestore-batch-updater 1.12.0 → 1.13.0

package/README.ko.md

@@ -29,6 +29,7 @@
 - 고유값 조회 - `distinct()`로 특정 필드의 중복 없는 값 목록 조회
 - JSON 내보내기/가져오기 - `toJSON()` / `fromJSON()`으로 문서 JSON 파일 내보내기/가져오기
 - 그룹별 개수 조회 - `countBy()`로 특정 필드 값별 문서 수 집계
+- 랜덤 샘플링 - `sample()`로 쿼리 결과에서 랜덤 문서 추출
 - FieldValue 지원 - `increment()`, `arrayUnion()`, `delete()`, `serverTimestamp()` 등 사용 가능
 - 서브컬렉션 & 컬렉션 그룹 - 서브컬렉션 쿼리 또는 동일 이름의 모든 컬렉션 쿼리
 - Dry Run 모드 - 실제 변경 없이 작업 시뮬레이션
@@ -123,6 +124,7 @@ console.log(`${result.successCount}개 문서 업데이트 완료`);
 | `transform(fn, options?)` | 커스텀 함수로 문서 변환 | `TransformResult` |
 | `copyTo(target, options?)` | 다른 컬렉션으로 문서 복사/이동 | `CopyToResult` |
 | `distinct(field)` | 특정 필드의 고유값 조회 | `any[]` |
+| `sample(n)` | 매칭 문서에서 랜덤 샘플 추출 | `{ id, data }[]` |
 | `toJSON(path, options?)` | 문서를 JSON 파일로 내보내기 | `ToJSONResult` |
 | `fromJSON(path, options?)` | JSON 파일에서 문서 가져오기 | `FromJSONResult` |
 | `countBy(field)` | 필드 값별 문서 수 집계 | `CountByResult` |
@@ -779,6 +781,26 @@ await updater.collection("users").toJSON("./backup.json");
 await updater.collection("users_backup").fromJSON("./backup.json");
 ```
 
+### 랜덤 샘플링
+
+```typescript
+// 랜덤으로 5개 문서 추출
+const samples = await updater.collection("users").sample(5);
+samples.forEach(doc => console.log(doc.id, doc.data.name));
+
+// 필터된 결과에서 랜덤 샘플
+const activeUsers = await updater
+  .collection("users")
+  .where("status", "==", "active")
+  .sample(3);
+
+// select와 함께 사용하여 메모리 효율 극대화
+const randomProducts = await updater
+  .collection("products")
+  .select("name", "price")
+  .sample(10);
+```
+
 ### Dry Run 모드
 
 ```typescript

package/README.md

@@ -29,6 +29,7 @@ English | [한국어](./README.ko.md)
 - Distinct values - Use `distinct()` to get unique field values from matching documents
 - JSON export/import - Use `toJSON()` / `fromJSON()` to export/import documents as JSON
 - Group counting - Use `countBy()` to count documents grouped by field value
+- Random sampling - Use `sample()` to get random documents from query results
 - FieldValue support - Use `increment()`, `arrayUnion()`, `delete()`, `serverTimestamp()`, etc.
 - Subcollection & Collection Group - Query subcollections or all collections with the same name
 - Dry run mode - Simulate operations without making changes
@@ -123,6 +124,7 @@ console.log(`Updated ${result.successCount} documents`);
 | `transform(fn, options?)` | Transform docs with custom function | `TransformResult` |
 | `copyTo(target, options?)` | Copy/move docs to another collection | `CopyToResult` |
 | `distinct(field)` | Get unique values of a field | `any[]` |
+| `sample(n)` | Get random sample of matching documents | `{ id, data }[]` |
 | `toJSON(path, options?)` | Export documents to JSON file | `ToJSONResult` |
 | `fromJSON(path, options?)` | Import documents from JSON file | `FromJSONResult` |
 | `countBy(field)` | Count documents grouped by field value | `CountByResult` |
@@ -792,6 +794,26 @@ await updater.collection("users").toJSON("./backup.json");
 await updater.collection("users_backup").fromJSON("./backup.json");
 ```
 
+### Random Sampling
+
+```typescript
+// Get 5 random documents
+const samples = await updater.collection("users").sample(5);
+samples.forEach(doc => console.log(doc.id, doc.data.name));
+
+// Random sample from filtered results
+const activeUsers = await updater
+  .collection("users")
+  .where("status", "==", "active")
+  .sample(3);
+
+// With select for memory efficiency
+const randomProducts = await updater
+  .collection("products")
+  .select("name", "price")
+  .sample(10);
+```
+
 ### Dry Run Mode
 
 ```typescript

package/dist/index.d.mts

@@ -744,6 +744,15 @@ declare class BatchUpdater {
      * @returns Array of unique values
      */
     distinct(field: string): Promise<any[]>;
+    /**
+     * Get a random sample of matching documents
+     * @param n - Number of documents to sample
+     * @returns Array of randomly selected documents with { id, data }
+     */
+    sample(n: number): Promise<{
+        id: string;
+        data: Record<string, any>;
+    }[]>;
     /**
      * Export matching documents to a JSON file
      * @param filePath - Path for the output JSON file

package/dist/index.d.ts

@@ -744,6 +744,15 @@ declare class BatchUpdater {
      * @returns Array of unique values
      */
     distinct(field: string): Promise<any[]>;
+    /**
+     * Get a random sample of matching documents
+     * @param n - Number of documents to sample
+     * @returns Array of randomly selected documents with { id, data }
+     */
+    sample(n: number): Promise<{
+        id: string;
+        data: Record<string, any>;
+    }[]>;
     /**
      * Export matching documents to a JSON file
      * @param filePath - Path for the output JSON file

package/dist/index.js

@@ -1263,6 +1263,34 @@ var BatchUpdater = class {
     }
     return values;
   }
+  /**
+   * Get a random sample of matching documents
+   * @param n - Number of documents to sample
+   * @returns Array of randomly selected documents with { id, data }
+   */
+  async sample(n) {
+    this.validateSetup();
+    if (!Number.isInteger(n) || n < 1) {
+      throw new Error("Sample size must be a positive integer");
+    }
+    const query = this.buildQuery();
+    const snapshot = await query.get();
+    if (snapshot.empty) {
+      return [];
+    }
+    const docs = snapshot.docs.map((doc) => ({
+      id: doc.id,
+      data: doc.data()
+    }));
+    if (docs.length <= n) {
+      return docs;
+    }
+    for (let i = docs.length - 1; i > docs.length - 1 - n; i--) {
+      const j = Math.floor(Math.random() * (i + 1));
+      [docs[i], docs[j]] = [docs[j], docs[i]];
+    }
+    return docs.slice(docs.length - n);
+  }
   /**
    * Export matching documents to a JSON file
    * @param filePath - Path for the output JSON file

package/dist/index.mjs

@@ -1218,6 +1218,34 @@ var BatchUpdater = class {
     }
     return values;
   }
+  /**
+   * Get a random sample of matching documents
+   * @param n - Number of documents to sample
+   * @returns Array of randomly selected documents with { id, data }
+   */
+  async sample(n) {
+    this.validateSetup();
+    if (!Number.isInteger(n) || n < 1) {
+      throw new Error("Sample size must be a positive integer");
+    }
+    const query = this.buildQuery();
+    const snapshot = await query.get();
+    if (snapshot.empty) {
+      return [];
+    }
+    const docs = snapshot.docs.map((doc) => ({
+      id: doc.id,
+      data: doc.data()
+    }));
+    if (docs.length <= n) {
+      return docs;
+    }
+    for (let i = docs.length - 1; i > docs.length - 1 - n; i--) {
+      const j = Math.floor(Math.random() * (i + 1));
+      [docs[i], docs[j]] = [docs[j], docs[i]];
+    }
+    return docs.slice(docs.length - n);
+  }
   /**
    * Export matching documents to a JSON file
    * @param filePath - Path for the output JSON file

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "firestore-batch-updater",
-  "version": "1.12.0",
+  "version": "1.13.0",
   "description": "Batch update Firestore documents with query-based filtering and preview",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",