curl --request POST \
--url https://oleander.dev/api/v1/warehouse/polars \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data @- <<EOF
{
"query": "SELECT species, avg(sepal_length) AS avg_sepal_length, avg(petal_length) AS avg_petal_length FROM flowers GROUP BY species ORDER BY avg_sepal_length DESC",
"tables": [
"flowers=default.flowers"
],
"script": "table = params.get('table', 'default.flowers')\nlimit = int(params.get('limit', 50))\n\nflowers = scan(table)\n\nresult = (\n flowers.group_by('species')\n .agg(\n pl.len().alias('count'),\n pl.col('sepal_length').mean().round(2).alias('avg_sepal_length'),\n pl.col('petal_length').mean().round(2).alias('avg_petal_length'),\n )\n .sort('avg_sepal_length', descending=True)\n .head(limit)\n)",
"params": {
"table": "default.flowers",
"limit": "25"
},
"distributed": false,
"instanceType": "t4g.medium",
"clusterSize": 4,
"vcpus": 2,
"catalog": "oleander",
"destination": "default.flower_summary",
"saveMode": "overwrite"
}
EOFimport requests
url = "https://oleander.dev/api/v1/warehouse/polars"
payload = {
"query": "SELECT species, avg(sepal_length) AS avg_sepal_length, avg(petal_length) AS avg_petal_length FROM flowers GROUP BY species ORDER BY avg_sepal_length DESC",
"tables": ["flowers=default.flowers"],
"script": "table = params.get('table', 'default.flowers')
limit = int(params.get('limit', 50))
flowers = scan(table)
result = (
flowers.group_by('species')
.agg(
pl.len().alias('count'),
pl.col('sepal_length').mean().round(2).alias('avg_sepal_length'),
pl.col('petal_length').mean().round(2).alias('avg_petal_length'),
)
.sort('avg_sepal_length', descending=True)
.head(limit)
)",
"params": {
"table": "default.flowers",
"limit": "25"
},
"distributed": False,
"instanceType": "t4g.medium",
"clusterSize": 4,
"vcpus": 2,
"catalog": "oleander",
"destination": "default.flower_summary",
"saveMode": "overwrite"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
query: 'SELECT species, avg(sepal_length) AS avg_sepal_length, avg(petal_length) AS avg_petal_length FROM flowers GROUP BY species ORDER BY avg_sepal_length DESC',
tables: ['flowers=default.flowers'],
script: 'table = params.get(\'table\', \'default.flowers\')\nlimit = int(params.get(\'limit\', 50))\n\nflowers = scan(table)\n\nresult = (\n flowers.group_by(\'species\')\n .agg(\n pl.len().alias(\'count\'),\n pl.col(\'sepal_length\').mean().round(2).alias(\'avg_sepal_length\'),\n pl.col(\'petal_length\').mean().round(2).alias(\'avg_petal_length\'),\n )\n .sort(\'avg_sepal_length\', descending=True)\n .head(limit)\n)',
params: {table: 'default.flowers', limit: '25'},
distributed: false,
instanceType: 't4g.medium',
clusterSize: 4,
vcpus: 2,
catalog: 'oleander',
destination: 'default.flower_summary',
saveMode: 'overwrite'
})
};
fetch('https://oleander.dev/api/v1/warehouse/polars', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://oleander.dev/api/v1/warehouse/polars",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'query' => 'SELECT species, avg(sepal_length) AS avg_sepal_length, avg(petal_length) AS avg_petal_length FROM flowers GROUP BY species ORDER BY avg_sepal_length DESC',
'tables' => [
'flowers=default.flowers'
],
'script' => 'table = params.get(\'table\', \'default.flowers\')
limit = int(params.get(\'limit\', 50))
flowers = scan(table)
result = (
flowers.group_by(\'species\')
.agg(
pl.len().alias(\'count\'),
pl.col(\'sepal_length\').mean().round(2).alias(\'avg_sepal_length\'),
pl.col(\'petal_length\').mean().round(2).alias(\'avg_petal_length\'),
)
.sort(\'avg_sepal_length\', descending=True)
.head(limit)
)',
'params' => [
'table' => 'default.flowers',
'limit' => '25'
],
'distributed' => false,
'instanceType' => 't4g.medium',
'clusterSize' => 4,
'vcpus' => 2,
'catalog' => 'oleander',
'destination' => 'default.flower_summary',
'saveMode' => 'overwrite'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://oleander.dev/api/v1/warehouse/polars"
payload := strings.NewReader("{\n \"query\": \"SELECT species, avg(sepal_length) AS avg_sepal_length, avg(petal_length) AS avg_petal_length FROM flowers GROUP BY species ORDER BY avg_sepal_length DESC\",\n \"tables\": [\n \"flowers=default.flowers\"\n ],\n \"script\": \"table = params.get('table', 'default.flowers')\\nlimit = int(params.get('limit', 50))\\n\\nflowers = scan(table)\\n\\nresult = (\\n flowers.group_by('species')\\n .agg(\\n pl.len().alias('count'),\\n pl.col('sepal_length').mean().round(2).alias('avg_sepal_length'),\\n pl.col('petal_length').mean().round(2).alias('avg_petal_length'),\\n )\\n .sort('avg_sepal_length', descending=True)\\n .head(limit)\\n)\",\n \"params\": {\n \"table\": \"default.flowers\",\n \"limit\": \"25\"\n },\n \"distributed\": false,\n \"instanceType\": \"t4g.medium\",\n \"clusterSize\": 4,\n \"vcpus\": 2,\n \"catalog\": \"oleander\",\n \"destination\": \"default.flower_summary\",\n \"saveMode\": \"overwrite\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://oleander.dev/api/v1/warehouse/polars")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"query\": \"SELECT species, avg(sepal_length) AS avg_sepal_length, avg(petal_length) AS avg_petal_length FROM flowers GROUP BY species ORDER BY avg_sepal_length DESC\",\n \"tables\": [\n \"flowers=default.flowers\"\n ],\n \"script\": \"table = params.get('table', 'default.flowers')\\nlimit = int(params.get('limit', 50))\\n\\nflowers = scan(table)\\n\\nresult = (\\n flowers.group_by('species')\\n .agg(\\n pl.len().alias('count'),\\n pl.col('sepal_length').mean().round(2).alias('avg_sepal_length'),\\n pl.col('petal_length').mean().round(2).alias('avg_petal_length'),\\n )\\n .sort('avg_sepal_length', descending=True)\\n .head(limit)\\n)\",\n \"params\": {\n \"table\": \"default.flowers\",\n \"limit\": \"25\"\n },\n \"distributed\": false,\n \"instanceType\": \"t4g.medium\",\n \"clusterSize\": 4,\n \"vcpus\": 2,\n \"catalog\": \"oleander\",\n \"destination\": \"default.flower_summary\",\n \"saveMode\": \"overwrite\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://oleander.dev/api/v1/warehouse/polars")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"query\": \"SELECT species, avg(sepal_length) AS avg_sepal_length, avg(petal_length) AS avg_petal_length FROM flowers GROUP BY species ORDER BY avg_sepal_length DESC\",\n \"tables\": [\n \"flowers=default.flowers\"\n ],\n \"script\": \"table = params.get('table', 'default.flowers')\\nlimit = int(params.get('limit', 50))\\n\\nflowers = scan(table)\\n\\nresult = (\\n flowers.group_by('species')\\n .agg(\\n pl.len().alias('count'),\\n pl.col('sepal_length').mean().round(2).alias('avg_sepal_length'),\\n pl.col('petal_length').mean().round(2).alias('avg_petal_length'),\\n )\\n .sort('avg_sepal_length', descending=True)\\n .head(limit)\\n)\",\n \"params\": {\n \"table\": \"default.flowers\",\n \"limit\": \"25\"\n },\n \"distributed\": false,\n \"instanceType\": \"t4g.medium\",\n \"clusterSize\": 4,\n \"vcpus\": 2,\n \"catalog\": \"oleander\",\n \"destination\": \"default.flower_summary\",\n \"saveMode\": \"overwrite\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"results": {
"columns": [
"<string>"
],
"column_types": [
"<string>"
],
"rows": [
[
"<unknown>"
]
]
},
"row_count": 123,
"execution_time": "<string>",
"error": "<string>",
"saved": {
"table": "<string>",
"rows_written": 123,
"mode": "<string>"
},
"compute": {
"mode": "<string>",
"distributed": true,
"instanceType": "<string>",
"clusterSize": 123,
"vcpus": 123
}
}{
"error": "<string>",
"details": "<string>"
}{
"error": "Unauthorized"
}{
"status": 500
}Polars
Execute a Polars workload against your Iceberg lake tables. Supports two modes: query (Polars SQL run against registered tables) and script (user-authored Python that assigns result to a LazyFrame or DataFrame). Workloads run in an isolated sandbox; pass distributed: true to run across multiple workers. Distributed runs require the Pro++ plan.
curl --request POST \
--url https://oleander.dev/api/v1/warehouse/polars \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data @- <<EOF
{
"query": "SELECT species, avg(sepal_length) AS avg_sepal_length, avg(petal_length) AS avg_petal_length FROM flowers GROUP BY species ORDER BY avg_sepal_length DESC",
"tables": [
"flowers=default.flowers"
],
"script": "table = params.get('table', 'default.flowers')\nlimit = int(params.get('limit', 50))\n\nflowers = scan(table)\n\nresult = (\n flowers.group_by('species')\n .agg(\n pl.len().alias('count'),\n pl.col('sepal_length').mean().round(2).alias('avg_sepal_length'),\n pl.col('petal_length').mean().round(2).alias('avg_petal_length'),\n )\n .sort('avg_sepal_length', descending=True)\n .head(limit)\n)",
"params": {
"table": "default.flowers",
"limit": "25"
},
"distributed": false,
"instanceType": "t4g.medium",
"clusterSize": 4,
"vcpus": 2,
"catalog": "oleander",
"destination": "default.flower_summary",
"saveMode": "overwrite"
}
EOFimport requests
url = "https://oleander.dev/api/v1/warehouse/polars"
payload = {
"query": "SELECT species, avg(sepal_length) AS avg_sepal_length, avg(petal_length) AS avg_petal_length FROM flowers GROUP BY species ORDER BY avg_sepal_length DESC",
"tables": ["flowers=default.flowers"],
"script": "table = params.get('table', 'default.flowers')
limit = int(params.get('limit', 50))
flowers = scan(table)
result = (
flowers.group_by('species')
.agg(
pl.len().alias('count'),
pl.col('sepal_length').mean().round(2).alias('avg_sepal_length'),
pl.col('petal_length').mean().round(2).alias('avg_petal_length'),
)
.sort('avg_sepal_length', descending=True)
.head(limit)
)",
"params": {
"table": "default.flowers",
"limit": "25"
},
"distributed": False,
"instanceType": "t4g.medium",
"clusterSize": 4,
"vcpus": 2,
"catalog": "oleander",
"destination": "default.flower_summary",
"saveMode": "overwrite"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
query: 'SELECT species, avg(sepal_length) AS avg_sepal_length, avg(petal_length) AS avg_petal_length FROM flowers GROUP BY species ORDER BY avg_sepal_length DESC',
tables: ['flowers=default.flowers'],
script: 'table = params.get(\'table\', \'default.flowers\')\nlimit = int(params.get(\'limit\', 50))\n\nflowers = scan(table)\n\nresult = (\n flowers.group_by(\'species\')\n .agg(\n pl.len().alias(\'count\'),\n pl.col(\'sepal_length\').mean().round(2).alias(\'avg_sepal_length\'),\n pl.col(\'petal_length\').mean().round(2).alias(\'avg_petal_length\'),\n )\n .sort(\'avg_sepal_length\', descending=True)\n .head(limit)\n)',
params: {table: 'default.flowers', limit: '25'},
distributed: false,
instanceType: 't4g.medium',
clusterSize: 4,
vcpus: 2,
catalog: 'oleander',
destination: 'default.flower_summary',
saveMode: 'overwrite'
})
};
fetch('https://oleander.dev/api/v1/warehouse/polars', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://oleander.dev/api/v1/warehouse/polars",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'query' => 'SELECT species, avg(sepal_length) AS avg_sepal_length, avg(petal_length) AS avg_petal_length FROM flowers GROUP BY species ORDER BY avg_sepal_length DESC',
'tables' => [
'flowers=default.flowers'
],
'script' => 'table = params.get(\'table\', \'default.flowers\')
limit = int(params.get(\'limit\', 50))
flowers = scan(table)
result = (
flowers.group_by(\'species\')
.agg(
pl.len().alias(\'count\'),
pl.col(\'sepal_length\').mean().round(2).alias(\'avg_sepal_length\'),
pl.col(\'petal_length\').mean().round(2).alias(\'avg_petal_length\'),
)
.sort(\'avg_sepal_length\', descending=True)
.head(limit)
)',
'params' => [
'table' => 'default.flowers',
'limit' => '25'
],
'distributed' => false,
'instanceType' => 't4g.medium',
'clusterSize' => 4,
'vcpus' => 2,
'catalog' => 'oleander',
'destination' => 'default.flower_summary',
'saveMode' => 'overwrite'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://oleander.dev/api/v1/warehouse/polars"
payload := strings.NewReader("{\n \"query\": \"SELECT species, avg(sepal_length) AS avg_sepal_length, avg(petal_length) AS avg_petal_length FROM flowers GROUP BY species ORDER BY avg_sepal_length DESC\",\n \"tables\": [\n \"flowers=default.flowers\"\n ],\n \"script\": \"table = params.get('table', 'default.flowers')\\nlimit = int(params.get('limit', 50))\\n\\nflowers = scan(table)\\n\\nresult = (\\n flowers.group_by('species')\\n .agg(\\n pl.len().alias('count'),\\n pl.col('sepal_length').mean().round(2).alias('avg_sepal_length'),\\n pl.col('petal_length').mean().round(2).alias('avg_petal_length'),\\n )\\n .sort('avg_sepal_length', descending=True)\\n .head(limit)\\n)\",\n \"params\": {\n \"table\": \"default.flowers\",\n \"limit\": \"25\"\n },\n \"distributed\": false,\n \"instanceType\": \"t4g.medium\",\n \"clusterSize\": 4,\n \"vcpus\": 2,\n \"catalog\": \"oleander\",\n \"destination\": \"default.flower_summary\",\n \"saveMode\": \"overwrite\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://oleander.dev/api/v1/warehouse/polars")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"query\": \"SELECT species, avg(sepal_length) AS avg_sepal_length, avg(petal_length) AS avg_petal_length FROM flowers GROUP BY species ORDER BY avg_sepal_length DESC\",\n \"tables\": [\n \"flowers=default.flowers\"\n ],\n \"script\": \"table = params.get('table', 'default.flowers')\\nlimit = int(params.get('limit', 50))\\n\\nflowers = scan(table)\\n\\nresult = (\\n flowers.group_by('species')\\n .agg(\\n pl.len().alias('count'),\\n pl.col('sepal_length').mean().round(2).alias('avg_sepal_length'),\\n pl.col('petal_length').mean().round(2).alias('avg_petal_length'),\\n )\\n .sort('avg_sepal_length', descending=True)\\n .head(limit)\\n)\",\n \"params\": {\n \"table\": \"default.flowers\",\n \"limit\": \"25\"\n },\n \"distributed\": false,\n \"instanceType\": \"t4g.medium\",\n \"clusterSize\": 4,\n \"vcpus\": 2,\n \"catalog\": \"oleander\",\n \"destination\": \"default.flower_summary\",\n \"saveMode\": \"overwrite\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://oleander.dev/api/v1/warehouse/polars")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"query\": \"SELECT species, avg(sepal_length) AS avg_sepal_length, avg(petal_length) AS avg_petal_length FROM flowers GROUP BY species ORDER BY avg_sepal_length DESC\",\n \"tables\": [\n \"flowers=default.flowers\"\n ],\n \"script\": \"table = params.get('table', 'default.flowers')\\nlimit = int(params.get('limit', 50))\\n\\nflowers = scan(table)\\n\\nresult = (\\n flowers.group_by('species')\\n .agg(\\n pl.len().alias('count'),\\n pl.col('sepal_length').mean().round(2).alias('avg_sepal_length'),\\n pl.col('petal_length').mean().round(2).alias('avg_petal_length'),\\n )\\n .sort('avg_sepal_length', descending=True)\\n .head(limit)\\n)\",\n \"params\": {\n \"table\": \"default.flowers\",\n \"limit\": \"25\"\n },\n \"distributed\": false,\n \"instanceType\": \"t4g.medium\",\n \"clusterSize\": 4,\n \"vcpus\": 2,\n \"catalog\": \"oleander\",\n \"destination\": \"default.flower_summary\",\n \"saveMode\": \"overwrite\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"results": {
"columns": [
"<string>"
],
"column_types": [
"<string>"
],
"rows": [
[
"<unknown>"
]
]
},
"row_count": 123,
"execution_time": "<string>",
"error": "<string>",
"saved": {
"table": "<string>",
"rows_written": 123,
"mode": "<string>"
},
"compute": {
"mode": "<string>",
"distributed": true,
"instanceType": "<string>",
"clusterSize": 123,
"vcpus": 123
}
}{
"error": "<string>",
"details": "<string>"
}{
"error": "Unauthorized"
}{
"status": 500
}Authorizations
Body
Python script source for script mode. The script runs with pl (polars), scan(table), params, and catalog in scope. It must assign result to a Polars LazyFrame or DataFrame. Do not call .collect() or .remote() inside the script; oleander handles execution.
"table = params.get('table', 'default.flowers')\nlimit = int(params.get('limit', 50))\n\nflowers = scan(table)\n\nresult = (\n flowers.group_by('species')\n .agg(\n pl.len().alias('count'),\n pl.col('sepal_length').mean().round(2).alias('avg_sepal_length'),\n pl.col('petal_length').mean().round(2).alias('avg_petal_length'),\n )\n .sort('avg_sepal_length', descending=True)\n .head(limit)\n)"
Response
Workload executed successfully
Was this page helpful?