How elastic/enterprise-search-sharepoint-server-connector works
This is an Elastic Workplace Search connector for SharePoint Server. An operator configures and launches a CLI command; full or incremental sync fetches SharePoint records, transforms them into connector documents, queues batches, and indexes them into Workplace Search. Separate commands bootstrap a content source, test connectivity, reconcile deletions, and synchronize document permissions. Full and incremental jobs retain local IDs and checkpoints. Source excerpts establish the sync and client responsibilities; several ancillary command implementations were not sampled, so their links are included only where the README or source index supports them.
Main entry points: base_command.py Command foundation · cli.py CLI dispatcher · incremental_sync_command.py Incremental sync · full_sync_command.py Full sync
Components 23
Command entry
- CLI dispatcher
ees_sharepoint/cli.py - Source bootstrap
ees_sharepoint/bootstrap_command.py - Connection test
ees_sharepoint/test_connectivity.py - Command foundation
ees_sharepoint/base_command.py - Configuration
ees_sharepoint/configuration.py
Content synchronization
- Document schema
ees_sharepoint/schema.py - Full sync
ees_sharepoint/full_sync_command.py - Incremental sync
ees_sharepoint/incremental_sync_command.py - SharePoint extraction
ees_sharepoint/sync_sharepoint.py - Document adapter
ees_sharepoint/adapter.py - Content extraction utilities
ees_sharepoint/utils.py - Connector queue
ees_sharepoint/connector_queue.py - Index worker
ees_sharepoint/sync_enterprise_search.py
Local state
- Document ID storage
ees_sharepoint/local_storage.py - Sync checkpoints
ees_sharepoint/checkpointing.py
External services
- SharePoint API client
ees_sharepoint/sharepoint_client.py - Workplace Search client
ees_sharepoint/enterprise_search_wrapper.py - Workplace Search
- SharePoint Server
Permissions and cleanup
- Deletion reconciliation
ees_sharepoint/deletion_sync_command.py - Permission sync
ees_sharepoint/permission_sync_command.py - User-group permissions
ees_sharepoint/usergroup_permissions.py
Other components
- Operator
Connections 42
- Operator → CLI dispatcher: runs command
README.md - CLI dispatcher → Source bootstrap: dispatches to
ees_sharepoint/cli.py - CLI dispatcher → Full sync: dispatches to
ees_sharepoint/cli.py - CLI dispatcher → Incremental sync: dispatches to
ees_sharepoint/cli.py - CLI dispatcher → Deletion reconciliation: dispatches to
ees_sharepoint/cli.py - CLI dispatcher → Permission sync: dispatches to
ees_sharepoint/cli.py - Source bootstrap → Command foundation: inherits from
ees_sharepoint/bootstrap_command.py - Full sync → Command foundation: inherits from
ees_sharepoint/full_sync_command.py - Incremental sync → Command foundation: inherits from
ees_sharepoint/incremental_sync_command.py - Command foundation → Configuration: loads
ees_sharepoint/base_command.py - Command foundation → SharePoint API client: creates
ees_sharepoint/base_command.py - Command foundation → Workplace Search client: creates
ees_sharepoint/base_command.py - Command foundation → Document ID storage: creates
ees_sharepoint/base_command.py - Configuration → Document schema: uses
ees_sharepoint/configuration.py - Full sync → SharePoint extraction: fetches records
ees_sharepoint/full_sync_command.py - Incremental sync → SharePoint extraction: fetches records
ees_sharepoint/incremental_sync_command.py - Full sync → Connector queue: creates and signals
ees_sharepoint/full_sync_command.py - Incremental sync → Connector queue: creates and signals
ees_sharepoint/incremental_sync_command.py - Full sync → Index worker: starts consumers
ees_sharepoint/full_sync_command.py - Incremental sync → Index worker: starts consumers
ees_sharepoint/incremental_sync_command.py - Index worker → Connector queue: consumes batches
ees_sharepoint/sync_enterprise_search.py - Index worker → Workplace Search client: indexes batches
ees_sharepoint/sync_enterprise_search.py - Workplace Search client → Workplace Search: indexes and deletes
ees_sharepoint/enterprise_search_wrapper.py - SharePoint extraction → SharePoint API client: queries API
ees_sharepoint/sync_sharepoint.py - SharePoint API client → SharePoint Server: sends requests
ees_sharepoint/sharepoint_client.py - SharePoint extraction → Document adapter: uses schema
ees_sharepoint/sync_sharepoint.py - SharePoint extraction → Content extraction utilities: uses helpers
ees_sharepoint/sync_sharepoint.py - Full sync → Document ID storage: loads and saves IDs
ees_sharepoint/full_sync_command.py - Incremental sync → Document ID storage: loads and saves IDs
ees_sharepoint/incremental_sync_command.py - Incremental sync → Sync checkpoints: reads and sets
ees_sharepoint/incremental_sync_command.py - Index worker → Sync checkpoints: records progress
ees_sharepoint/sync_enterprise_search.py - Deletion reconciliation → Command foundation: inherits from
ees_sharepoint/deletion_sync_command.py - Deletion reconciliation → SharePoint API client: checks deleted records
ees_sharepoint/deletion_sync_command.py - Deletion reconciliation → Workplace Search client: deletes documents
ees_sharepoint/deletion_sync_command.py - Permission sync → Command foundation: inherits from
ees_sharepoint/permission_sync_command.py - Permission sync → SharePoint API client: fetches users
ees_sharepoint/permission_sync_command.py - Permission sync → User-group permissions: uses permission logic
ees_sharepoint/permission_sync_command.py - Permission sync → Sync checkpoints: uses checkpoints
ees_sharepoint/permission_sync_command.py - Permission sync → Workplace Search client: updates permissions
ees_sharepoint/permission_sync_command.py - Workplace Search client → Workplace Search: manages permissions
ees_sharepoint/enterprise_search_wrapper.py - CLI dispatcher → Connection test: dispatches to
ees_sharepoint/cli.py - Source bootstrap → Workplace Search: creates content source
README.md