ArcGIS Desktop

  • ArcGIS Pro
  • ArcMap

  • My Profile
  • Help
  • Sign Out
ArcGIS Desktop

ArcGIS Online

The mapping platform for your organization

ArcGIS Desktop

A complete professional GIS

ArcGIS Enterprise

GIS in your enterprise

ArcGIS Developers

Tools to build location-aware apps

ArcGIS Solutions

Free template maps and apps for your industry

ArcGIS Marketplace

Get apps and data for your organization

  • Documentation
  • Support
Esri
  • Sign In
user
  • My Profile
  • Sign Out

ArcMap

  • Home
  • Get Started
  • Map
  • Analyze
  • Manage Data
  • Tools
  • Extensions

Create ArcSDE Connection File

  • Summary
  • Syntax
  • Environments
  • Licensing information

Summary

Legacy:

The Create ArcSDE Connection File tool is not supported beginning with ArcGIS 10.6.1.

Usage

    Syntax

    arcpy.management.CreateArcSDEConnectionFile(out_folder_path, out_name, server, service, {database}, {account_authentication}, {username}, {password}, {save_username_password}, {version}, {save_version_info})
    ParameterExplanationData Type
    out_folder_path

    The folder path where the .sde file will be stored.

    Folder
    out_name

    The name of the connection file. Use the .sde file extension.

    String
    server

    The name of the machine where the ArcSDE application server is installed.

    String
    service

    The ArcSDE service name or TCP port number.

    String
    database
    (Optional)

    The name of the database to connect to. Do not provide a database name when connecting to Oracle.

    String
    account_authentication
    (Optional)
    • DATABASE_AUTH —Database Authentication. Uses an internal database user name and password to connect to the DBMS. You aren't required to type your user name and password to create a connection; however, if you don't, you will be prompted to enter them when a connection is established.
    • OPERATING_SYSTEM_AUTH —Use Operating system authentication. You do not need to type a user name and password. The connection will be made with the credentials used to log in to the operating system. If the login used for the operating system is not a valid geodatabase login, the connection will fail. Also note you cannot make an ArcSDE service connection using operating system authentication to a geodatabase stored in Oracle, DB2, or Informix.
    Boolean
    username
    (Optional)

    Database user name to connect with when using Database Authentication.

    String
    password
    (Optional)

    The database user password when using Database Authentication.

    Encrypted String
    save_username_password
    (Optional)
    • SAVE_USERNAME —Save the user name and password in the connection file.
    • DO_NOT_SAVE_USERNAME —Do not save the user name and password in the file. Every time you connect using the file, you will be prompted for a user name and password.
    Boolean
    version
    (Optional)

    The geodatabase version to connect to. By default, connections are made to the DEFAULT version.

    String
    save_version_info
    (Optional)
    • SAVE_VERSION —Save the version name in the connection file.
    • DO_NOT_SAVE_VERSION —Do not save the version name in the connection file. Without the version name being saved with the file, a connection to the DEFAULT version will be made the next time you access the connection file.
    Boolean

    Environments

    • Current Workspace

    Licensing information

    • Basic: No
    • Standard: Yes
    • Advanced: Yes

    ArcGIS Desktop

    • Home
    • Documentation
    • Support

    ArcGIS

    • ArcGIS Online
    • ArcGIS Desktop
    • ArcGIS Enterprise
    • ArcGIS
    • ArcGIS Developer
    • ArcGIS Solutions
    • ArcGIS Marketplace

    About Esri

    • About Us
    • Careers
    • Esri Blog
    • User Conference
    • Developer Summit
    Esri
    Tell us what you think.
    Copyright © 2021 Esri. | Privacy | Legal