Cinchy Platform Documentation
Cinchy v5.0 - v5.5
Cinchy v5.0 - v5.5
  • Data Collaboration Overview
  • Other Wiki Spaces
    • Cinchy Data Sync
    • Angular SDK
    • JavaScript SQK
  • Release Notes
    • Release Notes
      • 5.0 Release Notes
      • 5.1 Release Notes
      • 5.2 Release Notes
      • 5.3 Release Notes
      • 5.4 Release Notes
      • 5.5 Release Notes
      • 5.6 Release Notes
  • Getting Help
  • Frequently Asked Questions
  • Deployment Guide
    • Deployment Installation Guides
      • Deployment Planning Overview and Checklist
        • Deployment Architecture Overview
          • Kubernetes Deployment Architecture
          • IIS Deployment Architecture
        • Deployment Prerequisites
          • Single Sign-On (SSO) Integration
            • Enabling TLS 1.2
            • Configuring ADFS
            • AD Group Integration
      • Kubernetes Deployment Installation
        • Disabling your Kubernetes Applications
        • Changing your File Storage Configuration
        • Using Self-Signed SSL Certs (Kubernetes Deployments)
        • Deploying the CLI (Kubernetes)
      • IIS Deployment Platform Installation
        • Deploying Connections and the CLI (IIS)
        • Deploying the Event Listener/Worker (IIS)
    • Upgrade Guides
      • Upgrading Cinchy Versions
        • Cinchy Upgrade Utility
        • Kubernetes Upgrades
          • v5.1 (Kubernetes)
          • v5.2 (Kubernetes)
          • v5.3 (Kubernetes)
          • v5.4 (Kubernetes)
          • v5.5 (Kubernetes)
          • v5.6 (Kubernetes)
          • Updating the Kubernetes Image Registry
          • Upgrading AWS EKS Kubernetes Version
          • Upgrading AKS (Azure Kubernetes Service)
        • IIS Upgrades
          • v4.21 (IIS)
          • v4.x to v5.x (IIS)
          • v5.1 (IIS)
          • v5.2 (IIS)
          • v5.3 (IIS)
          • v5.4 (IIS)
          • v5.5 (IIS)
          • v5.6 (IIS)
      • Upgrading from v4 to v5
  • Guides for Using Cinchy
    • User Guides
      • Overview of the Data Browser
      • The Admin Panel
      • User Preferences
        • Personal Access Tokens
      • Table Features
      • Data Management
      • Queries
      • Version Management
        • Versioning Best Practices
      • Commentary
    • Builder Guides
      • Best Practices
      • Creating Tables
        • Attaching Files
        • Columns
        • Data Controls
          • Data Entitlements
          • Data Erasure
          • Data Compression
        • Restoring Tables, Columns, and Rows
        • Formatting Rules
        • Indexing and Partitioning
        • Linking Data
        • Table and Column GUIDs
        • System Tables
      • Saved Queries
      • CinchyDXD Utility
        • Building the Data Experience (CinchyDXD)
        • Packaging the Data Experience (CinchyDXD)
        • Installing the Data Experience (CinchyDXD)
        • Updating the Data Experience (CinchyDXD)
        • Repackaging the Data Experience (CinchyDXD)
        • Reinstalling the Data Experience (CinchyDXD)
      • Multi-Lingual Support
      • Integration Guides
    • Administrator Guide
    • Additional Guides
      • Monitoring and Logging on Kubernetes
        • Grafana
        • Opensearch Dashboards
          • Setting up Alerts
        • Monitoring via ArgoCD
      • Maintenance
      • GraphQL (Beta)
      • System Properties
      • Enable Data At Rest Encryption
      • MDQE
      • Application Experiences
        • Network Map
          • Custom Node Results
          • Custom Results in the Network Map
        • Setting Up Experiences
  • API Guide
    • API Overview
      • API Authentication
      • API Saved Queries
      • ExecuteCQL
      • Webhook Ingestion
  • CQL
    • The Basics of CQL
      • CQL Examples
      • CQL Functions Master List
      • CQL Statements Overview
        • Cinchy DML Statements
        • Cinchy DDL Statements
      • Cinchy Supported Functions
        • Cinchy Functions
        • Cinchy System Values
        • Cinchy User Defined Functions
          • Table-Valued Functions
          • Scalar-Valued Functions
        • Conversion Functions
        • Date and Time Types and Functions
          • Return System Date and Time Values
          • Return Date and Time Parts
          • Return Date and Time Values From Their Parts
          • Return Date and Time Difference Values
          • Modify Date and Time Values
          • Validate Date and Time Values
        • Logical Functions
        • Mathematical Functions
        • String Functions
        • Geometry and Geography Data Type and Functions
          • OGC Methods on Geometry & Geography Instances
          • Extended Methods on Geometry & Geography Instances
        • Full Text Search Functions
        • Connections Functions
        • JSON Functions
  • Meta Forms
    • Introduction to Meta-Forms
    • Meta-Forms Deployment Installation Guide
      • Deploying Meta-Forms (Kubernetes)
      • Deploying Meta-Forms (IIS)
    • Creating a Dynamic Meta-Form (Using Tables)
    • Creating a Dynamic Meta-Form Example (Using Form Designer)
    • Forms Data Types
    • Adding Links to a Form
    • Rich Text Editing in Forms
Powered by GitBook
On this page
  • 1. Overview
  • IsValidDetailed (Geometry)
  • MakeValid (Geometry)
  • Reduce (Geometry)
  • ShortestLineTo (Geometry)

Was this helpful?

Export as PDF
  1. CQL
  2. The Basics of CQL
  3. Cinchy Supported Functions
  4. Geometry and Geography Data Type and Functions

Extended Methods on Geometry & Geography Instances

PreviousOGC Methods on Geometry & Geography InstancesNextFull Text Search Functions

Last updated 2 years ago

Was this helpful?

1. Overview

Cinchy CQL supports a number of extended methods on Open Geospatial Consortium (OGC) methods on geometry and geography instances.Please note that all functions that have been denoted with Geography in parentheses are only applicable to OGC methods on geometry instances.

These function are not currently supported in PostgreSQL deployments of the Cinchy platform.

New function translations are actively being worked on by the development team; please check back at a later time.

You can review the full list of in-progress function translations.

The extended Methods covered in this section are:

IsValidDetailed (Geometry)

IsValidDetailed()returns a message that can help to identify problems with a spatial object that is not valid.

Only the first error is returned, when the object is not valid. When the object is valid, a value of 24400 is returned.

Syntax

.IsValidDetailed()  

Return Types

CQL: Text

Remarks

The following table contains possible return values:

Return Value

Description

24400

Valid

24401

Not valid, reason unknown.

24402

Not valid because point {0} is an isolated point, which is not valid in this type of object.

24403

Not valid because some pair of polygon edges overlap.

24404

Not valid because polygon ring {0} intersects itself or some other ring.

24405

Not valid because some polygon ring intersects itself or some other ring.

24406

Not valid because curve {0} degenerates to a point.

24407

Not valid because polygon ring {0} collapses to a line at point {1}.

24408

Not valid because polygon ring {0} is not closed.

24409

Not valid because some portion of polygon ring {0} lies in the interior of a polygon.

24410

Not valid because ring {0} is the first ring in a polygon of which it is not the exterior ring.

24411

Not valid because ring {0} lies outside the exterior ring {1} of its polygon.

24412

Not valid because the interior of a polygon with rings {0} and {1} is not connected.

24413

Not valid because of two overlapping edges in curve {0}.

24414

Not valid because an edge of curve {0} overlaps an edge of curve {1}.

24415

Not valid some polygon has an invalid ring structure.

24416

Not valid because in curve {0} the edge that starts at point {1} is either a line or a degenerate arc with antipodal endpoints

Geometry Example

This example of an invalid spatial object shows how the IsValidDetailed() methods behaves:

DECLARE @p GEOMETRY = 'Polygon((2 2, 4 4, 4 2, 2 4, 2 2))'  
SELECT @p.IsValidDetailed()  
--Returns: 24404: Not valid because polygon ring (1) intersects itself or some other ring.

MakeValid (Geometry)

MakeValid()converts an invalid geometry instance into a geometry instance with a valid Open Geospatial Consortium (OGC) type.

Syntax

.MakeValid ()  

Return Types

CQL: geometry

Remarks

This method may cause a change in the type of the geometry instance, as well as cause the points of a geometry instance to shift slightly.

Geometry Example

This example creates an invalid LineString instance that overlaps itself and uses MakeValid() to make this instance valid:

DECLARE @g geometry;  
SET @g = geometry::STGeomFromText('LINESTRING(0 2, 1 1, 1 0, 1 1, 2 2)', 0);  
SET @g = @g.MakeValid(); 

Reduce (Geometry)

By running the Douglas-Peucker algorithm on the instance with the given tolerance, Reduce()returns an approximation of the given geometry instance produced.

Syntax

.Reduce ( tolerance )  

Arguments

tolerance The tolerance (type float) to input for the approximation algorithm.

Return Types

CQL: geometry

Remarks

This algorithm operates independently on each geometry contained in the instance, for collection types.

Does not modify Pointinstances.

For CircularStringinstances,Reduce() returns a LineString, CircularString, or CompoundCurve instance.

For CompoundCurveinstances,Reduce() returns either a CompoundCurveor LineStringinstance.

On Polygoninstances, the approximation algorithm is applied independently to each ring. If the returned Polygoninstance is not valid, Reduce() will produce a FormatException.

When a circular arc segment is found, the approximation algorithm checks whether the arc can be approximated by its chord within half the given tolerance. Chords meeting this criteria have the circular arc replaced in the calculations by the chord. If a chord doesn't meet this criteria, then the circular arc is kept and the approximation algorithm is applied to the remaining segments.

Geometry Example

This example creates a LineString instance and uses Reduce() to simplify the instance:

DECLARE @g geometry;  
SET @g = geometry::STGeomFromText('LINESTRING(0 0, 0 1, 1 0, 2 1, 3 0, 4 1)', 0);  
SELECT @g.Reduce(.75).ToString();  

ShortestLineTo (Geometry)

ShortestLineTo()returns a LineStringinstance (which is the distance between the two geometry instances) with two points that represent the shortest distance between the two geometry instances.

Syntax

.ShortestLineTo ( other_instance )  

Arguments

other_instance Specifies the second geometry instance that the calling geometry instance is trying to determine the shortest distance to.

Return Types

CQL: geometry

Remarks

Returns a LineStringinstance with endpoints lying on the borders of the two non-intersecting geometry instances being compared.

The length of the LineStringreturned equals the shortest distance between the two geometry instances.

An empty LineStringinstance is returned when the two geometry instances intersect each other.

Geometry Example

This example returns the LineString instance connecting the two points, by finding the shortest distance between a CircularString instance and a LineString instance:

 DECLARE @g1 geometry = 'CIRCULARSTRING(0 0, 1 2.1082, 3 6.3246, 0 7, -3 6.3246, -1 2.1082, 0 0)';  
 DECLARE @g2 geometry = 'LINESTRING(-4 7, 7 10, 3 7)';  
 SELECT @g1.ShortestLineTo(@g2).ToString();

here
IsValidDetailed
MakeValid
Reduce
ShortestLineTo