Skip to content
View inMAUIWPFWinUIView on GitHubSample viewer app

Generate a local geodatabase from an online feature service.

Image of generate geodatabase replica from feature service

Use case

Generating geodatabases is the first step toward taking a feature service offline. It allows you to save features locally for offline display.

How to use the sample

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.

How it works

  1. Create a GeodatabaseSyncTask with the URL of the feature service and load it.
  2. Create GenerateGeodatabaseReplicaParameters specifying the extent and whether to include attachments.
  3. Create a GenerateGeodatabaseReplicaJob with geodatabaseSyncTask.GenerateGeodatabaseReplicaAsync(parameters, downloadPath). Start the job with job.Start().
  4. When the job is done, job.GetResultAsync() will return the geodatabase. Inside the geodatabase are feature tables which can be used to add feature layers to the map.
  5. Call syncTask.UnregisterGeodatabaseAsync(geodatabase) after generation when you're not planning on syncing changes to the service.

Relevant API

  • GenerateGeodatabaseReplicaJob
  • GenerateGeodatabaseReplicaParameters
  • Geodatabase
  • GeodatabaseSyncTask

Tags

disconnected, local geodatabase, offline, replica, sync

Sample Code

GenerateGeodatabaseReplica.xaml.csGenerateGeodatabaseReplica.xaml.csGenerateGeodatabaseReplica.xaml
Use dark colors for code blocksCopy
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 // 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: http://www.apache.org/licenses/LICENSE-2.0 // // 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 ArcGIS.Samples.Managers; using Esri.ArcGISRuntime.ArcGISServices; 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;  namespace ArcGIS.WPF.Samples.GenerateGeodatabaseReplica {  [ArcGIS.Samples.Shared.Attributes.Sample(  name: "Generate geodatabase replica from feature service",  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", "replica", "sync" })]  [ArcGIS.Samples.Shared.Attributes.OfflineData("e4a398afe9a945f3b0f4dca1e4faccb5")]  public partial class GenerateGeodatabaseReplica  {  // URI for a feature service that supports geodatabase generation.  private Uri _featureServiceUri = new Uri("https://sampleserver6.arcgisonline.com/arcgis/rest/services/Sync/WildfireSync/FeatureServer");   // 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 GenerateGeodatabaseReplica()  {  InitializeComponent();   // Create the UI, setup the control references and execute initialization.  _ = Initialize();  }   private async Task Initialize()  {  try  {  // Create a tile cache from a locally downloaded file.  TileCache tileCache = new TileCache(DataManager.GetDataFolder("e4a398afe9a945f3b0f4dca1e4faccb5", "SanFrancisco.tpkx"));   // 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.  MyMapView.GraphicsOverlays.Add(extentOverlay);   // 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)  {  MessageBox.Show(ex.ToString());  }  }   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);  envelopeBldr.Expand(0.80);   // 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());  extentOverlay.Graphics.Add(extentGraphic);  }  else  {  // 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) =>  {  UpdateProgressBar();  };   // Show the progress bar.  MyProgressBar.Visibility = Visibility.Visible;   // Start the job.  _generateGdbJob.Start();   // 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)  {  MyMapView.Map.OperationalLayers.Clear();   // 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.  MyMapView.Map.OperationalLayers.Add(layer);  }  // 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.");  }  else  {  // 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;  }  else  {  // If no error, show messages from the _generateGdbJob.  message += ": " + string.Join("\n", _generateGdbJob.Messages.Select(m => m.Message));  }   MessageBox.Show(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.  try  {  _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)  {  MessageBox.Show(ex.ToString());  }  }   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;  });  }  } }

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.