Skip to content
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

Adds a built-in PartiQL System catalog, support for SQL-Path, and SPI cleanup #1670

Merged
merged 13 commits into from
Dec 10, 2024
Merged

Adds a built-in PartiQL System catalog, support for SQL-Path, and SPI cleanup #1670

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
896e295
Adds a built-in PartiQL System catalog
johnedquinn Dec 3, 2024
11b1496
Moves PartiQLSystemCatalog back into SPI package
johnedquinn Dec 5, 2024
42cc72e
Adds a 'bare' Session implementation with the default system catalog
johnedquinn Dec 5, 2024
a712fba
Revert "Adds a 'bare' Session implementation with the default system …
johnedquinn Dec 6, 2024
c91977f
Adds the PartiQL System Catalog to the Session.empty()
johnedquinn Dec 6, 2024
0573517
Removes unused Catalogs.empty() public API
johnedquinn Dec 6, 2024
531659d
Renames Session.Builder#systemCatalog() to system()
johnedquinn Dec 6, 2024
628c1db
Fixes bug where system catalog wasn't being updated by Session#system()
johnedquinn Dec 6, 2024
d1b3305
Adds a singleton system catalog
johnedquinn Dec 6, 2024
57fb8b3
Renames PartiQLSystemCatalog to System
johnedquinn Dec 9, 2024
4110b4b
Fixes GitHub benchmark workflow
johnedquinn Dec 9, 2024
aa2a6f2
Updates Catalog#getTable to Catalog#resolveTable
johnedquinn Dec 9, 2024
8d9ded8
Updates usages of Collection to List in partiql-spi
johnedquinn Dec 9, 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
5 changes: 3 additions & 2 deletions partiql-spi/api/partiql-spi.api
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,7 @@ public class org/partiql/spi/SourceLocations : java/util/Map {
public abstract interface class org/partiql/spi/catalog/Catalog {
public static final field Companion Lorg/partiql/spi/catalog/Catalog$Companion;
public static fun builder ()Lorg/partiql/spi/catalog/Catalog$Builder;
public static fun empty (Ljava/lang/String;)Lorg/partiql/spi/catalog/Catalog;
public abstract fun getAggregations (Lorg/partiql/spi/catalog/Session;Ljava/lang/String;)Ljava/util/Collection;
public abstract fun getFunctions (Lorg/partiql/spi/catalog/Session;Ljava/lang/String;)Ljava/util/Collection;
public abstract fun getName ()Ljava/lang/String;
Expand All @@ -85,6 +86,7 @@ public final class org/partiql/spi/catalog/Catalog$Builder {

public final class org/partiql/spi/catalog/Catalog$Companion {
public final fun builder ()Lorg/partiql/spi/catalog/Catalog$Builder;
public final fun empty (Ljava/lang/String;)Lorg/partiql/spi/catalog/Catalog;
}

public final class org/partiql/spi/catalog/Catalog$DefaultImpls {
Expand All @@ -97,7 +99,6 @@ public final class org/partiql/spi/catalog/Catalog$DefaultImpls {
public abstract interface class org/partiql/spi/catalog/Catalogs {
public static final field Companion Lorg/partiql/spi/catalog/Catalogs$Companion;
public static fun builder ()Lorg/partiql/spi/catalog/Catalogs$Builder;
public static fun empty ()Lorg/partiql/spi/catalog/Catalogs;
public abstract fun getCatalog (Ljava/lang/String;Z)Lorg/partiql/spi/catalog/Catalog;
public static fun of (Ljava/util/Collection;)Lorg/partiql/spi/catalog/Catalogs;
public static fun of ([Lorg/partiql/spi/catalog/Catalog;)Lorg/partiql/spi/catalog/Catalogs;
Expand All @@ -111,7 +112,6 @@ public final class org/partiql/spi/catalog/Catalogs$Builder {

public final class org/partiql/spi/catalog/Catalogs$Companion {
public final fun builder ()Lorg/partiql/spi/catalog/Catalogs$Builder;
public final fun empty ()Lorg/partiql/spi/catalog/Catalogs;
public final fun of (Ljava/util/Collection;)Lorg/partiql/spi/catalog/Catalogs;
public final fun of ([Lorg/partiql/spi/catalog/Catalog;)Lorg/partiql/spi/catalog/Catalogs;
}
Expand Down Expand Up @@ -261,6 +261,7 @@ public final class org/partiql/spi/catalog/Session$Builder {
public final fun namespace (Lorg/partiql/spi/catalog/Namespace;)Lorg/partiql/spi/catalog/Session$Builder;
public final fun namespace ([Ljava/lang/String;)Lorg/partiql/spi/catalog/Session$Builder;
public final fun property (Ljava/lang/String;Ljava/lang/String;)Lorg/partiql/spi/catalog/Session$Builder;
public final fun systemCatalog (Lorg/partiql/spi/catalog/Catalog;)Lorg/partiql/spi/catalog/Session$Builder;
}

public final class org/partiql/spi/catalog/Session$Companion {
Expand Down
66 changes: 66 additions & 0 deletions partiql-spi/src/main/java/org/partiql/spi/catalog/PartiQLSystemCatalog.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
package org.partiql.spi.catalog;

import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import org.partiql.spi.function.Aggregation;
import org.partiql.spi.function.Builtins;
import org.partiql.spi.function.Function;

import java.util.Collection;

/**
* <p>
* This implements the PartiQL System Catalog.
* </p>
* <p>
* It provides the implementation for the PartiQL System Catalog, which is a built-in catalog
* that provides access to the PartiQL language and its built-in functions and aggregations.
* </p>
* @see Session.Builder
*/
final class PartiQLSystemCatalog implements Catalog {

/**
* TODO
*/
@NotNull
private final String name;

/**
* Creates a new PartiQL System Catalog with the given name.
* @param name the name of the PartiQL System Catalog
*/
PartiQLSystemCatalog(@NotNull String name) {
this.name = name;
}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

make singleton with private constructor and have a public static final String for "$system"

So it's like

protected final class System implements Catalog { 

     static final INSTANCE

     static final NAME = "\$system"
}

like that. Also I know that protected is different than package-private, but do prefer an explicit modifier

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can't make a protected top-level class. Updated the Javadocs to make the visibility more apparent, since there is no package-private modifier. And added the singleton. See latest commit: d1b3305

If we want to expose this class in the future, sure. But we don't need to right now.


@NotNull
@Override
public String getName() {
return this.name;
}

@Nullable
@Override
public Table getTable(@NotNull Session session, @NotNull Name name) {
return null;
}

@Nullable
@Override
public Table getTable(@NotNull Session session, @NotNull Identifier identifier) {
return null;
}

@NotNull
@Override
public Collection<Function> getFunctions(@NotNull Session session, @NotNull String name) {
return Builtins.INSTANCE.getFunctions(name);
}

@NotNull
@Override
public Collection<Aggregation> getAggregations(@NotNull Session session, @NotNull String name) {
return Builtins.INSTANCE.getAggregations(name);
}
}
13 changes: 13 additions & 0 deletions partiql-spi/src/main/kotlin/org/partiql/spi/catalog/Catalog.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,19 @@ public interface Catalog {

@JvmStatic
public fun builder(): Builder = Builder()

/**
* @return an empty catalog with the given name
* @param name the catalog name
*/
@JvmStatic
public fun empty(name: String): Catalog {
return object : Catalog {
override fun getName(): String = name
override fun getTable(session: Session, name: Name): Table? = null
override fun getTable(session: Session, identifier: Identifier): Table? = null
}
}
}

/**
Expand Down
14 changes: 0 additions & 14 deletions partiql-spi/src/main/kotlin/org/partiql/spi/catalog/Catalogs.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,20 +25,6 @@ public interface Catalogs {
return builder().apply { catalogs.forEach { add(it) } }.build()
}

/**
* A catalog provider that always returns an empty catalog.
*/
@JvmStatic
public fun empty(): Catalogs = object : Catalogs {
private val EMPTY = object : Catalog {
override fun getName(): String = "empty"
override fun getTable(session: Session, name: Name): Table? = null
override fun getTable(session: Session, identifier: Identifier): Table? = null
}

override fun getCatalog(name: String, ignoreCase: Boolean): Catalog = EMPTY
}

@JvmStatic
public fun builder(): Builder = Builder()
}
Expand Down
30 changes: 24 additions & 6 deletions partiql-spi/src/main/kotlin/org/partiql/spi/catalog/Session.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,11 +46,9 @@ public interface Session {
* Returns a [Session] with only the "empty" catalog implementation.
*/
@JvmStatic
public fun empty(): Session = object : Session {
override fun getIdentity(): String = "unknown"
override fun getCatalog(): String = "empty"
override fun getCatalogs(): Catalogs = Catalogs.empty()
override fun getNamespace(): Namespace = Namespace.empty()
public fun empty(): Session {
val catalog = Catalog.empty("empty")
return builder().catalog(catalog.getName()).catalogs(catalog).build()
johnedquinn marked this conversation as resolved.
Show resolved Hide resolved
}

@JvmStatic
Expand All @@ -64,6 +62,8 @@ public interface Session {

private var identity: String = "unknown"
private var catalog: String? = null
private var systemCatalogName: String = "\$pql_system"
private var systemCatalog: Catalog = PartiQLSystemCatalog(systemCatalogName)
johnedquinn marked this conversation as resolved.
Show resolved Hide resolved
private var catalogs: Catalogs.Builder = Catalogs.builder()
private var namespace: Namespace = Namespace.empty()
private var properties: MutableMap<String, String> = mutableMapOf()
Expand Down Expand Up @@ -98,6 +98,16 @@ public interface Session {
return this
}

/**
* Adds and designates a catalog to always be on the SQL-Path. This [catalog] provides all built-in functions
* to the system at hand.
* If this is never invoked, a default system catalog is provided.
*/
public fun systemCatalog(catalog: Catalog): Builder {
this.systemCatalogName = catalog.getName()
return this
}

/**
* Adds catalogs to this session.
*/
Expand All @@ -110,16 +120,24 @@ public interface Session {

public fun build(): Session = object : Session {

private val _catalogs = catalogs.build()
private val _catalogs: Catalogs
private val systemCatalogNamespace: Namespace = Namespace.of(systemCatalogName)

init {
require(catalog != null) { "Session catalog must be set" }
catalogs.add(systemCatalog)
_catalogs = catalogs.build()
}

override fun getIdentity(): String = identity
override fun getCatalog(): String = catalog!!
override fun getCatalogs(): Catalogs = _catalogs
override fun getNamespace(): Namespace = namespace

override fun getPath(): Path {
val currentNamespace = getNamespace()
return Path.of(currentNamespace, systemCatalogNamespace)
}
}
}
}
Loading