Uploaded image for project: 'Atlas'
  1. Atlas
  2. ATLAS-1618

Export API: Provide Option to Restrict Scope of Export Operation

    Details

    • Type: Improvement
    • Status: Resolved
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: 0.8-incubating
    • Fix Version/s: 0.8-incubating
    • Component/s: atlas-core
    • Labels:

      Description

      Background
      Existing Export API navigates the graph structure and get all the connected entities as part of export. The API is geared toward exporting of entire database and not parts of the database.

      Scenario
      It is possible to specify Export of 1 table. The resulting ZIP however, contains the entire database and all other tables in the database to be exported. Alternately stated, it is not possible to export subset of the graph of which the entity is part of.

      This behavior impacts Import, as more entities get imported than needed.

      Resolution
      While the existing approach is useful, the user should be allowed to specify the scope of the export operation.

      The existing ExportRequest.options could potentially have an option that indicate the scope.

      options
      FETCH = FULL | CONNECTED

      FETCH = FULL All entities directly and indirectly entities are fetched.
      FETCH = CONNECTED All entities directly connected are fetched.

      Examples:

      options.FULL
      {
        "itemsToExport": [
            {
                "typeName": "DB_v1",
                "uniqueAttributes": {
                    "name": "Sales"
                }
          }
        ],
        "options": { 
              "FETCH": "FULL"
          }
      }
      
      options.CONNECTED
      {
        "itemsToExport": [
            {
                "typeName": "Table_v1",
                "uniqueAttributes": {
                    "name": "customer_view"
                }
          }
        ],
        "options": { 
              "FETCH": "CONNECTED"
          }
      }
      
      1. ATLAS-1618.2.patch
        40 kB
        Ashutosh Mestry

        Issue Links

          Activity

          There are no comments yet on this issue.

            People

            • Assignee:
              ashutoshm Ashutosh Mestry
              Reporter:
              ashutoshm Ashutosh Mestry
              Request participants:
              None
            • Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

              • Due:
                Created:
                Updated:
                Resolved:

                Time Tracking

                Estimated:
                Original Estimate - 96h
                96h
                Remaining:
                Time Spent - 48h Remaining Estimate - 48h
                48h
                Logged:
                Time Spent - 48h Remaining Estimate - 48h
                48h