Variable getDataSetPieces

Type Declaration

• • (
        synapse: Synapse,
        storageContext: StorageContext,
        options?: GetDataSetPiecesOptions,
    ): Promise<DataSetPiecesResult>

  • Get all pieces for a dataset from a StorageContext

    This function uses the StorageContext.getPieces() async generator to retrieve all pieces in a dataset. Optionally fetches metadata for each piece from WarmStorage.

    Example usage:

    const result = await getDataSetPieces(storageContext, {
      includeMetadata: true,
      batchSize: 100
    })
    
    console.log(`Found ${result.pieces.length} pieces`)
    for (const piece of result.pieces) {
      console.log(`  ${piece.pieceCid}`)
      if (piece.rootIpfsCid) {
        console.log(`    IPFS: ${piece.rootIpfsCid}`)
      }
    }
    Copy

    Parameters

    • synapse: Synapse
    • storageContext: StorageContext

      Storage context from upload or dataset resolution

    • Optionaloptions: GetDataSetPiecesOptions

      Optional configuration

    Returns Promise<DataSetPiecesResult>

    Pieces and warnings