INET data type #2439

lnhsingh · 2018-01-29T23:05:17Z

Closes #2016.

cockroach-teamcity · 2018-01-29T23:05:22Z

This change is

cockroach-teamcity · 2018-01-29T23:06:49Z

http://cockroach-docs-review.s3-website-us-east-1.amazonaws.com/a296b4a3a0acf47275ec1d0f8be8e402d21da82d/

cockroach-teamcity · 2018-01-31T23:27:21Z

http://cockroach-docs-review.s3-website-us-east-1.amazonaws.com/bbeea68f67c318c08f10ff254e6b52e27c2bb41e/

cockroach-teamcity · 2018-01-31T23:40:03Z

http://cockroach-docs-review.s3-website-us-east-1.amazonaws.com/a8fc60ca451d90583ab383484a4093033fbf2463/

cockroach-teamcity · 2018-02-01T16:18:29Z

http://cockroach-docs-review.s3-website-us-east-1.amazonaws.com/d255b519905bc928e584cabc84889f622b8a68e6/

cockroach-teamcity · 2018-02-05T16:37:38Z

http://cockroach-docs-review.s3-website-us-east-1.amazonaws.com/1fa7369811d3258419f95178c33d3a44ec1ec737/

lnhsingh · 2018-02-05T16:38:16Z

v2.0/inet.md

+<div id="toc"></div>
+
+## Syntax
+


@nvanbenschoten - how do you determine if a data type can be an interpreted literal, an annotated string literal, or coerced to type INET? Do any of these apply to INET?

All three of them apply to INET! I think the easiest way to determine this is to try it out:

CREATE TABLE t (a INET); INSERT INTO t VALUES (INET '190.0.0.0'), ('190.0.0.0':::INET), ('190.0.0.0');

EDIT: the first one doesn't actually look like it works.. I'll have to fix that during my QA process (cockroachdb/cockroach#22390). I think it's safe to assume that all three will work by the time this is published.

lnhsingh · 2018-02-05T16:39:04Z

v2.0/inet.md

+Format | Description
+-------|-------------
+IPv4 | Standard [RFC791](https://tools.ietf.org/html/rfc791)-specified format of 4 octets expressed individually in decimal numbers and separated by periods. Optionally, the address can be followed by a subnet mask.<br><br> Examples: `'190.0.0.0'`, `'190.0.0.0/24'`
+IPv4-mapped IPv6 | IPv6 address mapped to a IPv4 address. <br><br>Example: `'::ffff:192.168.0.1/24'`


@nvanbenschoten - do you think this should this be called out as its own format? Or should it be included as an option in the IPv6 description?

I'd include it as an option in the IPv6 description.

lnhsingh · 2018-02-05T16:39:48Z

v2.0/inet.md

+--------------------------------------+--------------------------+---------------------------+
+~~~
+
+## Supported Casting & Conversion


@nvanbenschoten - similar to above, how do you determine what INET can be cast to?

I think the easiest way is to look at the code: https://github.com/cockroachdb/cockroach/blob/94a2182a5e00fc0963c0f20c1dc278b12a9df7d2/pkg/sql/sem/tree/expr.go#L1254.

inetCastTypes is a list of all the types that INET can be cast to. It looks like only STRINGs can be cast to INET. I'll be auditing all of this as part of my QA process.

nvanbenschoten · 2018-02-05T19:44:48Z

_includes/sidebar-data-v2.0.json

@@ -723,6 +723,12 @@
              "/${VERSION}/data-types.html"
            ]
          },
+          {
+            "title": "<code>INET</code>",


Is there a method to the sorting of this list? It looks arbitrary to me.

Good catch - I'll update to be alphabetical.

nvanbenschoten · 2018-02-05T19:45:46Z

v2.0/data-types.md

@@ -10,6 +10,7 @@ CockroachDB supports the following data types. Click a type for more details.

 Type | Description | Example
 -----|-------------|--------
+[`INET`](inet.html) | A IPv4 or IPv6 address. | `192.168.0.1`


Do we want a <span class="version-tag">New in v2.0:</span> tag? Are we doing those yet?

Are we going to remove the New in v1.1 tags from the 2.0 docs?

I've been leaving the 1.1 flags in the 2.0 docs. I think (if we remove them) we'll do it all at once.

nvanbenschoten · 2018-02-05T19:47:21Z

v2.0/sql-constants.md

@@ -219,7 +219,7 @@ interpreted literal. These are special cases of

 For more information about the allowable format of interpreted
 literals, refer to the "Syntax" section of the respective data types:
-[`DATE`](date.html#syntax), [`INTERVAL`](interval.html#syntax),
+[`DATE`](date.html#syntax), [`INTERVAL`](interval.html#syntax), [`TIME`](time.html#syntax),
 [`TIMESTAMP`/`TIMESTAMPTZ`](timestamp.html#syntax).


Should we add INET here?

nvanbenschoten · 2018-02-05T19:51:55Z

v2.0/inet.md

+<div id="toc"></div>
+
+## Syntax
+


All three of them apply to INET! I think the easiest way to determine this is to try it out:

CREATE TABLE t (a INET); INSERT INTO t VALUES (INET '190.0.0.0'), ('190.0.0.0':::INET), ('190.0.0.0');

nvanbenschoten · 2018-02-05T19:53:51Z

v2.0/inet.md

+Format | Description
+-------|-------------
+IPv4 | Standard [RFC791](https://tools.ietf.org/html/rfc791)-specified format of 4 octets expressed individually in decimal numbers and separated by periods. Optionally, the address can be followed by a subnet mask.<br><br> Examples: `'190.0.0.0'`, `'190.0.0.0/24'`
+IPv4-mapped IPv6 | IPv6 address mapped to a IPv4 address. <br><br>Example: `'::ffff:192.168.0.1/24'`


I'd include it as an option in the IPv6 description.

nvanbenschoten · 2018-02-05T19:54:21Z

v2.0/inet.md

+IPv4-mapped IPv6 | IPv6 address mapped to a IPv4 address. <br><br>Example: `'::ffff:192.168.0.1/24'`
+IPv6 | Standard [RFC8200](https://tools.ietf.org/html/rfc8200)-specified format of 8 colon-separated groups of 4 hexadecimal digits. Optionally, the address can be followed by a subnet mask.<br><br> Example: `'2001:4f8:3:ba:2e0:81ff:fe22:d1f1'`, `'2001:4f8:3:ba:2e0:81ff:fe22:d1f1/120'`
+
+{{site.data.alerts.callout_info}}IPv4 addresses will sort before IPv6 addresses, including IPv4 addresses mapped to IPv6 addresses.{{site.data.alerts.end}}


Good idea to include this callout.

nvanbenschoten · 2018-02-05T20:01:14Z

v2.0/inet.md

+<div id="toc"></div>
+
+## Syntax
+


EDIT: the first one doesn't actually look like it works.. I'll have to fix that during my QA process (cockroachdb/cockroach#22390). I think it's safe to assume that all three will work by the time this is published.

nvanbenschoten · 2018-02-05T20:13:32Z

v2.0/inet.md

+--------------------------------------+--------------------------+---------------------------+
+~~~
+
+## Supported Casting & Conversion


I think the easiest way is to look at the code: https://github.com/cockroachdb/cockroach/blob/94a2182a5e00fc0963c0f20c1dc278b12a9df7d2/pkg/sql/sem/tree/expr.go#L1254.

inetCastTypes is a list of all the types that INET can be cast to. It looks like only STRINGs can be cast to INET. I'll be auditing all of this as part of my QA process.

lnhsingh · 2018-02-05T21:40:41Z

Thanks for the review @nvanbenschoten!

cockroach-teamcity · 2018-02-05T21:42:34Z

http://cockroach-docs-review.s3-website-us-east-1.amazonaws.com/2c52f8d30de8599aefee020a1f06d1758d3826dd/

INET first draft add INET to sidebar syntax minor edits

cockroach-teamcity · 2018-02-05T21:48:35Z

http://cockroach-docs-review.s3-website-us-east-1.amazonaws.com/6cc13ba4add8373dcd73acdec26f8835ee35ab4a/

jseldess

This is great, @lhirata! LGTM, with a few minor comments.

jseldess · 2018-02-06T03:08:44Z

v2.0/inet.md

+Format | Description
+-------|-------------
+IPv4 | Standard [RFC791](https://tools.ietf.org/html/rfc791)-specified format of 4 octets expressed individually in decimal numbers and separated by periods. Optionally, the address can be followed by a subnet mask.<br><br> Examples: `'190.0.0.0'`, `'190.0.0.0/24'`
+IPv6 | Standard [RFC8200](https://tools.ietf.org/html/rfc8200)-specified format of 8 colon-separated groups of 4 hexadecimal digits. An IPv6 address can be mapped to an IPv4 address. Optionally, the address can be followed by a subnet mask.<br><br> Example: `'2001:4f8:3:ba:2e0:81ff:fe22:d1f1'`, `'2001:4f8:3:ba:2e0:81ff:fe22:d1f1/120'`, `'::ffff:192.168.0.1/24'`


Example: > Examples:

nit: You also don't need a space after a <br>.

jseldess · 2018-02-06T03:10:12Z

v2.0/inet.md

+> INSERT INTO computers
+  VALUES
+    ('192.168.0.1', 'info@cockroachlabs.com', '2018-01-31'),
+    ('192.168.0.2/10', 'lauren@cockroachlabs.com', '2018-01-31');


At end of line, change ; to ,; otherwise, this statement fails.

jseldess · 2018-02-06T03:11:49Z

v2.0/inet.md

+-----|--------
+`STRING` | Converts to format `'Address/subnet'`.
+
+## See Also


Please make these a bulleted list.

cockroach-teamcity · 2018-02-06T16:32:23Z

http://cockroach-docs-review.s3-website-us-east-1.amazonaws.com/08500c5a418ffe60bae322946d2296a28ef4c697/

nvanbenschoten · 2018-02-06T16:39:54Z

LGTM!

cockroach-teamcity · 2018-02-06T17:41:36Z

http://cockroach-docs-review.s3-website-us-east-1.amazonaws.com/dd8f93b2d3fa3c0073ce935a7b41ddef8be58fb0/

lnhsingh added the in progress label Jan 29, 2018

lnhsingh changed the title ~~inet datatype docs - DRAFT~~ inet datatype docs Feb 5, 2018

lnhsingh requested a review from nvanbenschoten February 5, 2018 16:36

lnhsingh commented Feb 5, 2018

View reviewed changes

nvanbenschoten reviewed Feb 5, 2018

View reviewed changes

Lauren added 2 commits February 5, 2018 16:46

inet datatype docs - DRAFT

6c69a10

INET first draft add INET to sidebar syntax minor edits

edits based on feedback, reorder side nav

6cc13ba

lnhsingh force-pushed the inet-docs branch from 2c52f8d to 6cc13ba Compare February 5, 2018 21:46

lnhsingh changed the title ~~inet datatype docs~~ INET data type Feb 5, 2018

lnhsingh requested review from Amruta-Ranade and jseldess February 5, 2018 21:53

jseldess approved these changes Feb 6, 2018

View reviewed changes

Lauren added 2 commits February 6, 2018 11:30

Minor edits based on feedback

934904f

Merge branch 'master' into inet-docs

08500c5

Merge branch 'master' into inet-docs

dd8f93b

lnhsingh merged commit 5db7f05 into master Feb 6, 2018

lnhsingh removed the in progress label Feb 6, 2018

lnhsingh deleted the inet-docs branch February 6, 2018 18:15

INET data type #2439

INET data type #2439

Conversation

lnhsingh commented Jan 29, 2018

cockroach-teamcity commented Jan 29, 2018

cockroach-teamcity commented Jan 29, 2018

cockroach-teamcity commented Jan 31, 2018

cockroach-teamcity commented Jan 31, 2018

cockroach-teamcity commented Feb 1, 2018

cockroach-teamcity commented Feb 5, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lnhsingh Feb 6, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lnhsingh commented Feb 5, 2018

cockroach-teamcity commented Feb 5, 2018

cockroach-teamcity commented Feb 5, 2018

jseldess left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cockroach-teamcity commented Feb 6, 2018

nvanbenschoten commented Feb 6, 2018

cockroach-teamcity commented Feb 6, 2018

lnhsingh Feb 6, 2018 •

edited

Loading