Click or drag to resize

GeodatabaseSyncTask Class

Task for generating and syncing offline data from an ArcGIS Server FeatureService.
Inheritance Hierarchy

Namespace:  Esri.ArcGISRuntime.Tasks.Offline
Assembly:  Esri.ArcGISRuntime (in Esri.ArcGISRuntime.dll) Version: 100.11.0
public sealed class GeodatabaseSyncTask : IApiKeyResource

The GeodatabaseSyncTask type exposes the following members.

Public propertyApiKey
The unique key generated from ArcGIS Developers website.
Public propertyCredential
Gets or sets the security credential used to access a remote task
Public propertyCode exampleServiceInfo
Gets the ArcGISFeatureServiceInfo that represents the feature service to synchronize with.
Public propertyUri
Gets the uri of the feature service to synchronize with.
Public methodStatic memberApplyDeltaAsync
Imports a geodatabase delta and applies it to the given geodatabase.
Public methodStatic memberCode exampleCreateAsync(Uri, Credential)
Creates a geodatabase sync task from an online URI.
Public methodStatic memberCreateAsync(Uri, String)
Creates a geodatabase sync task from an online URI.
Public methodCode exampleCreateDefaultGenerateGeodatabaseParametersAsync
Creates default parameters for a generate geodatabase.
Public methodCode exampleCreateDefaultSyncGeodatabaseParametersAsync(Geodatabase)
Creates default parameters for a sync geodatabase.
Public methodCreateDefaultSyncGeodatabaseParametersAsync(Geodatabase, SyncDirection)
Creates default parameters for a sync geodatabase using the given sync direction.
Public methodStatic memberExportDeltaAsync
Generates an upload delta geodatabase file containing all the changes since the last sync.
Public methodCode exampleGenerateGeodatabase
Creates a generate geodatabase job that when started will generate a geodatabase from a service.
Public methodImportDeltaAsync Obsolete.
Imports a geodatabase delta and applies it to the given geodatabase.
Public methodStatic memberImportGeodatabaseDeltaAsync(String, String) Obsolete.
Imports a geodatabase delta and applies it to the geodatabase in given geodatabase filename.
Public methodImportGeodatabaseDeltaAsync(Geodatabase, String) Obsolete.
Imports a geodatabase delta and applies it to the given geodatabase.
Public methodRegisterGeodatabaseAsync
Registers a copy of a sync enabled geodatabase with a service to allow the copy to sync changes.
Public methodCode exampleSyncGeodatabase(SyncGeodatabaseParameters, Geodatabase)
Creates a job to synchronize a geodatabase back to a service.
Public methodSyncGeodatabase(SyncDirection, Boolean, Geodatabase)
Creates a job to synchronize a geodatabase back to its service using the given sync direction and rollback on failure boolean value.
Public methodUnregisterGeodatabaseAsync(Guid)
Unregisters a geodatabase from a service removing the service's replica id. This overload uses the geodatabase's sync ID rather than a reference to the geodatabase itself.
Public methodCode exampleUnregisterGeodatabaseAsync(Geodatabase)
Unregisters a geodatabase from the server.


Example Name: GenerateGeodatabase

Generate a local geodatabase from an online feature service.

Code example screen shot.

// Copyright 2018 Esri.
// Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
// You may obtain a copy of the License at:
// Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific
// language governing permissions and limitations under the License.

using ArcGISRuntime.Samples.Managers;
using Esri.ArcGISRuntime.Data;
using Esri.ArcGISRuntime.Geometry;
using Esri.ArcGISRuntime.Mapping;
using Esri.ArcGISRuntime.Symbology;
using Esri.ArcGISRuntime.Tasks;
using Esri.ArcGISRuntime.Tasks.Offline;
using Esri.ArcGISRuntime.UI;
using System;
using System.Drawing;
using System.IO;
using System.Linq;
using System.Threading.Tasks;
using System.Windows;
using Esri.ArcGISRuntime.ArcGISServices;

namespace ArcGISRuntime.WPF.Samples.GenerateGeodatabase
        name: "Generate geodatabase",
        category: "Data",
        description: "Generate a local geodatabase from an online feature service.",
        instructions: "Zoom to any extent. Then click the generate button to generate a geodatabase of features from a feature service filtered to the current extent. A red outline will show the extent used. The job's progress is shown while the geodatabase is generated.",
        tags: new[] { "disconnected", "local geodatabase", "offline", "sync" })]
    public partial class GenerateGeodatabase
        // URI for a feature service that supports geodatabase generation.
        private Uri _featureServiceUri = new Uri("");

        // Path to the geodatabase file on disk.
        private string _gdbPath;

        // Task to be used for generating the geodatabase.
        private GeodatabaseSyncTask _gdbSyncTask;

        // Job used to generate the geodatabase.
        private GenerateGeodatabaseJob _generateGdbJob;

        public GenerateGeodatabase()

            // Create the UI, setup the control references and execute initialization.

        private async void Initialize()
                // Create a tile cache from a locally downloaded file.
                TileCache tileCache = new TileCache(DataManager.GetDataFolder("3f1bbf0ec70b409a975f5c91f363fe7d", "SanFrancisco.tpk"));

                // Create the corresponding layer based on the tile cache.
                ArcGISTiledLayer tileLayer = new ArcGISTiledLayer(tileCache);

                // Create the basemap based on the tile cache.
                Basemap sfBasemap = new Basemap(tileLayer);

                // Create the map with the tile-based basemap.
                Map myMap = new Map(sfBasemap);

                // Assign the map to the MapView.
                MyMapView.Map = myMap;

                // Create a new symbol for the extent graphic.
                SimpleLineSymbol lineSymbol = new SimpleLineSymbol(SimpleLineSymbolStyle.Solid, Color.Red, 2);

                // Create graphics overlay for the extent graphic and apply a renderer.
                GraphicsOverlay extentOverlay = new GraphicsOverlay
                    Renderer = new SimpleRenderer(lineSymbol)

                // Add graphics overlay to the map view.

                // Set up an event handler for when the viewpoint (extent) changes.
                MyMapView.ViewpointChanged += UpdateMapExtent;

                // Create a task for generating a geodatabase (GeodatabaseSyncTask).
                _gdbSyncTask = await GeodatabaseSyncTask.CreateAsync(_featureServiceUri);

                // Add all graphics from the service to the map.
                foreach (IdInfo layer in _gdbSyncTask.ServiceInfo.LayerInfos)
                    // Create the ServiceFeatureTable for this layer.
                    ServiceFeatureTable onlineTable = new ServiceFeatureTable(new Uri(_featureServiceUri + "/" + layer.Id));

                    // Wait for the table to load.
                    await onlineTable.LoadAsync();

                    // Add the layer to the map's operational layers if load succeeds.
                    if (onlineTable.LoadStatus == Esri.ArcGISRuntime.LoadStatus.Loaded)
                        myMap.OperationalLayers.Add(new FeatureLayer(onlineTable));

                // Update the graphic - needed in case the user decides not to interact before pressing the button.
                UpdateMapExtent(null, null);

                // Enable the generate button.
                MyGenerateButton.IsEnabled = true;
            catch (Exception ex)

        private void UpdateMapExtent(Object sender, EventArgs e)
            // Return if mapview is null.
            if (MyMapView == null) { return; }

            // Get the new viewpoint.
            Viewpoint myViewPoint = MyMapView.GetCurrentViewpoint(ViewpointType.BoundingGeometry);

            // Return if viewpoint is null.
            if (myViewPoint == null) { return; }

            // Get the updated extent for the new viewpoint.
            Envelope extent = myViewPoint.TargetGeometry as Envelope;

            // Return if extent is null.
            if (extent == null) { return; }

            // Create an envelope that is a bit smaller than the extent.
            EnvelopeBuilder envelopeBldr = new EnvelopeBuilder(extent);

            // Get the (only) graphics overlay in the map view.
            GraphicsOverlay extentOverlay = MyMapView.GraphicsOverlays.FirstOrDefault();

            // Return if the extent overlay is null.
            if (extentOverlay == null) { return; }

            // Get the extent graphic.
            Graphic extentGraphic = extentOverlay.Graphics.FirstOrDefault();

            // Create the extent graphic and add it to the overlay if it doesn't exist.
            if (extentGraphic == null)
                extentGraphic = new Graphic(envelopeBldr.ToGeometry());
                // Otherwise, simply update the graphic's geometry.
                extentGraphic.Geometry = envelopeBldr.ToGeometry();

        private async Task StartGeodatabaseGeneration()
            // Create a task for generating a geodatabase (GeodatabaseSyncTask).
            _gdbSyncTask = await GeodatabaseSyncTask.CreateAsync(_featureServiceUri);

            // Get the current extent of the red preview box.
            Envelope extent = MyMapView.GraphicsOverlays.First().Graphics.First().Geometry as Envelope;

            // Get the default parameters for the generate geodatabase task.
            GenerateGeodatabaseParameters generateParams = await _gdbSyncTask.CreateDefaultGenerateGeodatabaseParametersAsync(extent);

            // Create a generate geodatabase job.
            _generateGdbJob = _gdbSyncTask.GenerateGeodatabase(generateParams, _gdbPath);

            // Handle the progress changed event (to show progress bar).
            _generateGdbJob.ProgressChanged += (sender, e) =>

            // Show the progress bar.
            MyProgressBar.Visibility = Visibility.Visible;

            // Start the job.

            // Get the result.
            Geodatabase resultGdb = await _generateGdbJob.GetResultAsync();

            // Hide the progress bar.
            MyProgressBar.Visibility = Visibility.Hidden;

            // Do the rest of the work.
            await HandleGenerationCompleted(resultGdb);

        private async Task HandleGenerationCompleted(Geodatabase resultGdb)
            // If the job completed successfully, add the geodatabase data to the map,
            // removing the version from the service.
            if (_generateGdbJob.Status == JobStatus.Succeeded)

                // Loop through all feature tables in the geodatabase and add a new layer to the map.
                foreach (GeodatabaseFeatureTable table in resultGdb.GeodatabaseFeatureTables)
                    // Create a new feature layer for the table.
                    FeatureLayer layer = new FeatureLayer(table);

                    // Add the new layer to the map.
                // Best practice is to unregister the geodatabase.
                await _gdbSyncTask.UnregisterGeodatabaseAsync(resultGdb);

                // Tell the user that the geodatabase was unregistered.
                MessageBox.Show("Since no edits will be made, the local geodatabase has been unregistered per best practice.");
                // Create a message to show the user.
                string message = "Generate geodatabase job failed";

                // Show an error message (if there is one).
                if (_generateGdbJob.Error != null)
                    message += ": " + _generateGdbJob.Error.Message;
                    // If no error, show messages from the _generateGdbJob.
                    message += ": " + string.Join("\n", _generateGdbJob.Messages.Select(m => m.Message));


        private async void GenerateButton_Clicked(object sender, RoutedEventArgs e)
            // Fix the extent of the graphic.
            MyMapView.ViewpointChanged -= UpdateMapExtent;

            // Update the geodatabase path for the new run.
                _gdbPath = Path.Combine(Environment.ExpandEnvironmentVariables("%TEMP%"), Path.GetTempFileName() + ".geodatabase");

                // Prevent the user from clicking twice - errors happen.
                MyGenerateButton.IsEnabled = false;

                // Call the cross-platform geodatabase generation method.
                await StartGeodatabaseGeneration();
            catch (Exception ex)

        private void UpdateProgressBar()
            // Due to the nature of the threading implementation,
            //     the dispatcher needs to be used to interact with the UI.
            Dispatcher.Invoke(() =>
                // Update the progress bar value.
                MyProgressBar.Value = _generateGdbJob.Progress / 1.0;
<UserControl x:Class="ArcGISRuntime.WPF.Samples.GenerateGeodatabase.GenerateGeodatabase"
             d:DesignHeight="300" d:DesignWidth="300">
        <esri:MapView x:Name="MyMapView" />
        <Border Style="{StaticResource BorderStyle}">
                <Button x:Name="MyGenerateButton" Content="Generate Geodatabase" Click="GenerateButton_Clicked" IsEnabled="False" />
                <ProgressBar x:Name="MyProgressBar" Visibility="Collapsed" MinHeight="10" />
See Also
Additional Examples
Hyperlink to ExampleDescription
EditAndSyncFeaturesSynchronize offline edits with a feature service.
GenerateGeodatabaseGenerate a local geodatabase from an online feature service.
GeodatabaseTransactionsUse transactions to manage how changes are committed to a geodatabase.