Skip to content

Commit

Permalink
fixed copy array and read array
Browse files Browse the repository at this point in the history
  • Loading branch information
grammaright committed Nov 11, 2024
1 parent e925a3a commit df3e8cb
Show file tree
Hide file tree
Showing 7 changed files with 556 additions and 215 deletions.
4 changes: 3 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,7 @@ testext
test/python/__pycache__/
.Rhistory

data

.env
.vscode
.vscode
94 changes: 19 additions & 75 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,86 +1,30 @@
# Array

This repository is based on https://github.com/duckdb/extension-template, check it out if you want to build and ship your own DuckDB extension.
## Function Descriptions

---
### Read Function

This extension, Array, allow you to ... <extension_goal>.
```SQL
-- Read entire 3D array
SELECT x, y, z, val FROM read_array('finedust');

-- Read (0, 0) tile of 2D array
SELECT x, y, val FROM read_array('finedust', coords=[0, 0]);

## Building
### Managing dependencies
DuckDB extensions uses VCPKG for dependency management. Enabling VCPKG is very simple: follow the [installation instructions](https://vcpkg.io/en/getting-started) or just run the following:
```shell
git clone https://github.com/Microsoft/vcpkg.git
./vcpkg/bootstrap-vcpkg.sh
export VCPKG_TOOLCHAIN_PATH=`pwd`/vcpkg/scripts/buildsystems/vcpkg.cmake
-- Read (0, 0) tile of 2D COO array (i.e., dim[0] = x,y,val and dim[1] = rows)
SELECT x, y, val FROM read_array('finedust', coords=[0, 0] array_type=\"COO\");
```
Note: VCPKG is only required for extensions that want to rely on it for dependency management. If you want to develop an extension without dependencies, or want to do your own dependency management, just skip this step. Note that the example extension uses VCPKG to build with a dependency for instructive purposes, so when skipping this step the build may not work without removing the dependency.

### Build steps
Now to build the extension, run:
```sh
make
```
The main binaries that will be built are:
```sh
./build/release/duckdb
./build/release/test/unittest
./build/release/extension/array/array.duckdb_extension
```
- `duckdb` is the binary for the duckdb shell with the extension code automatically loaded.
- `unittest` is the test runner of duckdb. Again, the extension is already linked into the binary.
- `array.duckdb_extension` is the loadable binary as it would be distributed.

## Running the extension
To run the extension code, simply start the shell with `./build/release/duckdb`.

Now we can use the features from the extension directly in DuckDB. The template contains a single scalar function `array()` that takes a string arguments and returns a string:
```
D select array('Jane') as result;
┌───────────────┐
│ result │
│ varchar │
├───────────────┤
│ Array Jane 🐥 │
└───────────────┘
```

## Running the tests
Different tests can be created for DuckDB extensions. The primary way of testing DuckDB extensions should be the SQL tests in `./test/sql`. These SQL tests can be run using:
```sh
make test
```

### Installing the deployed binaries
To install your extension binaries from S3, you will need to do two things. Firstly, DuckDB should be launched with the
`allow_unsigned_extensions` option set to true. How to set this will depend on the client you're using. Some examples:
### COPY Function

CLI:
```shell
duckdb -unsigned
```

Python:
```python
con = duckdb.connect(':memory:', config={'allow_unsigned_extensions' : 'true'})
```

NodeJS:
```js
db = new duckdb.Database(':memory:', {"allow_unsigned_extensions": "true"});
```
- `MODE 0`: COO to Array
- `MODE 1`: Dense array (only values) to array
- `COORD_X`, `COORD_Y`, and `COORD_Z` are required

Secondly, you will need to set the repository endpoint in DuckDB to the HTTP url of your bucket + version of the extension
you want to install. To do this run the following SQL query in DuckDB:
```sql
SET custom_extension_repository='bucket.s3.eu-west-1.amazonaws.com/<your_extension_name>/latest';
```
Note that the `/latest` path will allow you to install the latest extension version available for your current version of
DuckDB. To specify a specific version, you can pass the version instead.

After running these steps, you can install and load your extension using the regular INSTALL/LOAD commands in DuckDB:
```sql
INSTALL array
LOAD array
```
COPY (
SELECT timestamp::UINTEGER, latitude::UINTEGER, longitude::UINTEGER, pm10::DOUBLE
FROM Finedust_idx
ORDER BY timestamp ASC, longitude ASC, latitude ASC)
TO 'finedust_pm10.tilestore'(MODE 0, COORD_X 0, COORD_Y 0, COORD_Z 0);
```
Loading

0 comments on commit df3e8cb

Please sign in to comment.