Skip to content

Support dynamic query mode in preview api #532

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 22, 2024
Merged

Support dynamic query mode in preview api #532

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
73d3085
consider dynamic query mode in preview
goldmedal Apr 19, 2024
cb0527a
add test and refactor to testing based DuckDB
goldmedal Apr 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion wren-main/src/main/java/io/wren/main/PreviewService.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,8 @@
import io.wren.base.ConnectorRecordIterator;
import io.wren.base.SessionContext;
import io.wren.base.WrenMDL;
import io.wren.base.config.ConfigManager;
import io.wren.base.config.WrenConfig;
import io.wren.base.sql.SqlConverter;
import io.wren.base.sqlrewrite.WrenPlanner;
import io.wren.main.metadata.Metadata;
Expand All @@ -51,22 +53,27 @@ public class PreviewService
private final Metadata metadata;

private final SqlConverter sqlConverter;
private final ConfigManager configManager;

@Inject
public PreviewService(
Metadata metadata,
SqlConverter sqlConverter)
SqlConverter sqlConverter,
ConfigManager configManager)
{
this.metadata = requireNonNull(metadata, "metadata is null");
this.sqlConverter = requireNonNull(sqlConverter, "sqlConverter is null");
this.configManager = requireNonNull(configManager, "configManager is null");
}

public CompletableFuture<QueryResultDto> preview(WrenMDL mdl, String sql, long limit)
{
return CompletableFuture.supplyAsync(() -> {
WrenConfig config = configManager.getConfig(WrenConfig.class);
SessionContext sessionContext = SessionContext.builder()
.setCatalog(mdl.getCatalog())
.setSchema(mdl.getSchema())
.setEnableDynamic(config.getEnableDynamicFields())
.build();

String planned = WrenPlanner.rewrite(sql, sessionContext, new AnalyzedMDL(mdl, null));
Expand All @@ -85,9 +92,11 @@ public CompletableFuture<QueryResultDto> preview(WrenMDL mdl, String sql, long l
public CompletableFuture<String> dryPlan(WrenMDL mdl, String sql, boolean isModelingOnly)
{
return CompletableFuture.supplyAsync(() -> {
WrenConfig config = configManager.getConfig(WrenConfig.class);
SessionContext sessionContext = SessionContext.builder()
.setCatalog(mdl.getCatalog())
.setSchema(mdl.getSchema())
.setEnableDynamic(config.getEnableDynamicFields())
.build();

String planned = WrenPlanner.rewrite(sql, sessionContext, new AnalyzedMDL(mdl, null));
Expand All @@ -101,9 +110,11 @@ public CompletableFuture<String> dryPlan(WrenMDL mdl, String sql, boolean isMode
public CompletableFuture<List<Column>> dryRun(WrenMDL mdl, String sql)
{
return CompletableFuture.supplyAsync(() -> {
WrenConfig config = configManager.getConfig(WrenConfig.class);
SessionContext sessionContext = SessionContext.builder()
.setCatalog(mdl.getCatalog())
.setSchema(mdl.getSchema())
.setEnableDynamic(config.getEnableDynamicFields())
.build();

String planned = WrenPlanner.rewrite(sql, sessionContext, new AnalyzedMDL(mdl, null));
Expand Down
2 changes: 1 addition & 1 deletion wren-main/src/main/java/io/wren/main/WrenManager.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ private void archiveWrenMDL(WrenMDL oldWrenMDL)
}
}
Files.copy(wrenMDLFile.toPath(),
archived.toPath().resolve(wrenMDLFile.getName() + "." + LocalDateTime.now().format(DateTimeFormatter.ofPattern("uuuuMMddHHmmss"))));
archived.toPath().resolve(wrenMDLFile.getName() + "." + LocalDateTime.now().format(DateTimeFormatter.ofPattern("uuuuMMddHHmmssnnnn"))));
}

public boolean checkStatus()
Expand Down
178 changes: 138 additions & 40 deletions wren-tests/src/test/java/io/wren/testing/TestMDLResource.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,13 @@
package io.wren.testing;

import com.google.common.collect.ImmutableMap;
import com.google.common.io.Resources;
import com.google.inject.Key;
import io.wren.base.dto.Column;
import io.wren.base.dto.JoinType;
import io.wren.base.dto.Manifest;
import io.wren.base.type.BigIntType;
import io.wren.base.type.IntegerType;
import io.wren.main.connector.duckdb.DuckDBMetadata;
import io.wren.main.web.dto.CheckOutputDto;
import io.wren.main.web.dto.DeployInputDto;
import io.wren.main.web.dto.DryPlanDto;
Expand All @@ -30,14 +34,18 @@
import java.nio.file.Path;
import java.util.List;

import static io.wren.base.Utils.randomIntString;
import static io.wren.base.client.duckdb.FileUtil.ARCHIVED;
import static io.wren.base.config.WrenConfig.DataSourceType.DUCKDB;
import static io.wren.base.config.WrenConfig.WREN_DATASOURCE_TYPE;
import static io.wren.base.config.WrenConfig.WREN_DIRECTORY;
import static io.wren.base.config.WrenConfig.WREN_ENABLE_DYNAMIC_FIELDS;
import static io.wren.base.dto.Column.caluclatedColumn;
import static io.wren.base.dto.Column.column;
import static io.wren.base.dto.Manifest.MANIFEST_JSON_CODEC;
import static io.wren.base.dto.Model.model;
import static io.wren.base.dto.Relationship.relationship;
import static io.wren.testing.WebApplicationExceptionAssert.assertWebApplicationException;
import static java.lang.String.format;
import static java.lang.System.getenv;
import static java.nio.charset.StandardCharsets.UTF_8;
import static java.util.Objects.requireNonNull;
import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.assertThatNoException;
Expand All @@ -49,22 +57,23 @@ public class TestMDLResource
private Path mdlDir;
private Manifest initial = Manifest.builder()
.setCatalog("wrenai")
.setSchema("tpch_tiny")
.setSchema("tpch")
.setModels(List.of(
model("Orders", "SELECT * FROM wrenai.tpch_tiny.orders", List.of(column("orderkey", "integer", null, false, "o_orderkey")))))
model("Orders", "SELECT * FROM tpch.orders", List.of(column("orderkey", "integer", null, false, "o_orderkey")))))
.build();

private Manifest updated = Manifest.builder()
.setCatalog("wrenai")
.setSchema("tpch_tiny")
.setSchema("tpch")
.setModels(List.of(
model("Orders", "SELECT * FROM wrenai.tpch_tiny.orders",
model("Orders", "SELECT * FROM tpch.orders",
List.of(column("orderkey", "integer", null, false, "o_orderkey"),
column("custkey", "integer", null, false, "o_custkey")))))
.build();

@Override
protected TestingWrenServer createWrenServer()
throws Exception
{
try {
mdlDir = Files.createTempDirectory("wrenmdls");
Expand All @@ -76,16 +85,26 @@ protected TestingWrenServer createWrenServer()
}

ImmutableMap.Builder<String, String> properties = ImmutableMap.<String, String>builder()
.put("bigquery.project-id", getenv("TEST_BIG_QUERY_PROJECT_ID"))
.put("bigquery.location", "asia-east1")
.put("bigquery.credentials-key", getenv("TEST_BIG_QUERY_CREDENTIALS_BASE64_JSON"))
.put("bigquery.metadata.schema.prefix", format("test_%s_", randomIntString()))
.put("wren.directory", mdlDir.toAbsolutePath().toString())
.put("wren.datasource.type", "bigquery");

return TestingWrenServer.builder()
.put(WREN_DIRECTORY, mdlDir.toAbsolutePath().toString())
.put(WREN_DATASOURCE_TYPE, DUCKDB.name())
.put(WREN_ENABLE_DYNAMIC_FIELDS, "true");

TestingWrenServer testing = TestingWrenServer.builder()
.setRequiredConfigs(properties.build())
.build();
initDuckDB(testing);
return testing;
}

protected void initDuckDB(TestingWrenServer wrenServer)
throws Exception
{
ClassLoader classLoader = getClass().getClassLoader();
String initSQL = Resources.toString(requireNonNull(classLoader.getResource("duckdb/init.sql")).toURI().toURL(), UTF_8);
initSQL = initSQL.replaceAll("basePath", requireNonNull(classLoader.getResource("tpch/data")).getPath());
DuckDBMetadata metadata = wrenServer.getInstance(Key.get(DuckDBMetadata.class));
metadata.setInitSQL(initSQL);
metadata.reload();
}

@Test
Expand Down Expand Up @@ -117,9 +136,9 @@ public void testPreview()
{
Manifest previewManifest = Manifest.builder()
.setCatalog("wrenai")
.setSchema("tpch_tiny")
.setSchema("tpch")
.setModels(List.of(
model("Customer", "SELECT * FROM wrenai.tpch_tiny.customer",
model("Customer", "SELECT * FROM tpch.customer",
List.of(column("custkey", "integer", null, false, "c_custkey")))))
.build();

Expand All @@ -128,7 +147,7 @@ public void testPreview()
assertThat(testDefault.getData().size()).isEqualTo(100);
assertThat(testDefault.getColumns().size()).isEqualTo(1);
assertThat(testDefault.getColumns().get(0).getName()).isEqualTo("custkey");
assertThat(testDefault.getColumns().get(0).getType()).isEqualTo(BigIntType.BIGINT);
assertThat(testDefault.getColumns().get(0).getType()).isEqualTo(IntegerType.INTEGER);

PreviewDto testDefaultDto1 = new PreviewDto(previewManifest, "select custkey from Customer limit 200", null);
QueryResultDto preview1 = preview(testDefaultDto1);
Expand All @@ -141,68 +160,147 @@ public void testPreview()
assertThat(preview2.getColumns().size()).isEqualTo(1);

assertWebApplicationException(() -> preview(new PreviewDto(previewManifest, "select orderkey from Orders limit 100", null)))
.hasErrorMessageMatches(".*Table \"Orders\" must be qualified with a dataset.*");
.hasErrorMessageMatches(".*Orders does not exist.*\n.*\n.*\n.*");
}

@Test
public void testDryRunAndDryPlan()
{
Manifest previewManifest = Manifest.builder()
.setCatalog("wrenai")
.setSchema("tpch_tiny")
.setSchema("tpch")
.setModels(List.of(
model("Customer", "SELECT * FROM \"wrenai\".tpch_tiny.customer",
List.of(column("custkey", "integer", null, false, "c_custkey")))))
model("Customer", "SELECT * FROM tpch.customer",
List.of(column("custkey", "integer", null, false, "c_custkey"),
column("name", "varchar", null, false, "c_name"))),
model("Orders", "SELECT * FROM tpch.orders",
List.of(column("orderkey", "integer", null, false, "o_orderkey"),
column("custkey", "integer", null, false, "o_custkey"),
column("customer", "Customer", "CustomerOrders", false),
caluclatedColumn("customer_name", "varchar", "customer.name")),
"orderkey")))
.setRelationships(List.of(relationship("CustomerOrders", List.of("Customer", "Orders"), JoinType.ONE_TO_MANY, "Customer.custkey = Orders.custkey")))
.build();

PreviewDto testDefaultDto1 = new PreviewDto(previewManifest, "select custkey from Customer limit 200", null);
PreviewDto testDefaultDto1 = new PreviewDto(previewManifest, "select orderkey from Orders limit 200", null);
List<Column> dryRun = dryRun(testDefaultDto1);
assertThat(dryRun.size()).isEqualTo(1);
assertThat(dryRun.get(0).getName()).isEqualTo("custkey");
assertThat(dryRun.get(0).getName()).isEqualTo("orderkey");

DryPlanDto dryPlanDto = new DryPlanDto(previewManifest, "select custkey from Customer limit 200", false);
DryPlanDto dryPlanDto = new DryPlanDto(previewManifest, "select orderkey from Orders limit 200", false);
String dryPlan = dryPlan(dryPlanDto);
assertThat(dryPlan).isEqualTo("""
WITH
`Customer` AS (
SELECT `Customer`.`custkey` `custkey`
"Orders" AS (
SELECT
"Orders"."orderkey" "orderkey"
, "Orders"."custkey" "custkey"
FROM
(
SELECT
o_orderkey "orderkey"
, o_custkey "custkey"
FROM
(
SELECT *
FROM
tpch.orders
) "Orders"
) "Orders"
)\s
SELECT orderkey
FROM
Orders
LIMIT 200
""");

dryPlanDto = new DryPlanDto(previewManifest, "select orderkey from Orders limit 200", true);
dryPlan = dryPlan(dryPlanDto);
assertThat(dryPlan).isEqualTo("""
WITH
"Orders" AS (
SELECT
"Orders"."orderkey" "orderkey"
, "Orders"."custkey" "custkey"
FROM
(
SELECT c_custkey `custkey`
SELECT
o_orderkey "orderkey"
, o_custkey "custkey"
FROM
(
SELECT *
FROM
`wrenai`.tpch_tiny.customer
) `Customer`
) `Customer`
tpch.orders
) "Orders"
) "Orders"
)\s
SELECT custkey
SELECT orderkey
FROM
Customer
Orders
LIMIT 200
""");

dryPlanDto = new DryPlanDto(previewManifest, "select custkey from Customer limit 200", true);
dryPlanDto = new DryPlanDto(previewManifest, "select customer_name from Orders limit 200", false);
dryPlan = dryPlan(dryPlanDto);
assertThat(dryPlan).isEqualTo("""
WITH
"Customer" AS (
SELECT "Customer"."custkey" "custkey"
SELECT
"Customer"."custkey" "custkey"
, "Customer"."name" "name"
FROM
(
SELECT c_custkey "custkey"
SELECT
c_custkey "custkey"
, c_name "name"
FROM
(
SELECT *
FROM
"wrenai".tpch_tiny.customer
tpch.customer
) "Customer"
) "Customer"
)\s
SELECT custkey
, "Orders" AS (
SELECT
"Orders"."orderkey" "orderkey"
, "Orders"."custkey" "custkey"
, "Orders_relationsub"."customer_name" "customer_name"
FROM
((
SELECT
o_orderkey "orderkey"
, o_custkey "custkey"
FROM
(
SELECT *
FROM
tpch.orders
) "Orders"
) "Orders"
LEFT JOIN (
SELECT
"Orders"."orderkey"
, "Customer"."name" "customer_name"
FROM
((
SELECT
o_orderkey "orderkey"
, o_custkey "custkey"
FROM
(
SELECT *
FROM
tpch.orders
) "Orders"
) "Orders"
LEFT JOIN "Customer" ON ("Customer"."custkey" = "Orders"."custkey"))
) "Orders_relationsub" ON ("Orders"."orderkey" = "Orders_relationsub"."orderkey"))
)\s
SELECT customer_name
FROM
Customer
Orders
LIMIT 200
""");
}
Expand Down
Loading