PyODPS supports two types of resources: file resources and table resources. This topic describes the common operations you can perform on resources in PyODPS.

Basic operations

  • list_resources(): queries all resources in a project.
  • exist_resource(): checks whether a resource exists.
  • delete_resource(): deletes a resource. You can also call the drop() method to delete a resource.
  • create_resource(): creates a resource.
  • open_resource(): reads a resource.

Manage file resources

In addition to common files, file resources include .py files, .jar files, and archive files.

  • Create a file resource

    To create a file resource, you can call the create_resource() method with a resource name, a file type, and a file-like object or string specified.

    # Use a file-like object to create a file resource. Files such as compressed packages must be read in binary mode.
    resource = o.create_resource('test_file_resource', 'file', file_obj=open('/to/path/file', 'rb'))
    # Use a string to create a file resource.
    resource = o.create_resource('test_py_resource', 'py', file_obj='import this')
  • Read and modify a file resource
    You can use one of the following methods to open a resource:
    • Call the open method for a file resource to open it.
    • Call the open_resource() method of a MaxCompute entry object.
    The opened object is a file-like object. The open modes of file resources are similar to the open() method predefined in Python. The following example demonstrates the open modes of file resources:
    with'r') as fp:  # Open a resource in read mode. 
        content =  # Read all content.  # Return to the beginning of the resource. 
        lines = fp.readlines()  # Read multiple lines. 
        fp.write('Hello World')  # Error. Data cannot be written in read mode. 
    with o.open_resource('test_file_resource', mode='r+') as fp:  # Open the file in read/write mode.
        fp.tell()  # Locate the current position.
        fp.truncate()  # Truncate the file to the specified length. 
        fp.writelines(['Hello\n', 'World\n'])  # Write multiple lines into the file. 
        fp.write('Hello World')
        fp.flush()  # Manually call the method to submit the update to MaxCompute. 

    PyODPS supports the following open modes:

    • r: the read mode. The file can be opened, but data cannot be written to it.
    • w: the write mode. Data can be written to the file, but data in the file cannot be read. If a file is opened in write mode, the file content is cleared first.
    • a: the append mode. Data can be added to the end of the file.
    • r+: the read/write mode. You can read data from and write data to the file in this mode.
    • w+: This mode is similar to the r+ mode. The only difference is that the file content is cleared first.
    • a+: This mode is similar to the r+ mode. The only difference is that data can be written only to the end of the file.
    PyODPS also supports the following binary open modes for some file resources, such as compressed files:
    • rb: the binary read mode.
    • r+b: the binary read/write mode.

Manage table resources

  • Create a table resource
    o.create_resource('test_table_resource', 'table', table_name='my_table', partition='pt=test')
  • Update a table resource
    table_resource = o.get_resource('test_table_resource')
    table_resource.update(partition='pt=test2', project_name='my_project2')
  • Obtain information about a table and a partition
    table_resource = o.get_resource('test_table_resource')
    table = table_resource.table
    partition = table_resource.partition
  • Read and write data
    table_resource = o.get_resource('test_table_resource')
    with table_resource.open_writer() as writer:
        writer.write([0, 'aaaa'])
        writer.write([1, 'bbbbb'])
    with table_resource.open_reader() as reader:
        for rec in reader: