Remote Joins: Create relationships across database and remote schemas #2392

tirumaraiselvan · 2019-06-18T13:27:04Z

Try it out

The latest preview is available at https://hge-ci-pull-2392.herokuapp.com/

Description

Remote Joins will enable joining data from your tables to remote schemas.

Remote joins will work similar to table relationships. You can define a relationship by giving:

a name for the relationship
a join configuration from table fields to remote schema fields.

Preview announcement: https://blog.hasura.io/remote-joins-a-graphql-api-to-join-database-and-other-data-sources/

Affected components

Server
Console
Docs
Build System
Tests

Related Issues

#1225
#1846
#2461

Limitations, known bugs & workarounds

Transactions will not work for concurrent execution.
Enum types are not supported for JOIN columns

…ma-deps add schema dependencies for remote relationship

…e-query delete_remote_relationship metadata query

Proxy endpoint for remote schemas

esseswann · 2020-05-26T13:47:26Z

@Tbaut thanks, we'll watch that issue

beerose

Looks good. Left some minor comments.

beerose · 2020-05-26T10:27:36Z

console/src/components/Common/utils/jsUtils.js

@@ -28,6 +28,17 @@ export const isNumber = value => {
  return typeof value === 'number';
 };

+export const isFloat = value => {
+  if (typeof value === 'number') {
+    return parseInt(value, 10) !== parseFloat(value, 10);


What about:

const isFloat = (n) { if (typeof value === 'number') return n % 1 !== 0; return false; }

We would avoid unnecessary parsing.

console/src/components/Services/ApiExplorer/OneGraphExplorer/OneGraphExplorer.js

beerose · 2020-05-26T21:07:10Z

console/src/components/Services/Data/DataState.js

@@ -117,6 +119,11 @@ const defaultModifyState = {
    colMappings: [{ column: '', refColumn: '' }],
    isToggled: false,
  },
+  remoteRelationships: {
+    remoteSchema: {},
+    relationships: [{ ...defaultRemoteRelationship }],


Suggested change

relationships: [{ ...defaultRemoteRelationship }],

relationships: [defaultRemoteRelationship],

beerose · 2020-05-26T21:08:51Z

console/src/components/Services/Data/TableCommon/TableReducer.js

+          error: true,
+        },
+      };
+    case INTROSPECTION_SUCCESSFUL:


Minor suggestion, but what about

Suggested change

case INTROSPECTION_SUCCESSFUL:

case INTROSPECTION_SUCCESS:

? Just to follow some naming conventions we have in other places.

beerose · 2020-05-26T21:09:42Z

console/src/components/Services/Data/TableCommon/TableReducer.js

+          loading: false,
+        },
+      };
+    case FETCHED_REMOTE_RELATIONSHIPS:


Suggested change

case FETCHED_REMOTE_RELATIONSHIPS:

case SET_REMOTE_RELATIONSHIPS:

beerose · 2020-05-26T21:17:17Z

.../src/components/Services/Data/TableRelationships/RemoteRelationships/RemoteRelationships.tsx

+
+type Props = {
+  relationships: RemoteRelationshipServer[];
+  reduxDispatch: any;


Why it's prefixed with redux?

Because there's another dispatch from useReducer floating around. This is just to differentiate the two.

beerose · 2020-05-26T21:17:32Z

.../src/components/Services/Data/TableRelationships/RemoteRelationships/RemoteRelationships.tsx

+      <div className={styles.add_mar_bottom}>
+        Relationships to remote schemas
+      </div>
+      <div>


Not needed.

beerose · 2020-05-27T09:51:51Z

console/src/components/Services/Data/TableRelationships/Actions.js

+    const successMsg = 'Successfully deleted remote relationship';
+    const errorMsg = 'Deleting remote relationship failed';
+
+    const customOnSuccess = () => {


For future: we could find a better way of doing this so that we don't initialize functions like this in many places. Possibly it could be handled (checking for undefined) inside of makeMigrationCall.

beerose · 2020-05-27T09:57:45Z

...rc/components/Services/Data/TableRelationships/RemoteRelationships/components/ArgElement.tsx

+  handleArgValueKindChange,
+  columns,
+}) => {
+  const style = {


Used only once. Can be inlined.

beerose · 2020-05-27T10:02:44Z

...mponents/Services/Data/TableRelationships/RemoteRelationships/components/RemoteRelEditor.tsx

+import Explorer from './Explorer';
+
+type Props = {
+  table: any; // use "Table" type after ST is merged


Suggested change

table: any; // use "Table" type after ST is merged

table: any; // TODO: use "Table" type after ST is merged

So we can grep by "TODO"

hasura-bot · 2020-05-27T11:41:50Z

Review app for commit 0f3dc53 deployed to Heroku: https://hge-ci-pull-2392.herokuapp.com
Docker image for server: hasura/graphql-engine:pull2392-0f3dc535

rikinsk

approve changelog

hasura-bot · 2020-05-27T12:46:46Z

Review app for commit b3bb3bf deployed to Heroku: https://hge-ci-pull-2392.herokuapp.com
Docker image for server: hasura/graphql-engine:pull2392-b3bb3bf3

hasura-bot · 2020-05-27T13:55:13Z

Review app for commit 13677f8 deployed to Heroku: https://hge-ci-pull-2392.herokuapp.com
Docker image for server: hasura/graphql-engine:pull2392-13677f80

Co-authored-by: Aleksandra Sikora <ola.zxcvbnm@gmail.com>

hasura-bot · 2020-05-27T14:23:07Z

Review app for commit b621ea9 deployed to Heroku: https://hge-ci-pull-2392.herokuapp.com
Docker image for server: hasura/graphql-engine:pull2392-b621ea90

not required

hasura-bot · 2020-05-27T15:03:02Z

Review app https://hge-ci-pull-2392.herokuapp.com is deleted

niklabh · 2020-05-27T15:11:06Z

Congratulations on this merge

…hasura#2392) add remote joins: Create relationships across database and remote schemas (hasura#2392) Co-authored-by: Aleksandra Sikora <ola.zxcvbnm@gmail.com> Co-authored-by: Chris Done <chrisdone@gmail.com> Co-authored-by: Chris Done <github@chrisdone.com> Co-authored-by: wawhal <rishichandra.wawhal@gmail.com> Co-authored-by: Aravind Shankar <aravind@hasura.io> Co-authored-by: Brandon Simmons <brandon.m.simmons@gmail.com> Co-authored-by: Rishichandra Wawhal <rishi@hasura.io> Co-authored-by: Brandon Simmons <brandon@hasura.io> Co-authored-by: nizar-m <19857260+nizar-m@users.noreply.github.com> Co-authored-by: Praveen Durairaju <praveend.web@gmail.com> Co-authored-by: rakeshkky <12475069+rakeshkky@users.noreply.github.com> Co-authored-by: Anon Ray <rayanon004@gmail.com> Co-authored-by: Shahidh K Muhammed <shahidh@hasura.io> Co-authored-by: soorajshankar <soorajshankar@users.noreply.github.com> Co-authored-by: Sooraj Sanker <sooraj@Soorajs-MacBook-Pro.local> Co-authored-by: Karthikeyan Chinnakonda <karthikeyan@hasura.io> Co-authored-by: Aleksandra Sikora <ola.zxcvbnm@gmail.com>

chrisdone and others added 30 commits June 16, 2019 15:33

Add TODO for dependency fields

c7e7ebe

Add InsertPath type

93e2777

WIP: Batch query generation

c020250

Remove dead code

9bd9fda

WIP: batch generation done

9e5afdf

Print remote results

41ad51b

Merge pull request #20 from tirumaraiselvan/remote-relationships-sche…

9746663

…ma-deps add schema dependencies for remote relationship

delete_remote_relationship metadata query

6e65a17

WIP

42c3152

Rename to RelFieldPath

bc7d6b9

Add insertPath

75de0da

Rename to ArrayIndex

ce3dc85

Make Batch type

3e76c23

WIP join results

7e5b54b

Print join results

4bceceb

Comment out

edd8b7c

add proxy endpoint for remote schemas

4ac7e77

Merge pull request #24 from tirumaraiselvan/remote-relationship-delet…

5a32899

…e-query delete_remote_relationship metadata query

Merge pull request #25 from tirumaraiselvan/proxy-endpoint

13e0073

Proxy endpoint for remote schemas

Add cardinality

9fa2ce4

Hoist batch inputs

41e8064

Setup for insertBatchResults

3c7ac16

Working basic relationship

5c5e330

WIP

de4f734

Fix syntax in remote_rel_variables

01f2d68

Handle lists

2e5cb23

Debug output

6b0a19c

Tweak basic array

65a0949

Changes on call

1fe8ec3

Merge branch 'remote-relationships-v2' into remote-execution

96025d9

codingkarthik added 2 commits May 26, 2020 20:44

Merge branch 'master' into remote-relationships-v2

e20652f

add runReusability because schemaR has MonadReusability context

83e24c0

oriollpz approved these changes May 27, 2020

View reviewed changes

beerose suggested changes May 27, 2020

View reviewed changes

codingkarthik and others added 5 commits May 27, 2020 16:40

delete from hdb_relationship and hdb_table in down migration

c623c2d

add docs for the remote relationships APIs

bbe3d6f

minor changes in the remote relationships API docs

8c3d726

make docs changes

8dfbb29

Merge branch 'master' into remote-relationships-v2

0f3dc53

update docs

dc7465b

tirumaraiselvan force-pushed the remote-relationships-v2 branch from 5715211 to dc7465b Compare May 27, 2020 12:08

add changelog

b3bb3bf

rikinsk approved these changes May 27, 2020

View reviewed changes

marionschleifer approved these changes May 27, 2020

View reviewed changes

beerose approved these changes May 27, 2020

View reviewed changes

remove the manual relationship hdb_table to hdb_remote_relationship

13677f8

remove console.log

b621ea9

Co-authored-by: Aleksandra Sikora <ola.zxcvbnm@gmail.com>

codingkarthik merged commit c0d2bc6 into hasura:master May 27, 2020

wawhal mentioned this pull request May 28, 2020

console: remote joins code review fixes #4920

Merged

9 tasks

tirumaraiselvan mentioned this pull request Jun 1, 2020

Support for table to action relationships #4900

Open

tirumaraiselvan mentioned this pull request Jun 23, 2020

support for relations with remote schemas #1225

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Remote Joins: Create relationships across database and remote schemas #2392

Remote Joins: Create relationships across database and remote schemas #2392

tirumaraiselvan commented Jun 18, 2019 •

edited

Loading

esseswann commented May 26, 2020

beerose left a comment

beerose May 26, 2020

beerose May 26, 2020

beerose May 26, 2020

beerose May 26, 2020

beerose May 26, 2020

wawhal May 28, 2020

beerose May 26, 2020

beerose May 27, 2020

beerose May 27, 2020

beerose May 27, 2020

hasura-bot commented May 27, 2020

rikinsk left a comment

hasura-bot commented May 27, 2020

hasura-bot commented May 27, 2020

hasura-bot commented May 27, 2020

hasura-bot commented May 27, 2020

niklabh commented May 27, 2020

	relationships: [{ ...defaultRemoteRelationship }],
	relationships: [defaultRemoteRelationship],

	case FETCHED_REMOTE_RELATIONSHIPS:
	case SET_REMOTE_RELATIONSHIPS:

	table: any; // use "Table" type after ST is merged
	table: any; // TODO: use "Table" type after ST is merged

Remote Joins: Create relationships across database and remote schemas #2392

Remote Joins: Create relationships across database and remote schemas #2392

Conversation

tirumaraiselvan commented Jun 18, 2019 • edited Loading

Try it out

Description

Affected components

Related Issues

Limitations, known bugs & workarounds

esseswann commented May 26, 2020

beerose 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hasura-bot commented May 27, 2020

rikinsk left a comment

Choose a reason for hiding this comment

hasura-bot commented May 27, 2020

hasura-bot commented May 27, 2020

hasura-bot commented May 27, 2020

hasura-bot commented May 27, 2020

niklabh commented May 27, 2020

tirumaraiselvan commented Jun 18, 2019 •

edited

Loading