Merge remote-tracking branch 'origin/main' into release

Author: Polybase CI

Diff for: .github/workflows/release.branch.yml

@@ -0,0 +1,54 @@
+name: Create PR for Release Branch
+
+on:
+  create:
+    branches:
+      - '**'
+       
+jobs:
+  create_release_branch:
+    runs-on: ubuntu-latest
+    if: startsWith(github.ref, 'refs/heads/release-')
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Set Version as env var
+        run: |
+          branch_name=$(echo ${{ github.ref }} | sed 's/refs\/heads\///')
+          VERSION=${branch_name#release-}
+          echo "VERSION=$VERSION" >> $GITHUB_ENV
+
+      - name: Set up JQ
+        run: |
+          sudo apt-get install jq
+
+      - name: Update JSON file
+        run: |
+          jq '.versions[0] = env.VERSION' mint.json > temp.json && mv temp.json mint.json
+
+      - name: Commit changes
+        run: |
+          git config --local user.email user.email "hello@polybase.xyz"
+          git config --local user.name "Polybase CI"
+          git add .
+          git commit -m "Bump version" || echo "No changes to commit"
+          git push
+  
+      - name: Create Pull Request
+        env:
+          GITHUB_TOKEN: ${{ secrets.ADMIN_TOKEN }}
+        run: |
+          branch_name=$(echo ${{ github.ref }} | sed 's/refs\/heads\///')
+          curl -X POST \
+            -H "Authorization: token $GITHUB_TOKEN" \
+            -H "Accept: application/vnd.github.v3+json" \
+            https://api.github.com/repos/${{ github.repository }}/pulls \
+            -d '{
+              "title": "Release 'v$VERSION'",
+              "body": "This is an automated PR for release '$VERSION'",
+              "head": "'$branch_name'",
+              "base": "main"
+            }'

Diff for: .github/workflows/release.pr.merge.yml

@@ -0,0 +1,53 @@
+name: Release
+
+on:
+  pull_request:
+    types:
+      - closed
+    branches:
+      - main
+      
+jobs:
+
+  release:
+    runs-on: ubuntu-latest
+    if: github.event.pull_request.merged == true && startsWith(github.event.pull_request.head.ref, 'release-')
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+          ref: release
+          token: ${{ secrets.ADMIN_TOKEN }}
+
+      - name: Configure Git
+        run: |
+          git config --global user.email "hello@polybase.xyz"
+          git config --global user.name "Polybase CI"
+
+      - name: Get PR Info
+        run: |
+          PR_TITLE="${{ github.event.pull_request.title }}"
+          PR_DESC="${{ github.event.pull_request.body }}"
+          PR_BRANCH="${{ github.event.pull_request.head.ref }}"
+          PR_VERSION="${PR_BRANCH#*release-}"
+  
+          echo "PR Title: $PR_TITLE"
+          echo "PR Description: $PR_DESC"
+          echo "PR Branch: $PR_BRANCH"
+          echo "PR Version: $PR_VERSION"
+          echo "PR_VERSION=$PR_VERSION" >> $GITHUB_ENV  
+
+      - name: Merge main into release (to deploy)
+        run: |
+          git fetch origin main
+          git merge --no-edit origin/main
+
+      - name: Create Tag
+        id: create_tag
+        run: |
+          git tag $PR_VERSION
+          echo ::set-output name=tag::${PR_VERSION}
+    
+      - name: Push Changes and Tags
+        run: |
+          git push origin HEAD:release --tags

Diff for: collections.mdx

@@ -200,7 +200,7 @@ The following types are supported:
 - `bytes`
 - `PublicKey`
 - `Collection`
-- `string[]`, `number[]`, `boolean[]` and `Collection*[]`
+- `string[]`, `number[]`, `boolean[]`, `PublicKey[]` and `Collection*[]`
 - `map<string | number, T>`
 
 Where `Collection*` is the name of a specific collection in the same namespace.
@@ -324,7 +324,7 @@ and the hexidecimal representation of the 64 byte public key.
 
 #### Arrays
 
-You can create arrays of `string`, `number`, `boolean` and `Collection` type. For example:
+You can create arrays of `string`, `number`, `boolean`, `PublicKey` and `Collection` type. For example:
 
 ```js
 @public
@@ -334,6 +334,7 @@ collection User {
   ages: number[];
   attempts: boolean[];
   friends: User[];
+  keys: PublicKey[];
 }
 ```
 

Diff for: mint.json

@@ -1,5 +1,8 @@
 {
   "name": "Polybase",
+  "versions": [
+    "0.6.0"
+  ],
   "logo": {
     "light": "/logo/light.svg",
     "dark": "/logo/dark.svg"
@@ -114,4 +117,4 @@
       "apiHost": "https://a.polybase.xyz"
     }
   }
-}
+}

Diff for: read.mdx

@@ -22,7 +22,13 @@ const db = new Polybase({ defaultNamespace: "your-namespace" });
 const collectionReference = db.collection("cities");
 
 async function getRecord () {
-  const { data, block } = await collectionReference.record("id").get();
+  const record = await collectionReference.record("id").get();
+
+  // Get data from the record
+  const { data } = record; // or const data = record.data
+
+  // Record is CollectionRecordResponse instance, so you can also get again to refresh
+  const updatedRecord = record.get();
 }
 ```
 
@@ -74,6 +80,12 @@ const collectionReference = db.collection("cities");
 
 export async function listRecordsWithFilter () {
   const records = await collectionReference.where("country", "==", "UK").get();
+
+  // Array of records is available under the data property
+  const { data, cursor } = records;
+
+  // Records is QueryResponse, so we can use it to get the next page of results
+  await records.next();
 }
 
 ```
@@ -110,3 +122,43 @@ const collectionReference = db
     }
   );
 ```
+
+## Pagination
+
+You can paginate through your results using the cursor returned from the
+`.get()` method, or by using the built-in `.next()` 
+
+### Pagination with cursor 
+
+Use the cursor response with `.before()` and `.after()` to paginate through
+collection data.
+
+```js
+const db = new Polybase({ defaultNamespace: "your-namespace" });
+const collectionReference = await db.collection("cities");
+
+// First page
+const { data, cursor } = await collectionReference.get();
+
+// Next page
+const next = await collectionReference.after(cursor.after).get();
+
+// Previous page
+const previous = await collectionReference.before(cursor.before).get();
+```
+
+### Pagination with next() or previous()
+
+To simplify this process, a `next()` and `previous()` helper method is provided on the response.
+
+```js
+const db = new Polybase({ defaultNamespace: "your-namespace" });
+const collectionReference = await db.collection("cities");
+
+// First page
+const first = await collectionReference.get();
+
+// Next pages
+const second = await first.next();
+const third = await second.next();
+```