Drive Service¶

Cloud document management and file sharing platforms

Overview¶

The DriveService entity represents cloud-based document management and file sharing platforms like Google Drive, OneDrive, SharePoint, and Dropbox. Drive Services manage collaborative documents, spreadsheets, presentations, and files with sharing, versioning, and real-time collaboration features.

Hierarchy:

graph TD
    DS[Drive Service] --> DIR[Directory/Folder]
    DIR --> FILE[Files]
    DIR --> SHEET[Spreadsheet]
    DIR --> DOC[Document]
    DIR --> PRES[Presentation]
    SHEET --> WS[Worksheet]

    style DS fill:#667eea,color:#fff,stroke:#4c51bf,stroke-width:3px
    style DIR fill:#4facfe,color:#fff
    style FILE fill:#00f2fe,color:#333
    style SHEET fill:#00f2fe,color:#333
    style DOC fill:#00f2fe,color:#333
    style PRES fill:#00f2fe,color:#333
    style WS fill:#e0f2fe,color:#333

Supported Drive Platforms:

Google Drive - Google Workspace cloud file storage and collaboration
Google Shared Drives - Team drives with shared ownership
OneDrive - Microsoft OneDrive personal and business cloud storage
OneDrive for Business - Enterprise OneDrive with SharePoint integration
SharePoint - Microsoft SharePoint document libraries and sites
Dropbox - Dropbox cloud file storage and sharing
Dropbox Business - Enterprise Dropbox with team folders
Box - Box cloud content management
iCloud Drive - Apple iCloud file storage

Drive-Specific Features:

Real-time Collaboration: Multiple users editing simultaneously
Version History: Track changes and restore previous versions
Sharing & Permissions: Fine-grained access control
Comments & Discussions: In-document collaboration
Native File Formats: Google Docs, Sheets, Slides; Office 365 formats
File Conversion: Convert between formats
Offline Access: Sync for offline work
Third-party Integrations: Apps and extensions

Relationships¶

DriveService has comprehensive relationships with entities across the metadata platform:

graph TD
    subgraph Service Layer
        DS[DriveService<br/>google_drive_marketing]
    end

    subgraph Folders & Files
        DS --> DIR1[Directory:<br/>Campaign Assets]
        DS --> DIR2[Directory:<br/>Reports]
        DS --> DIR3[Directory:<br/>Data Analysis]

        DIR1 --> FILE1[Presentation:<br/>Q4_Campaign.pptx]
        DIR1 --> FILE2[Document:<br/>Strategy.docx]

        DIR2 --> SHEET1[Spreadsheet:<br/>Monthly_Metrics.xlsx]
        SHEET1 --> WS1[Worksheet: Summary]
        SHEET1 --> WS2[Worksheet: Details]

        DIR3 --> SHEET2[Spreadsheet:<br/>Sales_Data.gsheet]
        SHEET2 --> WS3[Worksheet: Raw Data]
        SHEET2 --> WS4[Worksheet: Pivot]
    end

    subgraph Ownership
        DS -.->|owned by| TEAM[Team<br/>Marketing]
        DS -.->|owned by| USER[User<br/>drive.admin]
    end

    subgraph Governance
        DS -.->|in domain| DOM[Domain<br/>Marketing]
        DS -.->|tagged| TAG1[Tag<br/>Tier.Gold]
        DS -.->|tagged| TAG2[Tag<br/>Sensitive]
    end

    subgraph Data Flow
        SHEET2 -.->|consumed by| PIPE[Pipeline<br/>sales_etl]
        SHEET2 -.->|loaded to| TABLE[Table<br/>sales_data]
        FILE1 -.->|referenced in| DASH[Dashboard<br/>Campaign Performance]
    end

    style DS fill:#667eea,color:#fff,stroke:#4c51bf,stroke-width:3px
    style DIR1 fill:#4facfe,color:#fff
    style DIR2 fill:#4facfe,color:#fff
    style DIR3 fill:#4facfe,color:#fff
    style FILE1 fill:#00f2fe,color:#333
    style FILE2 fill:#00f2fe,color:#333
    style SHEET1 fill:#00f2fe,color:#333
    style SHEET2 fill:#00f2fe,color:#333
    style WS1 fill:#e0f2fe,color:#333
    style WS2 fill:#e0f2fe,color:#333
    style WS3 fill:#e0f2fe,color:#333
    style WS4 fill:#e0f2fe,color:#333
    style TEAM fill:#43e97b,color:#333
    style USER fill:#43e97b,color:#333
    style DOM fill:#fa709a,color:#fff
    style TAG1 fill:#f093fb,color:#333
    style TAG2 fill:#f093fb,color:#333
    style PIPE fill:#667eea,color:#fff
    style TABLE fill:#764ba2,color:#fff
    style DASH fill:#ffd700,color:#333

Schema Specifications¶

View the complete DriveService schema in your preferred format:

JSON SchemaRDF (Turtle)JSON-LD Context

Complete JSON Schema Definition

{
  "$id": "https://open-metadata.org/schema/entity/services/driveService.json",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DriveService",
  "description": "Drive service for cloud document management platforms.",
  "type": "object",

  "properties": {
    "id": {
      "description": "Unique identifier",
      "$ref": "../../type/basic.json#/definitions/uuid"
    },
    "name": {
      "description": "Service name",
      "$ref": "../../type/basic.json#/definitions/entityName"
    },
    "serviceType": {
      "description": "Type of drive service",
      "type": "string",
      "enum": [
        "GoogleDrive",
        "GoogleSharedDrive",
        "OneDrive",
        "OneDriveForBusiness",
        "SharePoint",
        "Dropbox",
        "DropboxBusiness",
        "Box",
        "iCloudDrive"
      ]
    },
    "description": {
      "description": "Service description",
      "$ref": "../../type/basic.json#/definitions/markdown"
    },
    "connection": {
      "description": "Connection configuration",
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "enum": ["GoogleDrive", "OneDrive", "SharePoint", "Dropbox", "Box"]
        },
        "credentials": {
          "description": "OAuth2 or API credentials",
          "type": "object"
        },
        "organizationId": {
          "description": "Organization or tenant ID",
          "type": "string"
        },
        "rootPath": {
          "description": "Root folder path to index",
          "type": "string"
        }
      }
    },
    "directories": {
      "description": "Top-level directories in this drive",
      "type": "array",
      "items": {
        "$ref": "../../type/entityReference.json"
      }
    },
    "owner": {
      "description": "Owner of this service",
      "$ref": "../../type/entityReference.json"
    },
    "domain": {
      "description": "Domain this service belongs to",
      "$ref": "../../type/entityReference.json"
    },
    "tags": {
      "description": "Tags for this service",
      "type": "array",
      "items": {
        "$ref": "../../type/tagLabel.json"
      }
    }
  },
  "required": ["id", "name", "serviceType"],
  "additionalProperties": false
}

RDF/OWL Ontology Representation

@prefix om: <https://open-metadata.org/schema/> .
@prefix om-drive: <https://open-metadata.org/schema/entity/services/> .
@prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix owl: <http://www.w3.org/2002/07/owl#> .
@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .

# Drive Service Class
om-drive:DriveService a owl:Class ;
    rdfs:label "Drive Service" ;
    rdfs:comment "Cloud document management and file sharing platform" ;
    rdfs:subClassOf om:Service ;
    rdfs:isDefinedBy om: .

# Properties
om-drive:serviceType a owl:DatatypeProperty ;
    rdfs:label "service type" ;
    rdfs:comment "Type of drive platform (GoogleDrive, OneDrive, etc.)" ;
    rdfs:domain om-drive:DriveService ;
    rdfs:range xsd:string .

om-drive:hasDirectory a owl:ObjectProperty ;
    rdfs:label "has directory" ;
    rdfs:comment "Directories in this drive service" ;
    rdfs:domain om-drive:DriveService ;
    rdfs:range om-drive:Directory .

om-drive:hasFile a owl:ObjectProperty ;
    rdfs:label "has file" ;
    rdfs:comment "Files in directories" ;
    rdfs:domain om-drive:Directory ;
    rdfs:range om-drive:File .

om-drive:hasWorksheet a owl:ObjectProperty ;
    rdfs:label "has worksheet" ;
    rdfs:comment "Worksheets in a spreadsheet" ;
    rdfs:domain om-drive:Spreadsheet ;
    rdfs:range om-drive:Worksheet .

# Directory Class
om-drive:Directory a owl:Class ;
    rdfs:label "Directory" ;
    rdfs:comment "Folder or directory in drive service" ;
    rdfs:isDefinedBy om: .

# File Classes
om-drive:File a owl:Class ;
    rdfs:label "File" ;
    rdfs:comment "File in drive service" ;
    rdfs:isDefinedBy om: .

om-drive:Spreadsheet a owl:Class ;
    rdfs:label "Spreadsheet" ;
    rdfs:comment "Spreadsheet file (Excel, Google Sheets)" ;
    rdfs:subClassOf om-drive:File ;
    rdfs:isDefinedBy om: .

om-drive:Worksheet a owl:Class ;
    rdfs:label "Worksheet" ;
    rdfs:comment "Individual sheet/tab in a spreadsheet" ;
    rdfs:isDefinedBy om: .

om-drive:Document a owl:Class ;
    rdfs:label "Document" ;
    rdfs:comment "Document file (Word, Google Docs, PDF)" ;
    rdfs:subClassOf om-drive:File ;
    rdfs:isDefinedBy om: .

om-drive:Presentation a owl:Class ;
    rdfs:label "Presentation" ;
    rdfs:comment "Presentation file (PowerPoint, Google Slides)" ;
    rdfs:subClassOf om-drive:File ;
    rdfs:isDefinedBy om: .

JSON-LD Context for Semantic Interoperability

{
  "@context": {
    "@vocab": "https://open-metadata.org/schema/entity/services/",
    "om": "https://open-metadata.org/schema/",
    "xsd": "http://www.w3.org/2001/XMLSchema#",

    "DriveService": {
      "@id": "om:DriveService",
      "@type": "@id"
    },
    "serviceType": {
      "@id": "om:serviceType",
      "@type": "xsd:string"
    },
    "directories": {
      "@id": "om:hasDirectory",
      "@type": "@id",
      "@container": "@set"
    },
    "Directory": {
      "@id": "om:Directory",
      "@type": "@id"
    },
    "files": {
      "@id": "om:hasFile",
      "@type": "@id",
      "@container": "@set"
    },
    "Spreadsheet": {
      "@id": "om:Spreadsheet",
      "@type": "@id"
    },
    "worksheets": {
      "@id": "om:hasWorksheet",
      "@type": "@id",
      "@container": "@set"
    },
    "Worksheet": {
      "@id": "om:Worksheet",
      "@type": "@id"
    }
  }
}

Drive Service Types¶

Google Drive¶

Configuration:

serviceType: GoogleDrive
connection:
  type: GoogleDrive
  credentials:
    clientId: xxx
    clientSecret: xxx
    refreshToken: xxx
  organizationId: example.com
  rootPath: /Marketing

Features: - Google Docs, Sheets, Slides native formats - Shared Drives for team collaboration - Real-time collaborative editing - Version history and restore - Google Workspace integration

OneDrive / SharePoint¶

Configuration:

serviceType: OneDriveForBusiness
connection:
  type: OneDrive
  credentials:
    tenantId: xxx
    clientId: xxx
    clientSecret: xxx
  organizationId: contoso.sharepoint.com
  rootPath: /sites/Marketing

Features: - Office 365 integration - SharePoint document libraries - Teams integration - Co-authoring in Office apps - Compliance and retention policies

Dropbox¶

Configuration:

serviceType: DropboxBusiness
connection:
  type: Dropbox
  credentials:
    accessToken: xxx
  organizationId: example-team
  rootPath: /Marketing

Features: - File sync and sharing - Paper documents - Team folders - File requests - Smart Sync

File Types in Drive Services¶

Spreadsheets¶

Spreadsheet files with multiple worksheets:

Formats: - Google Sheets (.gsheet) - Microsoft Excel (.xlsx, .xls) - LibreOffice Calc (.ods) - CSV files (.csv)

Hierarchy:

Spreadsheet
  └── Worksheet (Sheet1, Sheet2, etc.)
        └── Columns & Rows
              └── Cells

Metadata: - Worksheet names and count - Column headers - Data types - Formulas and calculations - Named ranges - Pivot tables

Documents¶

Text documents and PDFs:

Formats: - Google Docs (.gdoc) - Microsoft Word (.docx, .doc) - PDF (.pdf) - Plain Text (.txt, .md)

Presentations¶

Slide decks:

Formats: - Google Slides (.gslide) - Microsoft PowerPoint (.pptx, .ppt) - PDF presentations

Other Files¶

Images (.jpg, .png, .gif)
Videos (.mp4, .mov)
Audio (.mp3, .wav)
Archives (.zip, .tar.gz)

Use Cases¶

Business Analytics¶

Track spreadsheets used for analysis:

{
  "service": "google-drive-finance",
  "directory": "Financial Analysis",
  "spreadsheet": "Q4_Revenue_Analysis.gsheet",
  "worksheets": [
    {"name": "Raw Data", "columns": 25, "rows": 5000},
    {"name": "Monthly Summary", "columns": 12, "rows": 12},
    {"name": "Charts", "columns": 5, "rows": 100}
  ],
  "lineage": [
    {"source": "salesforce.opportunities", "type": "imports_from"},
    {"target": "tableau.revenue_dashboard", "type": "used_by"}
  ]
}

Document Management¶

Track important documents:

{
  "service": "sharepoint-legal",
  "directory": "Contracts/2024",
  "documents": [
    {
      "name": "Vendor_Agreement_ACME.docx",
      "type": "Contract",
      "tags": ["Legal", "Confidential"],
      "owner": "legal-team",
      "lastModified": "2024-11-20"
    }
  ]
}

Collaborative Data Prep¶

Track shared data files:

{
  "service": "dropbox-data-team",
  "directory": "Data Exports",
  "files": [
    {
      "name": "customer_export_2024.csv",
      "size": "150MB",
      "format": "CSV",
      "schema": {
        "columns": ["id", "name", "email", "created_date"],
        "delimiter": ",",
        "encoding": "UTF-8"
      },
      "lineage": {
        "source": "crm.customers",
        "target": "pipeline.customer_enrichment"
      }
    }
  ]
}

Custom Properties¶

This entity supports custom properties through the extension field. Common custom properties include:

Data Classification: Sensitivity level
Cost Center: Billing allocation
Retention Period: Data retention requirements
Application Owner: Owning application/team

See Custom Properties for details on defining and using custom properties.

API Operations¶

Create Drive Service¶

POST /api/v1/services/driveServices
Content-Type: application/json

{
  "name": "google_drive_marketing",
  "serviceType": "GoogleDrive",
  "connection": {
    "type": "GoogleDrive",
    "credentials": {...},
    "organizationId": "example.com"
  }
}

List Directories¶

GET /api/v1/services/driveServices/{id}/directories

Get Spreadsheet Metadata¶

GET /api/v1/driveFiles/{id}/worksheets

Directory - Folders and directories in drive services
Spreadsheet - Spreadsheet files (Excel, Google Sheets)
Worksheet - Individual worksheets/tabs within spreadsheets
File - Individual file metadata
Storage Service - Object storage (S3, GCS, Azure Blob)
Container - Storage buckets
Table - Tables loaded from spreadsheets
Pipeline - Pipelines processing drive files

Drive Service¶

Overview¶

Relationships¶

Schema Specifications¶

Drive Service Types¶

Google Drive¶

OneDrive / SharePoint¶

Dropbox¶

File Types in Drive Services¶

Spreadsheets¶

Documents¶

Presentations¶

Other Files¶

Use Cases¶

Business Analytics¶

Document Management¶

Collaborative Data Prep¶

Custom Properties¶

API Operations¶

Create Drive Service¶

List Directories¶

Get Spreadsheet Metadata¶

Related Documentation¶