Merge branch 'apache:develop' into doc

.asf.yaml

@@ -45,3 +45,10 @@ notifications:
   pullrequests_status: [email protected]
   pullrequests_comment: [email protected]
   pullrequests_bot_dependabot: [email protected]
+
+staging:
+  profile: ~
+  whoami:  asf-staging
+
+publish:
+  whoami:  asf-site

.github/workflows/site-build.yaml

@@ -0,0 +1,94 @@
+name: Site Build
+
+on:
+  push:
+    branches:
+      - develop
+    paths:
+      - 'docs/**'
+  pull_request:
+    branches:
+      - develop
+    paths:
+      - 'docs/**'
+  # allow manually run the action:
+  workflow_dispatch:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    if: github.event_name == 'pull_request'
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install pnpm
+        uses: pnpm/action-setup@v3
+        with:
+          package_json_file: 'docs/package.json'
+          run_install: true
+          version: 8
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: pnpm
+          cache-dependency-path: docs/pnpm-lock.yaml
+
+
+      - name: Install deps
+        run: |-
+          cd docs 
+          pnpm install --frozen-lockfile
+
+      - name: Test build Docs
+        env:
+          NODE_OPTIONS: --max_old_space_size=8192
+        run: |-
+          cd docs
+          pnpm run docs:build
+          > src/.vuepress/dist/.nojekyll
+
+  deploy:
+    runs-on: ubuntu-latest
+    if: github.event_name == 'workflow_dispatch' && github.ref_name == 'develop' || github.event_name == 'push'
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install pnpm
+        uses: pnpm/action-setup@v3
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: pnpm
+
+      - name: Install deps
+        run: |-
+          cd docs 
+          pnpm install --frozen-lockfile
+
+      - name: Build Docs
+        env:
+          NODE_OPTIONS: --max_old_space_size=8192
+        run: |-
+          cd docs
+          pnpm run docs:build
+          > src/.vuepress/dist/.nojekyll
+
+      # - name: Deploy website
+      #   env:
+      #     TSFILE_WEBSITE_BUILD: ${{ secrets.TSFILE_WEBSITE_BUILD }}
+      #   run: |
+      #     cd docs
+      #     git config --global url."https://asf-ci-deploy:[email protected]/apache/".insteadOf "https://github.com/apache/"
+      #     git config --global user.name github-actions
+      #     git config --global user.email 41898282+github-actions[bot]@users.noreply.github.com
+      #     npm run deploy

.github/workflows/unit-test.yml

@@ -61,7 +61,7 @@ jobs:
       # Setup caching of the artifacts in the .m2 directory, so they don't have to
       # all be downloaded again for every build.
       - name: Cache Maven packages
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           path: ~/.m2
           key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }}

.gitignore

@@ -9,3 +9,8 @@
 **/*.log
 **/*.ipr
 **/*.iws
+
+docs/node_modules/
+docs/src/.vuepress/.cache/
+docs/src/.vuepress/.temp/
+docs/src/.vuepress/dist/

README.md

@@ -28,6 +28,7 @@ ___________    ___________.__.__
   |____|/____  >\___  /   |__|____/\___  >  version 1.0.0
              \/     \/                 \/  
 </pre>
+[![Maven Version](https://maven-badges.herokuapp.com/maven-central/org.apache.tsfile/tsfile-parent/badge.svg)](http://search.maven.org/#search|gav|1|g:"org.apache.tsfile")
 
 ## Abstract
 

RELEASE_NOTES.md

@@ -0,0 +1,39 @@
+<!--
+
+    Licensed to the Apache Software Foundation (ASF) under one
+    or more contributor license agreements.  See the NOTICE file
+    distributed with this work for additional information
+    regarding copyright ownership.  The ASF licenses this file
+    to you under the Apache License, Version 2.0 (the
+    "License"); you may not use this file except in compliance
+    with the License.  You may obtain a copy of the License at
+
+        http://www.apache.org/licenses/LICENSE-2.0
+
+    Unless required by applicable law or agreed to in writing,
+    software distributed under the License is distributed on an
+    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+    KIND, either express or implied.  See the License for the
+    specific language governing permissions and limitations
+    under the License.
+
+-->
+
+# Apache TsFile 1.0.0
+
+## New Features
+
+- Support registering devices
+- Support registering measurements
+- Support adding additional measurements
+- Support writing timeseries data without pre-defined schema
+- Support writing timeseries data with pre-defined schema
+- Support writing with tsRecord
+- Support writing with Tablet
+- Support writing data into a closed TsFile
+- Support query timeseries data without any filter
+- Support query timeseries data with time filter
+- Support query timeseries data with value filter
+- Support BOOLEAN, INT32, INT64, FLOAT, DOUBLE, TEXT data types
+- Support PLAIN, DICTIONARY, RLE, TS_2DIFF, GORILLA, ZIGZAG, CHIMP, SPRINTZ, RLBE encoding algorithm
+- Support UNCOMPRESSED, SNAPPY, GZIP, LZ4, ZSTD, LZMA2 compression algorithm

common/pom.xml

@@ -24,7 +24,7 @@
     <parent>
         <groupId>org.apache.tsfile</groupId>
         <artifactId>tsfile-parent</artifactId>
-        <version>1.0.0-SNAPSHOT</version>
+        <version>1.0.1-SNAPSHOT</version>
     </parent>
     <artifactId>common</artifactId>
     <name>TsFile: Common API</name>

doap_tsfile.rdf

@@ -0,0 +1,61 @@
+<?xml version="1.0"?>
+<?xml-stylesheet type="text/xsl"?>
+<rdf:RDF xml:lang="en"
+         xmlns="http://usefulinc.com/ns/doap#"
+         xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
+         xmlns:asfext="http://projects.apache.org/ns/asfext#"
+         xmlns:foaf="http://xmlns.com/foaf/0.1/">
+<!--
+    Licensed to the Apache Software Foundation (ASF) under one or more
+    contributor license agreements.  See the NOTICE file distributed with
+    this work for additional information regarding copyright ownership.
+    The ASF licenses this file to You under the Apache License, Version 2.0
+    (the "License"); you may not use this file except in compliance with
+    the License.  You may obtain a copy of the License at
+
+         https://www.apache.org/licenses/LICENSE-2.0
+
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+-->
+  <Project rdf:about="https://tsfile.apache.org">
+    <created>2024-02-20</created>
+    <license rdf:resource="https://spdx.org/licenses/Apache-2.0" />
+    <name>Apache TsFile</name>
+
+    <homepage rdf:resource="https://tsfile.apache.org" />
+    <asfext:pmc rdf:resource="https://tsfile.apache.org" />
+
+    <shortdesc>The mission of Apache TsFile is the creation and maintenance of software related to a columnar storage file format designed for time series data.</shortdesc>
+    <description>TsFile is a columnar storage file format designed for time series data, which supports efficient compression, high throughput of read and write, and compatibility with various frameworks, such as Spark and Flink. It is easy to integrate TsFile into IoT big data processing frameworks.</description>
+
+    <bug-database rdf:resource="https://github.com/apache/tsfile/issues" />
+    <mailing-list rdf:resource="[email protected]" />
+
+    <programming-language>Java</programming-language>
+
+    <category rdf:resource="https://projects.apache.org/category/big-data" />
+    <category rdf:resource="https://projects.apache.org/category/database" />
+    <category rdf:resource="https://projects.apache.org/category/iot" />
+
+    <release>
+      <Version>
+        <name>Apache TsFile</name>
+        <created>2024-02-20</created>
+        <revision>1.0.0</revision>
+      </Version>
+    </release>
+
+    <repository>
+      <GitRepository>
+        <location rdf:resource="https://github.com/apache/tsfile.git"/>
+        <browse rdf:resource="https://github.com/apache/tsfile.git"/>
+      </GitRepository>
+    </repository>
+
+  </Project>
+</rdf:RDF>
+

docs/.gitignore

@@ -0,0 +1,5 @@
+
+node_modules/
+src/.vuepress/.cache/
+src/.vuepress/.temp/
+src/.vuepress/dist/

docs/deploy.cjs

@@ -0,0 +1,32 @@
+/*
+  Licensed to the Apache Software Foundation (ASF) under one
+  or more contributor license agreements.  See the NOTICE file
+  distributed with this work for additional information
+  regarding copyright ownership.  The ASF licenses this file
+  to you under the Apache License, Version 2.0 (the
+  "License"); you may not use this file except in compliance
+  with the License.  You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing,
+  software distributed under the License is distributed on an
+  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+  KIND, either express or implied.  See the License for the
+  specific language governing permissions and limitations
+  under the License.
+ */
+
+const ghpages = require('gh-pages');
+
+ghpages.publish('src/.vuepress/dist', {
+  branch: 'asf-site',
+  repo: 'https://github.com/apache/tsfile-website.git',
+  message: 'Site checkin for project tsfile-website',
+  dotfiles: true,
+}, (err) => {
+  if (err instanceof Error) {
+    console.error(err);
+    process.exit(1);
+  }
+});

docs/deploy_staging.cjs

@@ -0,0 +1,32 @@
+/*
+  Licensed to the Apache Software Foundation (ASF) under one
+  or more contributor license agreements.  See the NOTICE file
+  distributed with this work for additional information
+  regarding copyright ownership.  The ASF licenses this file
+  to you under the Apache License, Version 2.0 (the
+  "License"); you may not use this file except in compliance
+  with the License.  You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing,
+  software distributed under the License is distributed on an
+  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+  KIND, either express or implied.  See the License for the
+  specific language governing permissions and limitations
+  under the License.
+ */
+
+const ghpages = require('gh-pages');
+
+ghpages.publish('src/.vuepress/dist', {
+  branch: 'asf-staging',
+  repo: 'https://github.com/apache/tsfile-website.git',
+  message: 'Site checkin for project tsfile-website',
+  dotfiles: true,
+}, (err) => {
+  if (err instanceof Error) {
+    console.error(err);
+    process.exit(1);
+  }
+});

docs/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "tsfile-docs",
+  "version": "1.0.0",
+  "description": "tsfile docs",
+  "license": "Apache-2.0",
+  "type": "module",
+  "scripts": {
+    "docs:build": "vuepress build src",
+    "docs:clean-dev": "vuepress dev src --clean-cache",
+    "docs:dev": "vuepress dev src",
+    "docs:update-package": "pnpm dlx vp-update",
+    "deploy": "node --max_old_space_size=6000 deploy.cjs",
+    "deploy:staging": "node --max_old_space_size=6000 deploy_staging.cjs"
+  },
+  "devDependencies": {
+    "@docsearch/css": "^3.5.2",
+    "@docsearch/js": "^3.5.2",
+    "@docsearch/react": "^3.5.2",
+    "@vuepress/client": "2.0.0-rc.0",
+    "@vuepress/plugin-docsearch": "2.0.0-rc.0",
+    "@vuepress/plugin-google-analytics": "2.0.0-rc.0",
+    "@vuepress/shared": "2.0.0-rc.0",
+    "@vuepress/utils": "2.0.0-rc.0",
+    "gh-pages": "^6.1.1",
+    "ts-debounce": "^4.0.0",
+    "vue": "^3.4.3",
+    "vue-router": "^4.2.5",
+    "vuepress": "2.0.0-rc.0",
+    "vuepress-theme-hope": "2.0.0-rc.11"
+  }
+}