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

Jump to bottom

update ingres html description pages #15

Closed
wants to merge 1 commit into from
Closed

update ingres html description pages #15

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
76 changes: 35 additions & 41 deletions gdal/ogr/ogrsf_frmts/ingres/drv_ingres.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,29 +7,31 @@

<h1>INGRES</h1>

This driver implements read and write access for spatial data in
<a href="http://www.ingres.com/">INGRES</a> database tables. This
functionality was introduced in GDAL/OGR 1.6.0. <p>
<p>This driver implements read and write access for spatial data in
<a href="http://www.actian.com/products/ingres/geospatial/">INGRES</a> database tables. This
functionality was introduced in GDAL/OGR 1.6.0. </p>

When opening a database, it's name should be specified in the form
<p>When opening a database, it's name should be specified in the form
"@driver=ingres,[host=<i>host</i>, instance=<i>instance</i>],dbname=<i>[vnode::]dbname</i>
[,options]". where the options can
include comma seperated
items like "host=*ip_address*","instance=*instance*", "username=*userid*", "password=*password*",
"effuser=*database_user*", "dbpwd=*database_passwd*", "timeout=*timeout*",
"tables=table1/table2". The driver and dbname values are required, while
the rest are optional. If username and password are not provided an attempt
is made to authenticate as the current OS user.<p>

If the host and instance options are both specified,
the username and password *must* be supplied as to componsit the
<a href=http://docs.actian.com/ingres/10.0/command-reference-guide/1207-dynamic-vnode-specificationconnect-to-remote-node>dynamic vnode</a>.
The default protocal is Tcp/IP. If any other protocal is expected to be used, a pre-build vnode is preferable.
"tables=table1/table2".</p>

<p><b>The driver and dbname values are required, while
the rest are optional.</b> If username and password are not provided an attempt
is made to authenticate as the current OS user.</p>

<p>If the host and instance options are both specified,
the username and password *must* be supplied as it creates a temporary
<a href=http://docs.actian.com/ingres/10.0/command-reference-guide/1207-dynamic-vnode-specificationconnect-to-remote-node>dynamic vnode connection</a>.
The default protocal is TCP/IP. If any other protocal is expected to be used, a pre-built vnode is preferable.
If vnode and these two options are passed at the same time, an error will occur.
<p>
</p>

The option effuser and dbpwd are mapped to the real user name and password needs to be authorized in dbms, compared to the
username and password which are used for OS level authorization.<p>
<p>The option effuser and dbpwd are mapped to the real user name and password needs to be authorized in dbms, compared to the
username and password which are used for OS level authorization.</p>

Examples:
<pre>
Expand All @@ -48,39 +50,34 @@ <h1>INGRES</h1>
@driver=ingres,dbname=mapping
</pre>

<p>
If the tables list is not provided, an attempt is made to enumerate all
non-system tables as layers, otherwise only the listed tables are represented
as layers. This option is primarily useful when a database has a lot of
tables, and scanning all their schemas would take a significant amount of
time. <p>
time.</p>

If an integer field exists in a table that is named "ogr_fid" it will be
<p>If an integer field exists in a table that is named "ogr_fid" it will be
used as the FID, otherwise FIDs will be assigned sequentially. This can
result in different FIDs being assigned to a given record/feature depending
on the spatial and attribute query filters in effect at a given time.<p>
on the spatial and attribute query filters in effect at a given time.</p>

<p>By default, SQL statements are passed directly to the INGRES database
engine. It's also possible to request the driver to handle SQL commands
with <a href="/ogr/ogr_sql.html">OGR SQL</a> engine,
by passing <strong>"OGRSQL"</strong> string to the ExecuteSQL()
method, as name of the SQL dialect.</p>

Currently the INGRES driver supports only "old style" INGRES spatial data
types such as POLYGON, POINT, LINE, LONG POLYGON, LONG LINE, etc. It is
anticipated in the future a newer OGC compliant set of spatial types will
also be supported.<p>
<p>
The INGRES driver supports OGC SFSQL 1.1 compliant spatial types and functions,
including types: POINT, LINESTRING, POLYGON, MULTI* versions, and GEOMETRYCOLLECTION.
</p>

<h2>Caveats</h2>
<ul>
<li> The spatial types CIRCLE and ICIRCLE are not currently supported for
reading. <p>

<li> No fast spatial index is used when reading, so spatial filters are
implemented by reading and parsing all records, and then discarding those
that do not satisfy the spatial filter.<p>

<li> There is currently no support for coordinate systems.<p>

</ul>

<h2>Creation Issues</h2>
Expand All @@ -96,19 +93,6 @@ <h2>Creation Issues</h2>

<li>
The INGRES driver is not transactional at this time.<p>

<li> The spatial types BOX and IBOX are not supported for creating, and when
read are represented as polygons.<p>

<li> The non-LONG types (such as LINE, ILINE, and POLYGON) only support a
limited number of vertices. Attempts to create objects with more than the
maximum possible vertices for these types will fail. <p>

<li> The old ingres spatial types are very particular about geometry
validation, and attempts to insert (create) features with invalid geometries
will fail. Reasons for invalidity include self-intersection of linestrings,
and self-intersections for polygons. <p>

</ul>

<h3>Layer Creation Options</h3>
Expand Down Expand Up @@ -146,5 +130,15 @@ <h3>Layer Creation Options</h3>
</li>
</ul>

<h2>Older Versions</h2>
<p>The INGRES GDAL driver also includes support for old INGRES spatial types,
but these are not enabled by default. It enable these, the input <i>configure</i>
script needs to include pointers to libraries used by the older version:
<pre>INGRES_LIB="-L$II_SYSTEM/ingres/lib \
$II_SYSTEM/ingres/lib/iiclsadt.o \
$II_SYSTEM/ingres/lib/iiuseradt.o \
-liiapi.1 -lcompat.1 -lq.1 -lframe.1"
</pre>
</p>
</body>
</html>