@parqui/core 1.2.0 → 1.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +18 -0
- package/README.md +55 -0
- package/package.json +24 -3
package/LICENSE
ADDED
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
Business Source License 1.1
|
|
2
|
+
|
|
3
|
+
SPDX short identifier: BUSL-1.1
|
|
4
|
+
|
|
5
|
+
Copyright (c) 2026 Parqui
|
|
6
|
+
|
|
7
|
+
Use of this package is governed by the Business Source License 1.1.
|
|
8
|
+
The licensor for this package is Parqui.
|
|
9
|
+
|
|
10
|
+
Additional Use Grant:
|
|
11
|
+
- Personal, educational, and open-source usage is permitted at no cost.
|
|
12
|
+
- Commercial usage requires a paid Parqui commercial license.
|
|
13
|
+
|
|
14
|
+
Change Date: 2030-01-01
|
|
15
|
+
Change License: Apache-2.0
|
|
16
|
+
|
|
17
|
+
For the full legal text of Business Source License 1.1, see:
|
|
18
|
+
https://mariadb.com/bsl11/
|
package/README.md
ADDED
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
# @parqui/core
|
|
2
|
+
|
|
3
|
+
[](https://www.npmjs.com/package/@parqui/core)
|
|
4
|
+
[](https://www.npmjs.com/package/@parqui/core)
|
|
5
|
+
|
|
6
|
+
Framework-agnostic TypeScript core for reading Apache Parquet files and building fast parquet viewers, parquet file explorers, and data inspection tools in browser or desktop apps.
|
|
7
|
+
|
|
8
|
+
## Why `@parqui/core`
|
|
9
|
+
|
|
10
|
+
- Fast Apache Parquet metadata and row access in JavaScript/TypeScript
|
|
11
|
+
- Built on `hyparquet` with lazy/random-access reading
|
|
12
|
+
- Pipeline utilities for sorting, filtering, grouping, and index building
|
|
13
|
+
- Reusable across React, Vue, Angular, desktop, and custom frameworks
|
|
14
|
+
- Designed for large datasets and virtualized data grid workflows
|
|
15
|
+
|
|
16
|
+
## Installation
|
|
17
|
+
|
|
18
|
+
```bash
|
|
19
|
+
npm install @parqui/core
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
## Quick Start
|
|
23
|
+
|
|
24
|
+
```ts
|
|
25
|
+
import { sourceFromUrl, readParquetMetadata, readParquetData } from "@parqui/core";
|
|
26
|
+
|
|
27
|
+
const source = sourceFromUrl("https://example.com/data/events.parquet");
|
|
28
|
+
|
|
29
|
+
const metadata = await readParquetMetadata(source);
|
|
30
|
+
console.log(metadata.columns.map((c) => c.name));
|
|
31
|
+
|
|
32
|
+
const data = await readParquetData(source, { offset: 0, limit: 1000 });
|
|
33
|
+
console.log(data.rows.length);
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
## Main Exports
|
|
37
|
+
|
|
38
|
+
- Readers: `readParquetMetadata`, `readParquetData`, `readColumnValues`, `readRowsByIndices`
|
|
39
|
+
- Sources: `sourceFromFile`, `sourceFromBuffer`, `sourceFromUrl`
|
|
40
|
+
- Pipeline: `buildSortIndex`, `buildFilterIndex`, `buildGroups`, `collectUniqueValues`, `createEmptyPipeline`
|
|
41
|
+
- Types: `ParquetSource`, `ParquetMetadata`, `ParquetData`, `ParquetRow`, `ReadOptions`
|
|
42
|
+
|
|
43
|
+
## Package Ecosystem
|
|
44
|
+
|
|
45
|
+
- React component: [`@parqui/react`](https://www.npmjs.com/package/@parqui/react)
|
|
46
|
+
- Vue component: [`@parqui/vue`](https://www.npmjs.com/package/@parqui/vue)
|
|
47
|
+
- Angular component: [`@parqui/angular`](https://www.npmjs.com/package/@parqui/angular)
|
|
48
|
+
|
|
49
|
+
## Links
|
|
50
|
+
|
|
51
|
+
- Website: [parqui.dev](https://parqui.dev)
|
|
52
|
+
|
|
53
|
+
## License
|
|
54
|
+
|
|
55
|
+
Business Source License 1.1 (`BUSL-1.1`). See `LICENSE`.
|
package/package.json
CHANGED
|
@@ -1,7 +1,25 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@parqui/core",
|
|
3
|
-
"version": "1.2.
|
|
4
|
-
"description": "
|
|
3
|
+
"version": "1.2.1",
|
|
4
|
+
"description": "High-performance Apache Parquet reader and data pipeline for parquet file viewer and data tooling.",
|
|
5
|
+
"keywords": [
|
|
6
|
+
"parquet",
|
|
7
|
+
"apache parquet",
|
|
8
|
+
"parquet reader",
|
|
9
|
+
"parquet parser",
|
|
10
|
+
"parquet viewer",
|
|
11
|
+
"parquet file viewer",
|
|
12
|
+
"data viewer",
|
|
13
|
+
"data table",
|
|
14
|
+
"columnar data",
|
|
15
|
+
"analytics",
|
|
16
|
+
"dataset",
|
|
17
|
+
"typescript",
|
|
18
|
+
"browser",
|
|
19
|
+
"javascript"
|
|
20
|
+
],
|
|
21
|
+
"homepage": "https://parqui.dev",
|
|
22
|
+
"author": "Sam Prof",
|
|
5
23
|
"type": "module",
|
|
6
24
|
"main": "./dist/index.cjs",
|
|
7
25
|
"module": "./dist/index.js",
|
|
@@ -23,7 +41,10 @@
|
|
|
23
41
|
"dependencies": {
|
|
24
42
|
"hyparquet": "^1.12.0"
|
|
25
43
|
},
|
|
26
|
-
"license": "
|
|
44
|
+
"license": "BUSL-1.1",
|
|
45
|
+
"publishConfig": {
|
|
46
|
+
"access": "public"
|
|
47
|
+
},
|
|
27
48
|
"scripts": {
|
|
28
49
|
"build": "tsup",
|
|
29
50
|
"dev": "tsup --watch",
|