Dấu thời gian phân đoạn

Nếu một tập hợp chứa các tài liệu có giá trị được lập chỉ mục tuần tự, thì Cloud Firestore sẽ giới hạn tốc độ ghi ở mức 500 lượt ghi mỗi giây. Trang này mô tả cách phân đoạn một trường tài liệu để khắc phục giới hạn này. Trước tiên, hãy xác định ý nghĩa của "các trường được lập chỉ mục tuần tự" và làm rõ thời điểm áp dụng giới hạn này.

Các trường được lập chỉ mục tuần tự

"Các trường được lập chỉ mục tuần tự" nghĩa là mọi tập hợp tài liệu có chứa một trường được lập chỉ mục tăng hoặc giảm đơn điệu. Trong nhiều trường hợp, điều này có nghĩa là một trường timestamp, nhưng mọi giá trị trường tăng hoặc giảm đơn điệu đều có thể kích hoạt giới hạn ghi là 500 lượt ghi mỗi giây.

Ví dụ: giới hạn này áp dụng cho một tập hợp gồm các tài liệu user có trường được lập chỉ mục userid nếu ứng dụng chỉ định các giá trị userid như sau:

• 1281, 1282, 1283, 1284, 1285, ...

Mặt khác, không phải trường timestamp nào cũng kích hoạt giới hạn này. Nếu trường timestamp theo dõi các giá trị được phân phối ngẫu nhiên, thì giới hạn ghi sẽ không áp dụng. Giá trị thực tế của trường cũng không quan trọng, chỉ cần trường tăng hoặc giảm đơn điệu. Ví dụ: cả hai nhóm giá trị trường tăng đơn điệu sau đây đều kích hoạt giới hạn ghi:

• 100000, 100001, 100002, 100003, ...
• 0, 1, 2, 3, ...

Phân đoạn trường dấu thời gian

Giả sử ứng dụng của bạn sử dụng trường timestamp tăng đơn điệu. Nếu ứng dụng của bạn không sử dụng trường timestamp trong bất kỳ truy vấn nào, thì bạn có thể xoá giới hạn 500 lượt ghi mỗi giây bằng cách không lập chỉ mục trường dấu thời gian. Nếu cần trường timestamp cho các truy vấn, bạn có thể khắc phục hạn mức bằng cách sử dụng dấu thời gian phân mảnh:

1. Thêm một trường shard cùng với trường timestamp. Sử dụng 1..n giá trị riêng biệt cho trường shard. Điều này làm tăng giới hạn ghi cho bộ sưu tập lên 500*n, nhưng bạn phải tổng hợp n truy vấn.
2. Cập nhật logic ghi để chỉ định ngẫu nhiên giá trị shard cho từng tài liệu.
3. Cập nhật các truy vấn để tổng hợp các tập kết quả được phân đoạn.
4. Tắt chỉ mục một trường cho cả trường shard và trường timestamp. Xoá các chỉ mục kết hợp hiện có có chứa trường timestamp.
5. Tạo chỉ mục kết hợp mới để hỗ trợ các truy vấn đã cập nhật. Thứ tự của các trường trong một chỉ mục là rất quan trọng và trường shard phải xuất hiện trước trường timestamp. Mọi chỉ mục có trường timestamp cũng phải có trường shard.

Bạn chỉ nên triển khai dấu thời gian phân mảnh trong các trường hợp sử dụng có tốc độ ghi liên tục trên 500 lượt ghi mỗi giây. Nếu không, đây là một hoạt động tối ưu hoá sớm. Việc phân đoạn trường timestamp sẽ loại bỏ hạn chế 500 lượt ghi mỗi giây nhưng phải đánh đổi bằng việc cần có các hoạt động tổng hợp truy vấn phía máy khách.

Các ví dụ sau đây cho thấy cách phân đoạn một trường timestamp và cách truy vấn một tập kết quả được phân đoạn.

Ví dụ về mô hình dữ liệu và truy vấn

Ví dụ: hãy tưởng tượng một ứng dụng để phân tích các công cụ tài chính (như tiền tệ, cổ phiếu phổ thông và quỹ hoán đổi danh mục) gần như theo thời gian thực. Ứng dụng này ghi các tài liệu vào một tập hợp instruments như sau:

Node.js

async function insertData() {
  const instruments = [
    {
      symbol: 'AAA',
      price: {
        currency: 'USD',
        micros: 34790000
      },
      exchange: 'EXCHG1',
      instrumentType: 'commonstock',
      timestamp: Timestamp.fromMillis(
          Date.parse('2019-01-01T13:45:23.010Z'))
    },
    {
      symbol: 'BBB',
      price: {
        currency: 'JPY',
        micros: 64272000000
      },
      exchange: 'EXCHG2',
      instrumentType: 'commonstock',
      timestamp: Timestamp.fromMillis(
          Date.parse('2019-01-01T13:45:23.101Z'))
    },
    {
      symbol: 'Index1 ETF',
      price: {
        currency: 'USD',
        micros: 473000000
      },
      exchange: 'EXCHG1',
      instrumentType: 'etf',
      timestamp: Timestamp.fromMillis(
          Date.parse('2019-01-01T13:45:23.001Z'))
    }
  ];

  const batch = fs.batch();
  for (const inst of instruments) {
    const ref = fs.collection('instruments').doc();
    batch.set(ref, inst);
  }

  await batch.commit();
}
nonShardedTimestamps.js

Ứng dụng này chạy các truy vấn sau và sắp xếp theo trường timestamp:

Node.js

function createQuery(fieldName, fieldOperator, fieldValue, limit = 5) {
  return fs.collection('instruments')
      .where(fieldName, fieldOperator, fieldValue)
      .orderBy('timestamp', 'desc')
      .limit(limit)
      .get();
}

function queryCommonStock() {
  return createQuery('instrumentType', '==', 'commonstock');
}

function queryExchange1Instruments() {
  return createQuery('exchange', '==', 'EXCHG1');
}

function queryUSDInstruments() {
  return createQuery('price.currency', '==', 'USD');
}
nonShardedTimestamps.js

insertData()
    .then(() => {
      const commonStock = queryCommonStock()
          .then(
              (docs) => {
                console.log('--- queryCommonStock: ');
                docs.forEach((doc) => {
                  console.log(`doc = ${util.inspect(doc.data(), {depth: 4})}`);
                });
              }
          );
      const exchange1Instruments = queryExchange1Instruments()
          .then(
              (docs) => {
                console.log('--- queryExchange1Instruments: ');
                docs.forEach((doc) => {
                  console.log(`doc = ${util.inspect(doc.data(), {depth: 4})}`);
                });
              }
          );
      const usdInstruments = queryUSDInstruments()
          .then(
              (docs) => {
                console.log('--- queryUSDInstruments: ');
                docs.forEach((doc) => {
                  console.log(`doc = ${util.inspect(doc.data(), {depth: 4})}`);
                });
              }
          );
      return Promise.all([commonStock, exchange1Instruments, usdInstruments]);
    });
nonShardedTimestamps.js

Sau khi nghiên cứu, bạn xác định rằng ứng dụng sẽ nhận được từ 1.000 đến 1.500 bản cập nhật về thiết bị mỗi giây. Điều này vượt quá 500 lượt ghi mỗi giây được phép cho các bộ sưu tập chứa tài liệu có các trường dấu thời gian được lập chỉ mục. Để tăng thông lượng ghi, bạn cần 3 giá trị phân đoạn, MAX_INSTRUMENT_UPDATES/500 = 3. Ví dụ này sử dụng các giá trị phân đoạn x, y và z. Bạn cũng có thể sử dụng các số hoặc ký tự khác cho giá trị phân đoạn.

Thêm trường phân đoạn

Thêm trường shard vào tài liệu. Đặt trường shard thành các giá trị x, y hoặc z. Thao tác này sẽ tăng giới hạn ghi trên bộ sưu tập lên 1.500 lượt ghi mỗi giây.

Node.js

// Define our 'K' shard values
const shards = ['x', 'y', 'z'];
// Define a function to help 'chunk' our shards for use in queries.
// When using the 'in' query filter there is a max number of values that can be
// included in the value. If our number of shards is higher than that limit
// break down the shards into the fewest possible number of chunks.
function shardChunks() {
  const chunks = [];
  let start = 0;
  while (start < shards.length) {
    const elements = Math.min(MAX_IN_VALUES, shards.length - start);
    const end = start + elements;
    chunks.push(shards.slice(start, end));
    start = end;
  }
  return chunks;
}

// Add a convenience function to select a random shard
function randomShard() {
  return shards[Math.floor(Math.random() * Math.floor(shards.length))];
}
shardedTimestamps.js

async function insertData() {
  const instruments = [
    {
      shard: randomShard(),  // add the new shard field to the document
      symbol: 'AAA',
      price: {
        currency: 'USD',
        micros: 34790000
      },
      exchange: 'EXCHG1',
      instrumentType: 'commonstock',
      timestamp: Timestamp.fromMillis(
          Date.parse('2019-01-01T13:45:23.010Z'))
    },
    {
      shard: randomShard(),  // add the new shard field to the document
      symbol: 'BBB',
      price: {
        currency: 'JPY',
        micros: 64272000000
      },
      exchange: 'EXCHG2',
      instrumentType: 'commonstock',
      timestamp: Timestamp.fromMillis(
          Date.parse('2019-01-01T13:45:23.101Z'))
    },
    {
      shard: randomShard(),  // add the new shard field to the document
      symbol: 'Index1 ETF',
      price: {
        currency: 'USD',
        micros: 473000000
      },
      exchange: 'EXCHG1',
      instrumentType: 'etf',
      timestamp: Timestamp.fromMillis(
          Date.parse('2019-01-01T13:45:23.001Z'))
    }
  ];

  const batch = fs.batch();
  for (const inst of instruments) {
    const ref = fs.collection('instruments').doc();
    batch.set(ref, inst);
  }

  await batch.commit();
}
shardedTimestamps.js

Truy vấn dấu thời gian được phân đoạn

Để thêm trường shard, bạn cần cập nhật các truy vấn để tổng hợp kết quả phân đoạn:

Node.js

function createQuery(fieldName, fieldOperator, fieldValue, limit = 5) {
  // For each shard value, map it to a new query which adds an additional
  // where clause specifying the shard value.
  return Promise.all(shardChunks().map(shardChunk => {
        return fs.collection('instruments')
            .where('shard', 'in', shardChunk)  // new shard condition
            .where(fieldName, fieldOperator, fieldValue)
            .orderBy('timestamp', 'desc')
            .limit(limit)
            .get();
      }))
      // Now that we have a promise of multiple possible query results, we need
      // to merge the results from all of the queries into a single result set.
      .then((snapshots) => {
        // Create a new container for 'all' results
        const docs = [];
        snapshots.forEach((querySnapshot) => {
          querySnapshot.forEach((doc) => {
            // append each document to the new all container
            docs.push(doc);
          });
        });
        if (snapshots.length === 1) {
          // if only a single query was returned skip manual sorting as it is
          // taken care of by the backend.
          return docs;
        } else {
          // When multiple query results are returned we need to sort the
          // results after they have been concatenated.
          // 
          // since we're wanting the `limit` newest values, sort the array
          // descending and take the first `limit` values. By returning negated
          // values we can easily get a descending value.
          docs.sort((a, b) => {
            const aT = a.data().timestamp;
            const bT = b.data().timestamp;
            const secondsDiff = aT.seconds - bT.seconds;
            if (secondsDiff === 0) {
              return -(aT.nanoseconds - bT.nanoseconds);
            } else {
              return -secondsDiff;
            }
          });
          return docs.slice(0, limit);
        }
      });
}

function queryCommonStock() {
  return createQuery('instrumentType', '==', 'commonstock');
}

function queryExchange1Instruments() {
  return createQuery('exchange', '==', 'EXCHG1');
}

function queryUSDInstruments() {
  return createQuery('price.currency', '==', 'USD');
}
shardedTimestamps.js

insertData()
    .then(() => {
      const commonStock = queryCommonStock()
          .then(
              (docs) => {
                console.log('--- queryCommonStock: ');
                docs.forEach((doc) => {
                  console.log(`doc = ${util.inspect(doc.data(), {depth: 4})}`);
                });
              }
          );
      const exchange1Instruments = queryExchange1Instruments()
          .then(
              (docs) => {
                console.log('--- queryExchange1Instruments: ');
                docs.forEach((doc) => {
                  console.log(`doc = ${util.inspect(doc.data(), {depth: 4})}`);
                });
              }
          );
      const usdInstruments = queryUSDInstruments()
          .then(
              (docs) => {
                console.log('--- queryUSDInstruments: ');
                docs.forEach((doc) => {
                  console.log(`doc = ${util.inspect(doc.data(), {depth: 4})}`);
                });
              }
          );
      return Promise.all([commonStock, exchange1Instruments, usdInstruments]);
    });
shardedTimestamps.js

Cập nhật định nghĩa chỉ mục

Để xoá giới hạn 500 lượt ghi mỗi giây, hãy xoá các chỉ mục một trường và chỉ mục kết hợp hiện có sử dụng trường timestamp.

Xoá định nghĩa chỉ mục kết hợp

Bảng điều khiển của Firebase

1. Mở trang Cloud Firestore Chỉ mục kết hợp trong bảng điều khiển của Firebase.

   Chuyển đến phần Chỉ mục kết hợp

2. Đối với mỗi chỉ mục chứa trường timestamp, hãy nhấp vào nút rồi nhấp vào Xoá.

Bảng điều khiển Google Cloud Platform

1. Trong bảng điều khiển Google Cloud, hãy chuyển đến trang Cơ sở dữ liệu.

   Chuyển đến phần Cơ sở dữ liệu

2. Chọn cơ sở dữ liệu cần thiết trong danh sách cơ sở dữ liệu.

3. Trong trình đơn điều hướng, hãy nhấp vào Chỉ mục, rồi nhấp vào thẻ Hỗn hợp.

4. Sử dụng trường Bộ lọc để tìm kiếm các định nghĩa chỉ mục có chứa trường timestamp.

5. Đối với mỗi chỉ mục này, hãy nhấp vào nút rồi nhấp vào Xoá.

Giao diện dòng lệnh (CLI) của Firebase

1. Nếu bạn chưa thiết lập Firebase CLI, hãy làm theo hướng dẫn này để cài đặt CLI và chạy lệnh firebase init. Trong lệnh init, hãy nhớ chọn Firestore: Deploy rules and create indexes for Firestore.
2. Trong quá trình thiết lập, Firebase CLI sẽ tải các định nghĩa chỉ mục hiện có xuống một tệp có tên là firestore.indexes.json theo mặc định.

3. Xoá mọi định nghĩa chỉ mục có chứa trường timestamp, ví dụ:

   {
   "indexes": [
     // Delete composite index definition that contain the timestamp field
     {
       "collectionGroup": "instruments",
       "queryScope": "COLLECTION",
       "fields": [
         {
           "fieldPath": "exchange",
           "order": "ASCENDING"
         },
         {
           "fieldPath": "timestamp",
           "order": "DESCENDING"
         }
       ]
     },
     {
       "collectionGroup": "instruments",
       "queryScope": "COLLECTION",
       "fields": [
         {
           "fieldPath": "instrumentType",
           "order": "ASCENDING"
         },
         {
           "fieldPath": "timestamp",
           "order": "DESCENDING"
         }
       ]
     },
     {
       "collectionGroup": "instruments",
       "queryScope": "COLLECTION",
       "fields": [
         {
           "fieldPath": "price.currency",
           "order": "ASCENDING"
         },
         {
           "fieldPath": "timestamp",
           "order": "DESCENDING"
         }
       ]
     },
    ]
   }
   

4. Triển khai các định nghĩa chỉ mục đã cập nhật:

   firebase deploy --only firestore:indexes
   

Cập nhật định nghĩa Chỉ mục một trường

Bảng điều khiển của Firebase

1. Mở trang Cloud Firestore Chỉ mục một trường trong bảng điều khiển của Firebase.

   Chuyển đến Chỉ mục một trường

2. Nhấp vào Thêm trường hợp ngoại lệ.

3. Đối với Mã bộ sưu tập, hãy nhập instruments. Đối với Đường dẫn đến trường, hãy nhập timestamp.

4. Trong phần Phạm vi truy vấn, hãy chọn cả Bộ sưu tập và Nhóm bộ sưu tập.

5. Nhấp vào Tiếp theo

6. Chuyển tất cả chế độ cài đặt chỉ mục sang trạng thái Đã tắt. Nhấp vào Lưu.

7. Lặp lại các bước tương tự cho trường shard.

Bảng điều khiển Google Cloud Platform

1. Trong bảng điều khiển Google Cloud, hãy chuyển đến trang Cơ sở dữ liệu.

   Chuyển đến phần Cơ sở dữ liệu

2. Chọn cơ sở dữ liệu cần thiết trong danh sách cơ sở dữ liệu.

3. Trong trình đơn điều hướng, hãy nhấp vào Chỉ mục, rồi nhấp vào thẻ Trường đơn.

4. Nhấp vào thẻ Trường đơn.

5. Nhấp vào Thêm trường hợp ngoại lệ.

6. Đối với Mã bộ sưu tập, hãy nhập instruments. Đối với Đường dẫn đến trường, hãy nhập timestamp.

7. Trong phần Phạm vi truy vấn, hãy chọn cả Bộ sưu tập và Nhóm bộ sưu tập.

8. Nhấp vào Tiếp theo

9. Chuyển tất cả chế độ cài đặt chỉ mục sang trạng thái Đã tắt. Nhấp vào Lưu.

10. Lặp lại các bước tương tự cho trường shard.

Giao diện dòng lệnh (CLI) của Firebase

1. Thêm nội dung sau vào phần fieldOverrides của tệp định nghĩa chỉ mục:

   {
    "fieldOverrides": [
      // Disable single-field indexing for the timestamp field
      {
        "collectionGroup": "instruments",
        "fieldPath": "timestamp",
        "indexes": []
      },
    ]
   }
   

2. Triển khai các định nghĩa chỉ mục đã cập nhật:

   firebase deploy --only firestore:indexes
   

Tạo chỉ mục kết hợp mới

Sau khi xoá tất cả các chỉ mục trước đó có chứa timestamp, hãy xác định các chỉ mục mới mà ứng dụng của bạn yêu cầu. Mọi chỉ mục chứa trường timestamp cũng phải chứa trường shard. Ví dụ: để hỗ trợ các truy vấn ở trên, hãy thêm các chỉ mục sau:

Thu thập	Các trường được lập chỉ mục	Phạm vi truy vấn
nhạc cụ	shard, price.currency, timestamp	Thu thập
nhạc cụ	phân đoạn, lần trao đổi, dấu thời gian	Thu thập
nhạc cụ	phân đoạn, instrumentType, dấu thời gian	Thu thập

Thông báo lỗi

Bạn có thể tạo các chỉ mục này bằng cách chạy các truy vấn đã cập nhật.

Mỗi truy vấn sẽ trả về một thông báo lỗi kèm theo đường liên kết để tạo chỉ mục bắt buộc trong Bảng điều khiển Firebase.

Giao diện dòng lệnh (CLI) của Firebase

1. Thêm các chỉ mục sau vào tệp định nghĩa chỉ mục:

    {
      "indexes": [
      // New indexes for sharded timestamps
        {
          "collectionGroup": "instruments",
          "queryScope": "COLLECTION",
          "fields": [
            {
              "fieldPath": "shard",
              "order": "DESCENDING"
            },
            {
              "fieldPath": "exchange",
              "order": "ASCENDING"
            },
            {
              "fieldPath": "timestamp",
              "order": "DESCENDING"
            }
          ]
        },
        {
          "collectionGroup": "instruments",
          "queryScope": "COLLECTION",
          "fields": [
            {
              "fieldPath": "shard",
              "order": "DESCENDING"
            },
            {
              "fieldPath": "instrumentType",
              "order": "ASCENDING"
            },
            {
              "fieldPath": "timestamp",
              "order": "DESCENDING"
            }
          ]
        },
        {
          "collectionGroup": "instruments",
          "queryScope": "COLLECTION",
          "fields": [
            {
              "fieldPath": "shard",
              "order": "DESCENDING"
            },
            {
              "fieldPath": "price.currency",
              "order": "ASCENDING"
            },
            {
              "fieldPath": "timestamp",
              "order": "DESCENDING"
            }
          ]
        },
      ]
    }
   

2. Triển khai các định nghĩa chỉ mục đã cập nhật:

   firebase deploy --only firestore:indexes
   

Tìm hiểu về giới hạn ghi đối với các trường được lập chỉ mục tuần tự

Giới hạn về tốc độ ghi cho các trường được lập chỉ mục tuần tự xuất phát từ cách Cloud Firestore lưu trữ các giá trị chỉ mục và mở rộng quy mô ghi chỉ mục. Đối với mỗi lần ghi chỉ mục, Cloud Firestore sẽ xác định một mục khoá-giá trị nối tên tài liệu và giá trị của từng trường được lập chỉ mục. Cloud Firestoresắp xếp các mục nhập chỉ mục này thành các nhóm dữ liệu gọi là máy tính bảng. Mỗi máy chủ Cloud Firestore chứa một hoặc nhiều bảng. Khi tải ghi vào một bảng cụ thể trở nên quá cao, Cloud Firestore sẽ mở rộng theo chiều ngang bằng cách chia bảng thành các bảng nhỏ hơn và trải các bảng mới trên các máy chủ Cloud Firestore khác nhau.

Cloud Firestore đặt các mục nhập chỉ mục gần nhau theo từ điển trên cùng một bảng. Nếu các giá trị chỉ mục trong một bảng quá gần nhau, chẳng hạn như đối với các trường dấu thời gian, thì Cloud Firestore không thể chia bảng một cách hiệu quả thành các bảng nhỏ hơn. Điều này tạo ra một điểm nóng nơi một máy tính bảng duy nhất nhận được quá nhiều lưu lượng truy cập, đồng thời các thao tác đọc và ghi vào điểm nóng trở nên chậm hơn.

Bằng cách phân đoạn một trường dấu thời gian, bạn có thể giúp Cloud Firestore chia khối lượng công việc một cách hiệu quả trên nhiều máy tính bảng. Mặc dù các giá trị của trường dấu thời gian có thể vẫn gần nhau, nhưng giá trị chỉ mục và phân đoạn được nối sẽ cung cấp cho Cloud Firestore đủ khoảng trống giữa các mục chỉ mục để phân chia các mục giữa nhiều bảng.

Bước tiếp theo

• Đọc các phương pháp hay nhất để thiết kế cho quy mô lớn
• Đối với các trường hợp có tốc độ ghi cao vào một tài liệu, hãy xem phần Bộ đếm phân tán
• Xem hạn mức chuẩn cho Cloud Firestore