Manage file assets

Operations on file assets (connections, files).

In general, these should be:

• Created in top-down order (connection, then files)
• Deleted in bottom-up order (files, then connections)¹

erDiagram
  Connection ||--o{ File : contains

Asset structure

Connection

2.0.0 1.9.5

A file connection requires a name and qualifiedName. For creation, you can use any connector type you want, to give you a particular icon for the connection. In addition, at least one of adminRoles, adminGroups, or adminUsers must be provided.

Java Python Raw REST API

String adminRoleGuid = RoleCache.getIdForName("$admin"); // (1)
Connection connection = Connection.creator( // (2)
        "file-connection", // (3)
        AtlanConnectorType.FILE, // (4)
        List.of(adminRoleGuid), // (5)
        List.of("group2"), // (6)
        List.of("jsmith")) // (7)
    .build();
AssetMutationResponse response = connection.save(); // (8)
String connectionQualifiedName = response.getCreatedAssets().get(0).getQualifiedName(); // (9)

1. Retrieve the GUID for the admin role, to use later for defining the roles that can administer the connection.
2. Build up the minimum request to create a connection.
3. Provide a human-readable name for your connection, such as production or development.
4. Set the type of connection to FILE.
5. List the workspace roles that should be able to administer the connection (or null if none). All users with that workspace role (current and future) will be administrators of the connection. Note that the values here need to be the GUID(s) of the workspace role(s). At least one of adminRoles, adminGroups, or adminUsers must be provided.
6. List the group names that can administer this connection (or null if none). All users within that group (current and future) will be administrators of the connection. Note that the values here are the name(s) of the group(s). At least one of adminRoles, adminGroups, or adminUsers must be provided.
7. List the user names that can administer this connection (or null if none). Note that the values here are the username(s) of the user(s). At least one of adminRoles, adminGroups, or adminUsers must be provided.
8. Actually call Atlan to create the connection.
9. Retrieve the qualifiedName for use in subsequent creation calls. (You'd probably want to do some null checking first.)

from pyatlan.cache.role_cache import RoleCache
from pyatlan.client.atlan import AtlanClient
from pyatlan.model.assets import Connection
from pyatlan.model.enums import AtlanConnectorType

admin_role_guid = str(RoleCache.get_id_for_name("$admin")) # (1)
connection = Connection.creator( # (2)
    name="file-connection", # (3)
    connector_type=AtlanConnectorType.FILE, # (4)
    admin_roles=[admin_role_guid], # (5)
    admin_groups=["group2"], # (6)
    admin_users=["jsmith"], # (7)
)
response = client.asset.save(connection) # (8)
connection_qualified_name = response.assets_created(asset_type=Connection)[0].qualified_name # (9)

1. Retrieve the GUID for the admin role, to use later for defining the roles that can administer the connection.
2. Build up the minimum request to create a connection.
3. Provide a human-readable name for your connection, such as production or development.
4. Set the type of connection to FILE.
5. List the workspace roles that should be able to administer the connection (or null if none). All users with that workspace role (current and future) will be administrators of the connection. Note that the values here need to be the GUID(s) of the workspace role(s). At least one of admin_roles, admin_groups, or admin_users must be provided.
6. List the group names that can administer this connection (or null if none). All users within that group (current and future) will be administrators of the connection. Note that the values here are the name(s) of the group(s). At least one of admin_roles, admin_groups, or admin_users must be provided.
7. List the user names that can administer this connection (or null if none). Note that the values here are the username(s) of the user(s). At least one of admin_roles, admin_groups, or admin_users must be provided.
8. Actually call Atlan to create the connection.
9. Retrieve the qualified_name for use in subsequent creation calls. (You'd probably want to do some null checking first.)

{
  "entities": [
    {
      "typeName": "Connection", // (1)
      "attributes": {
        "name": "file-connection", // (2)
        "connectorName": "file", // (3)
        "qualifiedName": "default/file/123456789", // (4)
        "category": "ObjectStore", // (5)
        "adminRoles": [ // (6)
          "e7ae0295-c60a-469a-bd2c-fb903943aa02"
        ],
        "adminGroups": [ // (7)
          "group2"
        ],
        "adminUsers": [ // (8)
          "jsmith"
        ]
      }
    }
  ]
}

1. The typeName must be exactly Connection.
2. Human-readable name for your connection, such as production or development.
3. The connectorName should be file..
4. The qualifiedName should follow the pattern: default/file/<epoch>, where <epoch> is the time in milliseconds at which the connection is being created.
5. The category should be ObjectStore.
6. List any workspace roles that can administer this connection. All users with that workspace role (current and future) will be administrators of the connection. Note that the values here need to be the GUID(s) of the workspace role(s). At least one of adminRoles, adminGroups, or adminUsers must be provided.
7. List any groups that can administer this connection. All users within that group (current and future) will be administrators of the connection. Note that the values here are the name(s) of the group(s). At least one of adminRoles, adminGroups, or adminUsers must be provided.
8. List any users that can administer this connection. Note that the values here are the username(s) of the user(s). At least one of adminRoles, adminGroups, or adminUsers must be provided.

Access policies

Atlan creates the policies that grant access to a connection, including the ability to retrieve the connection and to create assets within it, asynchronously. It can take several seconds (even up to approximately 30 seconds) before these are in place after creating the connection.

You may therefore need to wait before you'll be able to create the assets below within the connection.

To confirm access, retrieve the connection after it has been created. The SDKs' retry loops will automatically retry until the connection can be successfully retrieved. At that point, your API token has permission to create the other assets.

Note: if you are reusing an existing connection rather than creating one via your API token, you must give your API token a persona that has access to that connection. Otherwise all attempts to create, read, update, or delete assets within that connection will fail due to a lack of permissions.

File

2.0.0 1.0.0

A file asset requires a name and a qualifiedName. For creation, you also need to specify the connectionQualifiedName of the connection for the file.

Java Python Raw REST API

File file = File.creator( // (1)
        "example-file.pdf", // (2)
        connectionQualifiedName, // (3)
        FileType.PDF) // (4)
    .build();
AssetMutationResponse response = file.save(); // (5)

1. Build up the minimum request to create a file.
2. Provide a human-readable name for your file asset.
3. Provide the qualifiedName of the connection for this file asset.
4. Specify the type of the file. This will control the icon that is used for the file.
5. Actually call Atlan to create the file asset.

file = File.creator( # (1)
    name="example-file.pdf", # (2)
    connection_qualified_name=connection_qualified_name, # (3)
    file_type=FileType.PDF) # (4)
response = client.asset.save(file) # (5)

1. Build up the minimum request to create a file.
2. Provide a human-readable name for your file asset.
3. Provide the qualifiedName of the connection for this file asset.
4. Specify the type of the file. This will control the icon that is used for the file.
5. Actually call Atlan to create the file asset.

{
  "entities": [
    {
      "typeName": "File", // (1)
      "attributes": {
        "name": "example-file.pdf", // (2)
        "qualifiedName": "default/api/123456789/example-file.pdf", // (3)
        "connectionQualifiedName": "default/api/123456789", // (4)
        "connectorName": "api", // (5)
        "fileType": "pdf" // (6)
      }
    }
  ]
}

1. The typeName must be exactly File.
2. Human-readable name for your asset.
3. The qualifiedName should follow the pattern: default/<connectortype>/<epoch>/<asset_name>, where default/<connectortype>/<epoch> is the qualifiedName of the connection for this asset and <asset_name> is the name of the asset.
4. The connectionQualifiedName must be the exact qualifiedName of the connection for this asset.
5. The connectorName must be the same value as the connector type used when creating the connection.
6. Use the fileType to control what icon should be shown for the file itself in the UI.

Available relationships

Each file is an Asset, and can therefore be related to the following other assets.

erDiagram
  Asset }o--o{ AtlasGlossaryTerm : meanings
  Asset ||--o{ Link : links
  Asset ||--o| Readme : readme
  Asset }o--o{ Process : inputToProcesses
  Asset }o--o{ Process : outputFromProcesses

AtlasGlossaryTerm

A glossary term provides meaning to an asset. The link terms to assets snippet provides more detail on setting this relationship.

Link

A link provides additional context to an asset, by providing a URL to additional information.

Readme

A README provides rich documentation for an asset. The add asset READMEs snippet provides more detail on setting this relationship.

Process

A process provides lineage information for an asset. An asset can be both an input and an output for one or more processes. The lineage snippets provide more detail on creating and working with lineage.

---

1. Note that unlike other assets, the packaged connection delete utility in the UI will not remove files associated with the connection. So files must themselves be deleted, separately from the connection. ↩

---