seitime-frappe/frappe/docs/current/api/desk/frappe.desk.query_report.html

<!-- title: frappe.desk.query_report --><div class="dev-header">

<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
	Version 6.x.x</a>


	<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/blob/develop/frappe/desk/query_report.py"
		target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a>

</div>





	
        
    
    
	<p class="docs-attr-name">
        <a name="frappe.desk.query_report.add_total_row" href="#frappe.desk.query_report.add_total_row" class="text-muted small">
            <i class="icon-link small" style="color: #ccc;"></i></a>
		frappe.desk.query_report.<b>add_total_row</b>
        <i class="text-muted">(result, columns)</i>
    </p>
	<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
	<br>

	

	
        
    
    
	<p class="docs-attr-name">
        <a name="frappe.desk.query_report.get_columns_dict" href="#frappe.desk.query_report.get_columns_dict" class="text-muted small">
            <i class="icon-link small" style="color: #ccc;"></i></a>
		frappe.desk.query_report.<b>get_columns_dict</b>
        <i class="text-muted">(columns)</i>
    </p>
	<div class="docs-attr-desc"><p>Returns a dict with column docfield values as dict
The keys for the dict are both idx and fieldname,
so either index or fieldname can be used to search for a column's docfield properties</p>
</div>
	<br>

	

	
        
    
    
	<p class="docs-attr-name">
        <a name="frappe.desk.query_report.get_filtered_data" href="#frappe.desk.query_report.get_filtered_data" class="text-muted small">
            <i class="icon-link small" style="color: #ccc;"></i></a>
		frappe.desk.query_report.<b>get_filtered_data</b>
        <i class="text-muted">(ref_doctype, columns, data)</i>
    </p>
	<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
	<br>

	

	
        
    
    
	<p class="docs-attr-name">
        <a name="frappe.desk.query_report.get_linked_doctypes" href="#frappe.desk.query_report.get_linked_doctypes" class="text-muted small">
            <i class="icon-link small" style="color: #ccc;"></i></a>
		frappe.desk.query_report.<b>get_linked_doctypes</b>
        <i class="text-muted">(columns, data)</i>
    </p>
	<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
	<br>

	

	
        
    
    
	<p class="docs-attr-name">
        <a name="frappe.desk.query_report.get_report_doc" href="#frappe.desk.query_report.get_report_doc" class="text-muted small">
            <i class="icon-link small" style="color: #ccc;"></i></a>
		frappe.desk.query_report.<b>get_report_doc</b>
        <i class="text-muted">(report_name)</i>
    </p>
	<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
	<br>

	

	
        
    
    
	<p class="docs-attr-name">
        <a name="frappe.desk.query_report.get_report_module_dotted_path" href="#frappe.desk.query_report.get_report_module_dotted_path" class="text-muted small">
            <i class="icon-link small" style="color: #ccc;"></i></a>
		frappe.desk.query_report.<b>get_report_module_dotted_path</b>
        <i class="text-muted">(module, report_name)</i>
    </p>
	<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
	<br>

	

	
        
    
    <p><span class="label label-info">Public API</span>
        <br><code>/api/method/frappe.desk.query_report.get_script</code>
    </p>
	<p class="docs-attr-name">
        <a name="frappe.desk.query_report.get_script" href="#frappe.desk.query_report.get_script" class="text-muted small">
            <i class="icon-link small" style="color: #ccc;"></i></a>
		frappe.desk.query_report.<b>get_script</b>
        <i class="text-muted">(report_name)</i>
    </p>
	<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
	<br>

	

	
        
    
    
	<p class="docs-attr-name">
        <a name="frappe.desk.query_report.get_user_match_filters" href="#frappe.desk.query_report.get_user_match_filters" class="text-muted small">
            <i class="icon-link small" style="color: #ccc;"></i></a>
		frappe.desk.query_report.<b>get_user_match_filters</b>
        <i class="text-muted">(doctypes, ref_doctype)</i>
    </p>
	<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
	<br>

	

	
        
    
    
	<p class="docs-attr-name">
        <a name="frappe.desk.query_report.has_match" href="#frappe.desk.query_report.has_match" class="text-muted small">
            <i class="icon-link small" style="color: #ccc;"></i></a>
		frappe.desk.query_report.<b>has_match</b>
        <i class="text-muted">(row, linked_doctypes, doctype_match_filters, ref_doctype, if_owner, columns_dict)</i>
    </p>
	<div class="docs-attr-desc"><p>Returns True if after evaluating permissions for each linked doctype
- There is an owner match for the ref_doctype
- <code>and</code> There is a user permission match for all linked doctypes</p>

<p>Returns True if the row is empty</p>

<p>Note:
Each doctype could have multiple conflicting user permission doctypes.
Hence even if one of the sets allows a match, it is true.
This behavior is equivalent to the trickling of user permissions of linked doctypes to the ref doctype.</p>
</div>
	<br>

	

	
        
    
    <p><span class="label label-info">Public API</span>
        <br><code>/api/method/frappe.desk.query_report.run</code>
    </p>
	<p class="docs-attr-name">
        <a name="frappe.desk.query_report.run" href="#frappe.desk.query_report.run" class="text-muted small">
            <i class="icon-link small" style="color: #ccc;"></i></a>
		frappe.desk.query_report.<b>run</b>
        <i class="text-muted">(report_name, filters=())</i>
    </p>
	<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
	<br>

	



<!-- autodoc -->