Skip to content

Commit

Permalink
[Docs][Voyager] Added a known-issue in PG and some missing entries fr…
Browse files Browse the repository at this point in the history
…om PG compatibility doc (#23906)
  • Loading branch information
priyanshi-yb authored Sep 13, 2024
1 parent 9baa0be commit a2a74d0
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 37 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -180,6 +180,7 @@ The following PostgreSQL features are not supported in YugabyteDB:
| Table inheritance | [5956](https://github.com/yugabyte/yugabyte-db/issues/5956)|
| Exclusion constraints | [3944](https://github.com/yugabyte/yugabyte-db/issues/3944)|
| Deferrable constraints | [1709](https://github.com/yugabyte/yugabyte-db/issues/1709)|
| Constraint Triggers|[4700](https://github.com/yugabyte/yugabyte-db/issues/4700)|
| GiST indexes | [1337](https://github.com/yugabyte/yugabyte-db/issues/1337)|
| Events (Listen/Notify) | [1872](https://github.com/yugabyte/yugabyte-db/issues/1872)|
| XML Functions | [1043](https://github.com/yugabyte/yugabyte-db/issues/1043)|
Expand All @@ -197,3 +198,7 @@ The following PostgreSQL features are not supported in YugabyteDB:
| transaction ids (xid) <br/> YugabyteDB uses [Hybrid logical clocks](../../../architecture/transactions/transactions-overview/#hybrid-logical-clocks) instead of transaction ids. | [15638](https://github.com/yugabyte/yugabyte-db/issues/15638)|
| DDL operations within transaction| [1404](https://github.com/yugabyte/yugabyte-db/issues/1404)|
| Some ALTER TABLE variants| [1124](https://github.com/yugabyte/yugabyte-db/issues/1124)|
| UNLOGGED table | [1129](https://github.com/yugabyte/yugabyte-db/issues/1129) |
| Indexes on complex datatypes such as INET, CITEXT, JSONB, ARRAYs, and so on.| [9698](https://github.com/yugabyte/yugabyte-db/issues/9698), [23829](https://github.com/yugabyte/yugabyte-db/issues/23829), [17017](https://github.com/yugabyte/yugabyte-db/issues/17017) |
| %TYPE syntax in Functions/Procedures/Triggers|[23619](https://github.com/yugabyte/yugabyte-db/issues/23619)|
| Storage parameters on indexes or constraints|[23467](https://github.com/yugabyte/yugabyte-db/issues/23467)|
75 changes: 38 additions & 37 deletions docs/content/preview/yugabyte-voyager/known-issues/postgresql.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ Review limitations and implement suggested workarounds to successfully migrate d
- [Adding primary key to a partitioned table results in an error](#adding-primary-key-to-a-partitioned-table-results-in-an-error)
- [Index creation on partitions fail for some YugabyteDB builds](#index-creation-on-partitions-fail-for-some-yugabytedb-builds)
- [Creation of certain views in the rule.sql file](#creation-of-certain-views-in-the-rule-sql-file)
- [Indexes on INET type are not supported](#indexes-on-inet-type-are-not-supported)
- [Create or alter conversion is not supported](#create-or-alter-conversion-is-not-supported)
- [GENERATED ALWAYS AS STORED type column is not supported](#generated-always-as-stored-type-column-is-not-supported)
- [Unsupported ALTER TABLE DDL variants in source schema](#unsupported-alter-table-ddl-variants-in-source-schema)
Expand All @@ -38,6 +37,7 @@ Review limitations and implement suggested workarounds to successfully migrate d
- [GIN indexes on multiple columns are not supported](#gin-indexes-on-multiple-columns-are-not-supported)
- [Policies on users in source require manual user creation](#policies-on-users-in-source-require-manual-user-creation)
- [VIEW WITH CHECK OPTION is not supported](#view-with-check-option-is-not-supported)
- [UNLOGGED table is not supported](#unlogged-table-is-not-supported)

### Adding primary key to a partitioned table results in an error

Expand Down Expand Up @@ -156,40 +156,6 @@ CREATE OR REPLACE VIEW public.v1 AS
GROUP BY foo.n1;
```

---

### Indexes on INET type are not supported

**GitHub**: [Issue #17017](https://github.com/yugabyte/yb-voyager/issues/17017)

**Description**: If there is an index on a column of the INET type, it errors out during import.

**Workaround**: Modify the column to a TEXT type.

**Example**

An example schema on the source database is as follows:

```sql
create table test( id int primary key, f1 inet);
create index test_index on test(f1);
```

The import schema error is as follows:

```sql
INDEXES_table.sql: CREATE INDEX test_index ON public.test USING btree (f1);
ERROR: INDEX on column of type 'INET' not yet supported (SQLSTATE 0A000)
```

Suggested workaround is to change the INET column to TEXT for the index creation to succeed as follows:

```sql
create table test( id int primary key, f1 text);
```

---

### Create or alter conversion is not supported

**GitHub**: [Issue #10866](https://github.com/yugabyte/yugabyte-db/issues/10866)
Expand Down Expand Up @@ -590,9 +556,9 @@ CREATE INDEX gist_idx ON public.ts_query_table USING gist (query);

### Indexes on some complex data types are not supported

**GitHub**: [Issue #9698](https://github.com/yugabyte/yugabyte-db/issues/9698), [Issue #23829](https://github.com/yugabyte/yugabyte-db/issues/23829)
**GitHub**: [Issue #9698](https://github.com/yugabyte/yugabyte-db/issues/9698), [Issue #23829](https://github.com/yugabyte/yugabyte-db/issues/23829), [Issue #17017](https://github.com/yugabyte/yugabyte-db/issues/17017)

**Description**: If you have indexes on some complex types such as TSQUERY, TSVECTOR, JSONB, UDTs, citext, and so on, those will error out in import schema phase with the following error:
**Description**: If you have indexes on some complex types such as TSQUERY, TSVECTOR, JSONB, ARRAYs, INET, UDTs, citext, and so on, those will error out in import schema phase with the following error:

```output
ERROR: INDEX on column of type '<TYPE_NAME>' not yet supported
Expand Down Expand Up @@ -911,3 +877,38 @@ CREATE TRIGGER trigger_modify_employee_12000
```

---


### UNLOGGED table is not supported

**GitHub**: [Issue #1129](https://github.com/yugabyte/yugabyte-db/issues/1129)

**Description**: If there are UNLOGGED tables in the source schema, they will error out during the import schema with the following error as it is not supported in target YugabyteDB.

```output
ERROR: UNLOGGED database object not supported yet
```

**Workaround**: Convert it to a LOGGED table.

**Example**

An example schema on the source database is as follows:

```sql
CREATE UNLOGGED TABLE tbl_unlogged (
id int,
val text
);
```

Suggested change to the schema is as follows:

```sql
CREATE TABLE tbl_unlogged (
id int,
val text
);
```

---

0 comments on commit a2a74d0

Please sign in to comment.