Apache Solr open-source search software
SOLR-15761 Remove jdbc() stream from refGuide since it can no longer be used as an expression (#788)
Jan Høydahl5a5989e5b616
diff --git a/solr/solr-ref-guide/modules/query-guide/pages/stream-source-reference.adoc b/solr/solr-ref-guide/modules/query-guide/pages/stream-source-reference.adocindex abe3b97e5d8..bb58b3a056a 100644--- a/solr/solr-ref-guide/modules/query-guide/pages/stream-source-reference.adoc+++ b/solr/solr-ref-guide/modules/query-guide/pages/stream-source-reference.adoc@@ -57,80 +57,6 @@ expr=search(collection1,sort="a_f asc, a_i asc")-----== jdbc--The `jdbc` function searches a JDBC datasource and emits a stream of tuples representing the JDBC result set.-Each row in the result set is translated into a tuple and each tuple contains all the cell values for that row.--=== jdbc Parameters--* `connection`: (Mandatory) JDBC formatted connection string to whatever driver you are using.-* `sql`: (Mandatory) query to pass off to the JDBC endpoint-* `sort`: (Mandatory) The sort criteria indicating how the data coming out of the JDBC stream is sorted-* `driver`: The name of the JDBC driver used for the connection.-If provided then the driver class will attempt to be loaded into the JVM.-If not provided then it is assumed that the driver is already loaded into the JVM.-Some drivers require explicit loading so this option is provided.-* `[driverProperty]`: One or more properties to pass to the JDBC driver during connection.-The format is `propertyName="propertyValue"`.-You can provide as many of these properties as you'd like and they will all be passed to the connection.--=== Connections and Drivers--Because some JDBC drivers require explicit loading the `driver` parameter can be used to provide the driver class name.-If provided, then during stream construction the driver will be loaded.-If the driver cannot be loaded because the class is not found on the classpath, then stream construction will fail.--When the JDBC stream is opened it will validate that a driver can be found for the provided connection string.-If a driver cannot be found (because it hasn't been loaded) then the open will fail.--=== Datatypes--Due to the inherent differences in datatypes across JDBC sources the following datatypes are supported.-The table indicates what Java type will be used for a given JDBC type.-Types marked as requiring conversion will go through a conversion for each value of that type.-For performance reasons the cell data types are only considered when the stream is opened as this is when the converters are created.--[width="100%",options="header",]-|===-|JDBC Type |Java Type |Requires Conversion-|String |String |No-|Short |Long |Yes-|Integer |Long |Yes-|Long |Long |No-|Float |Double |Yes-|Double |Double |No-|Boolean |Boolean |No-|===--=== jdbc Syntax--A basic `jdbc` expression:--[source,text]------jdbc(- connection="jdbc:hsqldb:mem:.",- sql="select NAME, ADDRESS, EMAIL, AGE from PEOPLE where AGE > 25 order by AGE, NAME DESC",- sort="AGE asc, NAME desc",- driver="org.hsqldb.jdbcDriver"-)-------A `jdbc` expression that passes a property to the driver:--[source,text]------// get_column_name is a property to pass to the hsqldb driver-jdbc(- connection="jdbc:hsqldb:mem:.",- sql="select NAME as FIRST_NAME, ADDRESS, EMAIL, AGE from PEOPLE where AGE > 25 order by AGE, NAME DESC",- sort="AGE asc, NAME desc",- driver="org.hsqldb.jdbcDriver",- get_column_name="false"-)------== drillThe `drill` function is designed to support efficient high cardinality aggregation.